mdt-client 31.3.35 → 31.3.37

package/types/_core/scripts/services/api/ApiAccessor/apiV1Types.d.ts

@@ -0,0 +1,266 @@
+import { HierarchicalRecord, MdtRecord, RecordId } from "mdtScripts/common/Record";
+import { AnyObject, ColorStyle, FieldCode, ModuleId, ObjectCode, ObjectId, ObjectTitle } from "mdtScripts/helpers/types";
+import { PermissionLevel } from "mdtScripts/security/PermissionLevel";
+export declare namespace ApiV1 {
+    namespace Request {
+        export type Common = Main | Main[];
+        type Main = Save | Delete | AnyObject;
+        export interface Save extends MdtRecord, WithParams {
+        }
+        export type WithParams = {
+            $params?: CommonParams;
+        };
+        export type CommonParams = AnyObject & BaseParams & DataExtParams & DmParams & SaveParams;
+        interface BaseParams {
+            formId?: RecordId;
+        }
+        interface DataExtParams {
+            ID_Language_ext?: RecordId;
+        }
+        interface DmParams {
+            FlagConfirm?: boolean;
+            Actions?: ApiV1.Response.DmAction[];
+        }
+        interface SaveParams {
+            StatusComment?: string;
+        }
+        export interface Delete extends WithParams {
+            tableName: ObjectCode;
+            IdList: RecordId[];
+            Actions?: Response.DmAction[];
+        }
+        export namespace Fetch {
+            type Params = DataExtParams & MappingParams;
+            interface DataExtParams {
+                ID_Language_ext?: RecordId;
+                dataext?: "explicit";
+            }
+            interface MappingParams {
+                flagGetMappedFKs?: boolean;
+            }
+            /**
+             * В query.select в Api V1 может содержаться как функция аггрегации, так и приведение типа.
+             * Примеры:
+             * - `date(DateCreate) date` - приведение datetime к типу date
+             * - `avg(Amount) amount` - агрегация
+             */
+            type AggragationOrCast = "date" | AggregationType;
+            interface ParsedQuery extends Params {
+                table?: string;
+                select?: string;
+                filter?: string;
+                orderby?: string;
+                skip?: number;
+                top?: number;
+                distinct?: true;
+                aggregate?: true;
+                withCount?: true;
+                params?: any[][];
+                date?: string;
+                hierarchy?: string;
+                placeIn?: string;
+                checkDependency?: string;
+                audit?: string;
+                workflow?: string;
+                workflowStage?: boolean;
+                tag?: string;
+                export?: string;
+                format?: string;
+                groups?: string;
+                skippedRowsCount?: number;
+                /** Нужен для сопоставления ответа в ApiService при сборке нескольких запросов в 1 */
+                key?: string;
+            }
+        }
+        export {};
+    }
+    namespace Response {
+        export type Main = AnyObject | DmMessage | Error;
+        export interface DmMessage {
+            $: "cst";
+            items: DmItem[];
+        }
+        type DmItem = {
+            code?: "actions";
+            rows?: DmAction[];
+        };
+        export interface DmAction extends MdtRecord {
+            FieldCode?: FieldCode;
+            ID_Action?: string;
+            ID_Object?: number;
+            ID_ObjectField?: RecordId;
+            ObjectCode?: string;
+            ObjectTitle?: string;
+            RecordCount?: string;
+            Warning?: string;
+            AvailActions?: string[];
+        }
+        export interface Error {
+            Message: string;
+            Code: string;
+            Args?: any;
+            Debug?: any;
+            Error: boolean;
+        }
+        export interface Save {
+            $: "msg";
+            items: Save.StatItem[];
+            debug?: {
+                objectRuleLogs?: string[];
+            };
+        }
+        export namespace Save {
+            interface StatItem {
+                stats: Stats;
+                ids?: RecordId[];
+                extIds?: StatExtItem[];
+            }
+            interface Stats {
+                inserted: number;
+                updated: number;
+                deleted: number;
+            }
+            interface StatExtItem {
+                ID: RecordId;
+                Table: string;
+            }
+        }
+        /** Fetch */
+        export type Fetch = Fetch.Common<HierarchicalRecord> | Fetch.Common;
+        export namespace Fetch {
+            interface Common<RowsType = Record> {
+                Rows?: RowsType[];
+                Items?: any[];
+                Count?: number;
+                [k: string]: any;
+            }
+            interface Record extends MdtRecord {
+                $tag?: {
+                    ticket: string;
+                    list: RecordId[];
+                };
+                $audit?: {
+                    ticket: string;
+                };
+                /**
+                 * Ограничения на действия (CRUD) над записью и её полями, накладываемые функцией безопасности.
+                 * [Документация](https://ics-it.gram.ax/mdt/security/objectSecurity/sqlFn?l=ru)
+                 */
+                $access?: {
+                    BaseLevel: PermissionLevel;
+                    Level: PermissionLevel;
+                    Fields: {
+                        [fieldId: number]: {
+                            Level: PermissionLevel;
+                        };
+                    };
+                };
+                $workflowStage?: {
+                    Title: string;
+                    Icon: string;
+                    LabelStyleCode: ColorStyle;
+                };
+            }
+        }
+        export namespace File {
+            interface Upload {
+                ID: RecordId;
+                ShortUid: string;
+                UID: string;
+                Name: string;
+                Size?: number;
+                StorageProvider?: StorageProvider;
+            }
+            type StorageProvider = "db";
+        }
+        export namespace Template {
+            interface Preview {
+                Context: AnyObject;
+                Script: string;
+                Header: string;
+                Text: string;
+            }
+        }
+        export namespace User {
+            interface Permissions {
+                object: ObjectPermissions;
+                listview: PermissionLevel;
+                namedfilters: PermissionLevel;
+                tag: PermissionLevel;
+                [code: string]: CommonPermissonData;
+            }
+            type CommonPermissonData = PermissionLevel | ObjectPermissions;
+            type UserPermissionType = keyof Permissions;
+            interface EntityPermission {
+                level: PermissionLevel;
+            }
+            type ObjectPermissions = Record<RecordId, ObjectPermission>;
+            interface ObjectPermission {
+                level: PermissionLevel;
+                fields?: Record<RecordId, EntityPermission>;
+            }
+        }
+        export interface User {
+            id: any;
+            permissions: User.Permissions;
+            login: string;
+            fullName: string;
+            email?: string;
+            identityName: string;
+            isAdmin: boolean;
+            isAnonymous: boolean;
+            roles: string[];
+            languageId: number;
+            languageCode: string;
+            isImpersonated: boolean;
+        }
+        export namespace Schema {
+            interface Object {
+                $id?: ObjectId;
+                accessLevel?: PermissionLevel;
+                code?: ObjectCode;
+                defaultFieldCode?: any;
+                deleted?: boolean;
+                fields?: Field[];
+                id?: ObjectId;
+                id_ObjectType?: string;
+                id_ver_Module?: ModuleId;
+                object_id?: number;
+                tag_Enabled?: boolean;
+                title?: ObjectTitle;
+                "title@"?: ObjectTitle;
+                titlePlural?: string;
+                "titlePlural@"?: string;
+                description?: string;
+                readonly?: boolean;
+                icon?: string;
+                audit_Enabled?: boolean;
+                inline_AddInRow?: boolean;
+                inline_Enabled?: boolean;
+                hierarchyParentField?: string;
+                hierarchyIDField?: string;
+                flagHierarchy?: boolean;
+                flagConfiguration?: boolean;
+                settings?: string;
+            }
+            interface Field {
+                code: string;
+                type: string;
+                dataType: string;
+                $id?: ObjectId;
+                id?: ObjectId;
+                title?: string;
+                "title@"?: string;
+                identity?: boolean;
+                refTableCode?: string;
+                sortOreder?: number;
+                flagScriptDfkInline?: boolean;
+                primary?: boolean;
+                readonly?: boolean;
+            }
+        }
+        export type Schema = Schema.Object | Schema.Object[];
+        export {};
+    }
+    type AggregationType = "sum" | "avg" | "count" | "distinct" | "max" | "min";
+}