@overture-stack/lyric/dist/src/utils/schemas.d.ts

Data Submission system

import type { ParamsDictionary } from 'express-serve-static-core';
import type { ParsedQs } from 'qs';
import { z } from 'zod';
import type { DataRecord } from '@overture-stack/lectern-client';
import { RequestValidation } from './requestValidation.js';
export interface categoryPathParams extends ParamsDictionary {
    categoryId: string;
}
export declare const categoryPathParamsSchema: z.ZodObject<{
    categoryId: z.ZodEffects<z.ZodString, string, string>;
}, "strip", z.ZodTypeAny, {
    categoryId: string;
}, {
    categoryId: string;
}>;
export interface categoryOrganizationPathParams extends ParamsDictionary {
    categoryId: string;
    organization: string;
}
export declare const categoryOrganizationPathParamsSchema: z.ZodObject<{
    categoryId: z.ZodEffects<z.ZodString, string, string>;
    organization: z.ZodString;
}, "strip", z.ZodTypeAny, {
    organization: string;
    categoryId: string;
}, {
    organization: string;
    categoryId: string;
}>;
export interface submissionIdPathParam extends ParamsDictionary {
    submissionId: string;
}
export interface paginationQueryParams extends ParsedQs {
    page?: string;
    pageSize?: string;
}
export interface auditQueryParams extends ParsedQs {
    entityName?: string;
    eventType?: string;
    systemId?: string;
    startDate?: string;
    endDate?: string;
}
export declare const auditByCatAndOrgRequestSchema: RequestValidation<object, paginationQueryParams & auditQueryParams, categoryOrganizationPathParams>;
export declare const cagegoryDetailsRequestSchema: RequestValidation<object, ParsedQs, categoryPathParams>;
export interface dictionaryRegisterBodyParams {
    categoryName: string;
    dictionaryName: string;
    dictionaryVersion: string;
    defaultCentricEntity?: string;
}
export declare const dictionaryRegisterRequestSchema: RequestValidation<dictionaryRegisterBodyParams, ParsedQs, ParamsDictionary>;
export interface submissionsByCategoryQueryParams extends paginationQueryParams {
    onlyActive?: string;
    organization?: string;
    username?: string;
}
export declare const submissionsByCategoryRequestSchema: RequestValidation<object, submissionsByCategoryQueryParams, categoryPathParams>;
export declare const submissionByIdRequestSchema: RequestValidation<object, ParsedQs, submissionIdPathParam>;
export declare const submissionActiveByOrganizationRequestSchema: RequestValidation<object, ParsedQs, categoryOrganizationPathParams>;
export interface submissionCommitPathParams extends ParamsDictionary {
    categoryId: string;
    submissionId: string;
}
export declare const submissionCommitRequestSchema: RequestValidation<object, ParsedQs, submissionCommitPathParams>;
export declare const submissionDeleteRequestSchema: RequestValidation<object, ParsedQs, submissionIdPathParam>;
export interface submissionDeleteEntityNameParams extends ParamsDictionary {
    actionType: string;
    submissionId: string;
}
export interface submissionDeleteEntityNameQueryParams extends ParsedQs {
    entityName: string;
    index?: string;
}
export declare const submissionDeleteEntityNameRequestSchema: RequestValidation<object, submissionDeleteEntityNameQueryParams, submissionDeleteEntityNameParams>;
export interface uploadSubmissionRequestQueryParams extends ParsedQs {
    entityName: string;
    organization: string;
}
export declare const uploadSubmissionRequestSchema: RequestValidation<Array<DataRecord>, uploadSubmissionRequestQueryParams, categoryPathParams>;
export interface dataDeleteBySystemIdPathParams extends ParamsDictionary {
    systemId: string;
    categoryId: string;
}
export declare const dataDeleteBySystemIdRequestSchema: RequestValidation<object, ParsedQs, dataDeleteBySystemIdPathParams>;
export interface dataEditRequestSchemaQueryParams extends ParsedQs {
    entityName: string;
    organization: string;
}
export declare const dataEditRequestSchema: RequestValidation<Array<Record<string, unknown>>, dataEditRequestSchemaQueryParams, categoryPathParams>;
export interface dataQueryParams extends paginationQueryParams {
    entityName?: string | string[];
    view?: string;
}
export interface getDataQueryParams extends ParsedQs {
    view?: string;
}
export declare const dataGetByCategoryRequestSchema: RequestValidation<object, dataQueryParams, categoryPathParams>;
export declare const dataGetByOrganizationRequestSchema: RequestValidation<object, dataQueryParams, categoryOrganizationPathParams>;
export declare const dataGetByQueryRequestSchema: RequestValidation<object, dataQueryParams, categoryOrganizationPathParams>;
export interface dataGetBySystemIdPathParams extends ParamsDictionary {
    systemId: string;
    categoryId: string;
}
export declare const dataGetBySystemIdRequestSchema: RequestValidation<object, getDataQueryParams, dataGetBySystemIdPathParams>;
export declare const downloadDataFileTemplatesSchema: {
    query: z.ZodObject<{
        fileType: z.ZodOptional<z.ZodEnum<["csv", "tsv"]>>;
    }, "strip", z.ZodTypeAny, {
        fileType?: "csv" | "tsv" | undefined;
    }, {
        fileType?: "csv" | "tsv" | undefined;
    }>;
    pathParams: z.ZodObject<{
        categoryId: z.ZodEffects<z.ZodString, string, string>;
    }, "strip", z.ZodTypeAny, {
        categoryId: string;
    }, {
        categoryId: string;
    }>;
};
export declare const validationPathParamsSchema: z.ZodObject<{
    categoryId: z.ZodEffects<z.ZodString, string, string>;
    entityName: z.ZodString;
}, "strip", z.ZodTypeAny, {
    entityName: string;
    categoryId: string;
}, {
    entityName: string;
    categoryId: string;
}>;
export interface validationPathParams extends ParamsDictionary {
    categoryId: string;
    entityName: string;
}
export interface validationQueryParam extends ParsedQs {
    organization: string;
    value: string;
}
export declare const validationRequestSchema: RequestValidation<object, validationQueryParam, validationPathParams>;