@axdspub/axiom-charts 0.0.3

package/.yalc/@axdspub/axiom-ui-data-services/library/axiom-ui-data-services.d.ts

@@ -0,0 +1,313 @@
+interface IRequestItemProps {
+    id: string;
+    label?: string;
+    metadataService?: IDataService;
+    getMetadataService?: () => IDataServiceImplementation;
+    dataService?: IDataService;
+    getDataService?: () => IDataServiceImplementation;
+    component?: string;
+    onError?: (error: Error) => void;
+    properties?: {
+        [index: string]: string | number | undefined;
+        layerGroupUuid?: string;
+    };
+    styles?: {
+        [index: string]: string | undefined;
+        color?: string;
+    };
+}
+type IDataParserArgs = Record<string, string | string[] | undefined>;
+interface IDataParser {
+    type: string;
+    args: IDataParserArgs;
+}
+type ISpreadsheetCell = string | number | Date | undefined | null;
+type ISpreadSheet = Array<Record<string, ISpreadsheetCell>>;
+interface IDataServiceSpreadsheetArgs {
+    processCell: (val: ISpreadsheetCell, key: string) => ISpreadsheetCell;
+}
+type IDataResultType = 'json' | 'csv' | 'tsv' | 'blob' | undefined;
+type IDataServiceMethod = 'GET' | 'POST';
+interface IDataServiceHelper {
+    headers?: HeadersInit;
+    method?: IDataServiceMethod;
+    resultType?: IDataResultType;
+}
+interface ILayer {
+    [index: string]: string | number | string[] | Record<string, object | string | number> | undefined;
+    label?: string;
+    description?: string;
+}
+interface IVectorLayer extends ILayer {
+    layerName: string;
+    propertyName?: string;
+    geomName?: string;
+}
+declare enum EGraphQAgg {
+    AVERAGE = "average",
+    MIN = "min",
+    MAX = "max",
+    SUM = "sum",
+    DISTINCT_COUNT = "distinctCount"
+}
+interface IGraphQL extends ILayer {
+    queryFn: string;
+    nodes?: string[];
+    aggregatesFromRange?: {
+        aggregates?: string[];
+        columnPrefix: string;
+        min: number;
+        max: number;
+    };
+    aggregates?: {
+        [key in EGraphQAgg]?: string[];
+    };
+    groupedAggregateNode?: string;
+    groupedAggregates?: {
+        [key in EGraphQAgg]?: string[];
+    };
+    srid: string;
+}
+interface IGraphQLVariableResult {
+    nodes?: Record<string, number>;
+    aggregates?: {
+        [key in EGraphQAgg]?: Record<string, number | null>;
+    };
+}
+interface IGraphQLResult {
+    data: Record<string, IGraphQLVariableResult>;
+}
+interface IPostgrestAreaResultRow {
+    [index: string]: string | number | undefined | Record<string, any>;
+    grouping_stats?: Record<string, any>;
+    buffered_aoi_area_sqkm: number | undefined;
+    merged_result_geom_area_sqkm?: number;
+    feature_count?: number;
+    dataset?: string[];
+}
+type IPostgrestAreaResult = IPostgrestAreaResultRow[];
+type ISearchParams = Record<string, string | object | ISearchParams[]>;
+interface IDataServiceArgs {
+    [index: string]: any;
+    searchParams?: ISearchParams;
+    spreadsheet?: IDataServiceSpreadsheetArgs;
+    vectorLayer?: IVectorLayer;
+    graphql?: IGraphQL;
+}
+type IDataServiceUrl = string | ((filters?: IDataFilters) => string) | undefined;
+interface IDataService extends IDataServiceHelper {
+    type: string;
+    url: IDataServiceUrl;
+    args?: IDataServiceArgs;
+    filters?: {
+        [index: string]: any;
+        geojson?: GeoJSON.FeatureCollection;
+    };
+    postBody?: BodyInit;
+    abortController?: AbortController;
+    parser?: IDataParser;
+    result?: IDataResult;
+}
+interface IDataServiceProps extends IDataService {
+    onError?: (error: Error) => void;
+}
+interface IDataParserProps extends IDataParser {
+    onError?: (error: any) => void;
+}
+interface IDataParserImplementation extends IDataParserProps {
+}
+interface IDataFilterMinMax {
+    min: number;
+    max: number;
+}
+interface IDataFilterMinMaxTime {
+    min: Date;
+    max: Date;
+}
+interface IDataFilters {
+    time?: IDataFilterMinMaxTime;
+    [index: string]: string | number | number[] | IDataFilterMinMaxTime | IDataFilterMinMaxTime | undefined;
+}
+type INumericData = number | Date;
+type IDataRow = Record<string, any>;
+type INumericDataAccessor = (row: IDataRow) => INumericData;
+type INumericDomainDataAccessor = (row: IDataRow) => INumericData[];
+type IStatsDataAccessor = (row: IDataRow) => Record<string, INumericData>;
+interface IDataParserResult {
+    args: IDataParserArgs;
+    data: IDataRow[];
+    accessors: Record<string, INumericDataAccessor>;
+    domainAccessors?: Record<string, INumericDomainDataAccessor>;
+    properties?: Record<string, any>;
+}
+interface IDataResult {
+    data: any;
+    parsed?: IDataParserResult;
+}
+interface IParserGroupAndSumRow {
+    label: string;
+    index: number;
+    sum: number;
+    percent?: number;
+}
+interface IParserMonthlyAveragesRow {
+    label: string;
+    index: number;
+    average?: number;
+    min?: number;
+    max?: number;
+    median?: number;
+}
+interface IParserMonthlyStatsResult extends IDataParserResult {
+    data: IParserMonthlyAveragesRow[];
+    properties: {
+        count: number;
+        average?: number;
+    };
+}
+interface IParserGroupedArgs extends IDataParserArgs {
+    groupingProp: string | string[];
+    summingProp: string;
+}
+interface IParserGroupedArgs extends IDataParserArgs {
+    groupingProp: string | string[];
+    summingProp: string;
+}
+interface IParserGroupedArgs extends IDataParserArgs {
+    groupingProp: string | string[];
+    summingProp: string;
+}
+interface IParserTimeSeriesArgs extends IDataParserArgs {
+    valueProp: string;
+    timeProp: string;
+}
+interface IParserTimeSeriesArgs extends IDataParserArgs {
+    valueProp: string;
+    timeProp: string;
+}
+interface IParserMonthlyStatsArgs extends IDataParserArgs {
+    valueProp: string;
+    timeProp: string;
+}
+interface IParserMonthlyStatsArgs extends IDataParserArgs {
+    valueProp: string;
+    timeProp: string;
+}
+interface IParserGroupAndSumResult extends IDataParserResult {
+    data: IParserGroupAndSumRow[];
+    properties: {
+        total?: number;
+        average?: number;
+        count?: number;
+    };
+}
+interface IParserGroupAndSumResult extends IDataParserResult {
+    data: IParserGroupAndSumRow[];
+    properties: {
+        total?: number;
+        average?: number;
+        count?: number;
+    };
+}
+interface IMetadataResult {
+    label?: string;
+    description?: string;
+    [index: string]: string | object | undefined;
+}
+interface IDataServiceImplementation extends IDataServiceProps {
+    props: IDataServiceProps;
+    get: (filters?: IDataFilters) => Promise<IDataResult>;
+    update: (filters: IDataFilters) => Promise<IDataResult>;
+    parse: (data: any) => Promise<any>;
+    destroy: () => void;
+    makeUrl: (filters?: IDataFilters) => string;
+    onError: (error: any) => void;
+    setOnErrorFn: (onErrorFn: (error: any) => void) => void;
+}
+interface IRequestState {
+    loading: boolean;
+    loaded: boolean;
+    canceled: boolean;
+}
+type IRequestItemMetadata = Record<string, any>;
+interface IRequestItemData {
+    data: IDataResult;
+    metadata?: IMetadataResult;
+}
+interface IRequestItemImplementation extends IRequestItemProps, IRequestState {
+    getMetadata: () => Promise<IDataResult | undefined>;
+    getData: () => Promise<IDataResult>;
+    load: () => Promise<IRequestItemData>;
+    destroy: () => void;
+    setOnErrorFn: (onErrorFn: (error: any) => void) => void;
+}
+//# sourceMappingURL=Types.d.ts.map
+
+declare const out: Record<string, (props: IDataService) => ISearchParams>;
+
+declare class DataService implements IDataServiceImplementation {
+    props: IDataServiceProps;
+    type: string;
+    url: IDataServiceUrl;
+    args?: IDataServiceArgs;
+    headers?: HeadersInit;
+    resultType?: 'json' | 'csv' | 'tsv' | 'blob' | undefined;
+    method?: 'GET' | 'POST';
+    postBody?: BodyInit;
+    abortController?: AbortController | undefined;
+    parser?: IDataParser;
+    runtime: Record<string, any>;
+    filters?: IDataFilters;
+    result?: IDataResult;
+    onErrorFn?: (error: any) => void;
+    constructor(props: IDataServiceProps);
+    protected makeSearchParams(): ISearchParams;
+    makeUrl(filters?: IDataFilters): string;
+    setOnErrorFn(onErrorFn: ((error: any) => void)): void;
+    onError(error: Error): void;
+    protected handleError(e: Error): void;
+    protected processDSV(result: Response, seperator?: string): Promise<ISpreadSheet>;
+    protected processJson(result: Response): Promise<any>;
+    protected processCSV(result: Response): Promise<ISpreadSheet>;
+    protected processTSV(result: Response): Promise<ISpreadSheet>;
+    protected processBlob(result: Response): Promise<Blob>;
+    destroy(): void;
+    parse(data: any): Promise<any>;
+    update(filters: IDataFilters): Promise<any>;
+    get(filters?: IDataFilters): Promise<IDataResult>;
+}
+//# sourceMappingURL=DataService.d.ts.map
+
+declare class RequestItem implements IRequestItemImplementation {
+    id: string;
+    loading: boolean;
+    loaded: boolean;
+    canceled: boolean;
+    dataService?: IDataService;
+    getDataService?: () => IDataServiceImplementation;
+    metadataService?: IDataService;
+    getMetadataService?: () => IDataServiceImplementation;
+    runtime: {
+        data?: any;
+        metadata?: any;
+        metadataServiceInstance?: IDataServiceImplementation;
+        dataServiceInstance?: IDataServiceImplementation;
+    };
+    onErrorFn?: (error: any) => void;
+    constructor(props: IRequestItemProps);
+    load(): Promise<IRequestItemData>;
+    getData(): Promise<IDataResult>;
+    setOnErrorFn(onErrorFn: ((error: any) => void)): void;
+    protected createDataService(dataService?: IDataService, dataServiceFn?: (() => IDataServiceImplementation)): IDataServiceImplementation | undefined;
+    getMetadata(): Promise<IDataResult | undefined>;
+    destroy(): void;
+}
+//# sourceMappingURL=RequestItem.d.ts.map
+
+declare const methods: {
+    get: (key: string) => IDataServiceHelper | undefined;
+    getAll: () => Record<string, IDataServiceHelper | undefined>;
+};
+//# sourceMappingURL=dataServiceHelpers.d.ts.map
+
+export { DataService, EGraphQAgg, IDataFilterMinMax, IDataFilterMinMaxTime, IDataFilters, IDataParser, IDataParserArgs, IDataParserImplementation, IDataParserProps, IDataParserResult, IDataResult, IDataResultType, IDataRow, IDataService, IDataServiceArgs, IDataServiceHelper, IDataServiceImplementation, IDataServiceMethod, IDataServiceProps, IDataServiceUrl, IGraphQL, IGraphQLResult, IGraphQLVariableResult, ILayer, INumericData, INumericDataAccessor, INumericDomainDataAccessor, IParserGroupAndSumResult, IParserGroupAndSumRow, IParserGroupedArgs, IParserMonthlyAveragesRow, IParserMonthlyStatsArgs, IParserMonthlyStatsResult, IParserTimeSeriesArgs, IPostgrestAreaResult, IPostgrestAreaResultRow, IRequestItemData, IRequestItemImplementation, IRequestItemMetadata, IRequestItemProps, IRequestState, ISearchParams, ISpreadSheet, ISpreadsheetCell, IStatsDataAccessor, IVectorLayer, RequestItem, methods as dataServiceHelpers, out as endpoints };