Как правильно ограничивать передаваемые аргументы классов в TypeScript?

Question

[OrbiJ]

Подскажите, пожалуйста, как правильно ограничить тип передаваемых аргументов как производных одного абстрактного класса в методы/функции в typescript?

Конкретная суть: есть абстрактный класс Entity (он полностью пустой) и несколько классов, производных от этого абстрактного класса - User, Book, Film и т.д. Каждый из этих классов представляет собой простенькую модель сущности, которая должна приходить со стороны сервера, вот пример:

class Book extends Entity {

    public id!: bigint;
    public name: string = "";
    public author: string = "";
    public release_date: string = "";
    public about: string = "";
    public image: string = "";


    constructor(id : bigint, name : string, author : string, release_date : string, about : string, image : string | null) 
    {
        super()
        this.id = id;
        this.name = name;
        this.author = author;
        this.release_date = release_date;
        this.about = about;
        this.image = image == null ? Configuration.BOOK_DEFAULT_IMAGE : Configuration.API_BASE_URL + image;
    }


}

export default Book;

Далее я выполняю запрос к апи (например, через axios) и получаю в ответ response с датой, где, по сути, должны быть поля, идентичные наименованиям свойств класса. Для этого я хочу в классе взаимодействия с API завести метод, который будет принимать только потомков абстрактного класса Entity и просматривать перечень их свойств и проверять, чтобы в свойстве data объекта response они не были undefined, но у каждого потомка, понятное дело, свойства свои и мне нужно как-то их просмотреть. И вот на этой стадии я вообще выпал, покопался в этих дженериках для функций (какой-то огрызок templat'ов c++), пробовал просто ограничить тип следующим образом:

public validateRequest (validationModel : Entity) : boolean {
        return true;
    }

И оно, понятное дело, работает, но не совсем так, как мне нужно, ибо требует передачи именно объекта (а мне до момента его создания нужно проверить соответствие свойств), при этом почему-то передача aliasa любых классов вообще не вызывает ошибку, но работает вообще чёрт пойми как, передавая просто сигнатуру класса в виде строки. Смотрел в сторону рефлексии и хотел передавать ссылку на конструктор класса моделей и там проверять, но вообще не понял как это делать, ни в документации, ни на просторах интернета я этой информации не нашёл, не может же такого быть, что её нет в TS? Подскажите, пожалуйста, я вообще правильно думаю или есть какое-то очевидное решение значительно проще?

С дженериками тоже что-то пытался покрутить, но я вообще не выкупил их пригодность для этой задачи, ибо класс в TS вроде как и есть одновременно с этим type, но они вообще разрешали мне пропускать любую информацию в метод, хотя, может, это я просто не понял их...

Comments

[WbICHA]

Откровенно говоря, непонятна задача. Если тебе нужно принимать всех детей базового класса, то откуда ты можешь знать какие свойства тебе надо проверять, помимо базовых?
Короче, напиши короче и яснее. Сейчас твой текст полон воды.

[OrbiJ]

WbICHA, так я и не знаю :/ Мне для этого и нужна рефлексия или параметры конструктора, я же чётко написал, что мне нужно ограничить входящие классы потомками родительского, а параметры проверять на основе, например, параметров конструктора дочерних классов.

[OrbiJ]

WbICHA, суть проста => метод принимается в себя что-то связанное с классом (алиас, сигнатуру класса, сигнатуру конструктора и т.д.), после чего и определяет, какие параметры нужно сверять. При этом доп. ограничением должно быть то, что все принимаемые классы должны являться потомками Entity. Не вижу воды в тексте, так как я конкретно сказал, что нужно сделать или куда меня ткнуть носом в доку/stackoverflow, если я неправильно понял суть тех же дженериков.

Answer 1

[Aetae]

1. TypeScript работает на этапе компиляции. В рантайме нет никакого тайпскрипта, соответственно и не может быть никаких проверок с ним связанных.
// Есть библиотеки для подобного, но они сильно жирные и слегка "хакнутые", в простых случаях лучше уж руками

2. TypeScript имеет структурную типизацию. Что значит, что учитвает он только структуру. Тип получаемый из пустого абстрактного класса будет принимать в себя абсолютно любой объект. Тип из класса с одним полем "id" примет в себя любой инстанс любого класса с полем "id".

class A { id!: string }
class B { id!: string }
class C { 
 id!: string; 
 value!: number; 
}

const foo: A = new B(); // ok
const bar: A = new C(); // still ok

3. Неизвестный тип в TypeScript обозначается unknown. Функции проверки что неизвестный тип является конкретным называются тайпгарды:

function isString(arg: unknown): arg is string {
  return typeof arg === 'syting'
}

Применяя тайпгарды вы полностью берёте на себя ответственность, что поверки истинны.

Comments

[OrbiJ]

Окей, понял, благодарю за ответ, видимо, я не совсем правильно понял идею структурной типизации, мне казалось что в вопросах ограничения по родительским классам она работает так же как номинативная.

Правда это всё ещё не отменяет моего вопроса: у меня есть метод класса, который должен сопоставлять параметры одного объекта и список параметров конструктора другого объекта и выполнять какое-то действие, если они идентичны. Я хочу, чтобы в каждом отдельном методе, который отвечает за запрос к API я мог указать нужный мне конструктор класса, с которым и будет происходить сопоставления, что корректно передавать непосредственно в метод проверки, вот этого я просто понять не могу?

Допустим я в самом методе, который принимает unknown, будут проверять, что пришедшее в метод нечто является объектом и в его прототипе находится Entity, а в иных случаях буду обрабатывать ошибку, но мне всё ещё не ясно, как определить непосредственно список параметров конструктора, с которым и нужно сравнивать ответ пришедший со стороны сервера.

[Aetae]

OrbiJ, this. :)

public validateRequest (validationModel: this) : boolean {
        return true;
    }

Если я правильно понял конечно.

Но вообще наверное тебе нужен просто обычный отдельный интерфейс.

Или ты хочешь что-то такое?:

// extract public properties withou methods
type Data<T> = {
  [K in keyof T as T[K] extends Function ? never : K]: T[K]  
}

class Entity {
  public validateRequest (validationModel : Data<this>) : boolean {
    return true;
  }
}

class Book extends Entity {
  public id!: bigint;
  public name: string = "";
}

const book = new Book();

book.validateRequest({id: 1n, name: ''}) // ok
book.validateRequest({id: 1n}) // err

Хз, в общем если не угадал - напиши полноценный псевдокод отражающий идею, который должен предположительно работать и там подумаем.:)

[Aetae]

Допустим я в самом методе, который принимает unknown, будут проверять, что пришедшее в метод нечто является объектом и в его прототипе находится Entity, а в иных случаях буду обрабатывать ошибку, но мне всё ещё не ясно, как определить непосредственно список параметров конструктора, с которым и нужно сравнивать ответ пришедший со стороны сервера.

Руками. Если сравнение идёт в рантайме - у тебя есть только javascript. В javascript нет механизма получения полей класса (до его создания само собой).
Если очень не хочется руками - смотри на библиотеку указанную в ответе(или любую иную подобную), она сгенерирует нужный код на этапе компиляции.

[OrbiJ]

Aetae, если честно, не понял :D Но это я дурачок, не обращайте внимания, попробую расписать полную структуру сейчас:

Есть абстрактный класс

abstract class Api {
    public validateRequest (validationModel : this, response : AxiosResponse) : boolean {
        /* ВОТ ЗДЕСЬ СВЕРЯЮТСЯ ПАРАМЕТРЫ КОНСТРУКТОРА validationModel и response.data*/
        return true;
    }

Далее есть класс:

import User from "./EntityClasses/AllEntities/User";
class UserApi extends Api {

    public async getAuthUser() : Promise<User | null> {
        let response = await this.sendRequest('get', 'currentUser');
        this.validateRequest(User, response);
        
        /* Пока просто делаю return null*/
        return null;
    }

И по сути я вижу ошибку: Argument of type 'typeof User' is not assignable to parameter of type 'this'. 'this' could be instantiated with an arbitrary type which could be unrelated to 'typeof User'.

Сам код-то работает, и если я попробую вывести тип validationModel, то получаю значение function, что, как я понимаю, и является непосредственно ссылкой на конструктор класса, но как мне получить доступ к его аргументам?

[Aetae]

OrbiJ, выше ответил, пока ты писал.

С точки зрения типизации, а не проверки в рантайм, это может выглядеть так:

type Constructor<T = object, Arg = any> = new (...args: Arg[]) => T;

abstract class Api {
    public validateRequest<T>(validationModel: Constructor<T>, response : T) : boolean {
        // ts не даст сюда попасть если response УЖЕ не соответствует validationModel :)
        return true;
    }
}

Но это абсолютно бессмысленно, потому что типизация тут проверяет что response имеет тип validationModel на входе, чего ты конечно никак не можешь знать.:)

Разве что из этого метода ты можешь сделать тайп-гард:

type Constructor<T = object, Arg = any> = new (...args: Arg[]) => T;

abstract class Api {
    public validateRequest<T>(validationModel: Constructor<T>, response: unknown): response is T {
        // тут всё сверяем руками или через typia
        return true;
    }
}

Но в любом случае все проверки ручкаими.

[OrbiJ]

Aetae, стоп, а зачем мне вообще трогать response с точки зрения какой-либо дополнительной логики? Ведь response является объектом AxiosResponse, и я точно знаю, что параметры, которые мне нужно проверять, находятся внутри data.

В моём понимании логика была следующая:
1) Вызывается axios-запрос к серверу, который как-то обрабатывается интерцепторами и по итогу я всегда получаю в результате свой объект AxiosResponse.
2)Я получил объект AxiosResponse, который всегда содержит свойство data, которое представляет собой некий объект со своими свойствами.
3)Я вызываю функцию/метод, в который передаю непосредственно объект AxiosResponse и ссылку на конструктор класса, допустим, User.
4)В этом самом методе проверки я извлекаю аргументы, получаемые конструктором и пробую вызвать response.data.constructor_param, чтобы получить значение св-ва, если же я где-то встречаю ,undefined, то проверка не пройдена.

Вот у меня такая логика была изначально.

[Aetae]

OrbiJ, проблемы с 4 пунктом.
a) У AxiosResponse поле data имеет неизвестный тип. По умолчанию и для удобства - any, но на самом деле хрен знает, что там с сервера пришло. Нет там никакого constrictor точно, потому, что если и придёт там объект - это будет простой примитивный объект.
б) Как я сказал выше:

В javascript нет механизма получения полей класса

Тебе просто не с чем сравнивать.

Ты можешь только руками создать тупо массивчик с именами полей и по ним пройтись. Или можешь использовать библиотеку, чтоб она, условно, сделала этот массивчик за тебя неявно на этапе компиляции(с сопутствующими накладными расходами, само собой).

[OrbiJ]

Aetae, а разве мне вообще нужно сравнивать? Допустим я проверил, что в поле data записан объект, вообще без разницы какой, если я обращусь к полю response.data.chtoygodno и этого св-ва нет, то я получу undefined, мне ведь главное достать из сигнатуры конструктора класса поля, в которые мне и нужно тыкнуться у response.data. Вообще хоть какой-то способ получить аргументы конструктора класса User есть? Ведь если я их получу, то всё остальное уже решается почти сразу же.

[OrbiJ]

Aetae, т.е. ещё раз, класс User имеет след. конструктор:

constructor(name : string);

Я хочу получить вот это самое наименование аргумента ('name' и его тип : string), хотя мне тип, на самом деле, для первичной проверки не так важен. Допустим я получил name, далее я обращаюсь к response.data.name и смотрю на результат, допустим, это не undefined, тогда я беру и смотрю на тип этого свойства и на тип аргумента конструктора с таким наименованием, если они равны, то проверка св-ва пройдена.

Ну, в моём понимании это вообще основа, которая должна быть в любом языке, как этого в принципе в ЯП под веб может не быть?

[Aetae]

OrbiJ,

Вообще хоть какой-то способ получить аргументы конструктора класса User есть?

В рантайме - нет.

Аргументы конструктора с точки зрения js - это просто аргументы метода с имением constructor. Метод с точки зрения js - это просто функция. Имена аргументов функции ни на что снаружи не влияют, и просто являются по сути мапингом по порядку в переменные внутри функции. Имена аргументов функции никак не доступны - точно также, как недоступны поля класса. Единственное что доступно - поле length функции содержащее количество аргументов(но и оно не учитывает, не может учитывать, ...spread параметры или использование arguments).

// На самом деле есть один единственный вариант получить имена аргументов в рантайме: сделать Ctor.toString() и спарсить их из полученной текстовой репрезентации. Только вид этой текстовой репрезентации ничем не гарантирован(хоть и на данный момент вроде идентичен средь браузеров) и применять такое в проде нельзя.:)

На этапе компиляции стандартными средствами - нет.

На этапе компиляции вмешиваясь в сам процесс компиляции, выполняя дополнительные преобразования? Сколько угодно, каким угодно способом. Просто надо глубоко разобраться в работе собственно компилятора. :)
Ну или использовать готовую либу с близким функционалом.

[OrbiJ]

Aetae, мда, конечно, это вообще какой-то супер странный подход, не зря из года в год слышу про то, что JS это чуть ли не раковая опухоль индустрии.

А как вообще тогда правильно писать унифицированные валидаторы или разделять логику? Как мне в принципе хоть как-то унифицировать проверки для моделей, если у меня их, к примеру, 50 штук? И как опытные разрабы TS/JS борются с этой задачей?

[Aetae]

OrbiJ, ещё в ответе я указал на библиотеку которая генерирует рантайм проверки на основе типов, для тех кому это важно. И таких там не одна. Есть и для классов, и для баз данных и всего такого. Но в целом они не особо популярны.

А так - 99% фронта тупо верит серверу, что он пришлёт то, что заявил, без заморочек:).
Когда же ты уже получил класс из неведомой хрени, то можешь спокойно проверять instanceof и т.п.

[OrbiJ]

Aetae, понял, премного благодарен за уделённое время, а то идея о том, что ведь не может всё быть так просто мне покоя никак не давала и я 2 дня потратил на поиски того, как это всё должно работать и как писать наиболее правильный и поддерживаемый код. Ещё раз спасибо за ваши ответы! :)

[WbICHA]

OrbiJ, добавлю свои 5 копеек. Если я правильно понял, ты хочешь провалидировать ответ сервера, но тут проблема в том, что ты применяешь опыт строго типизированного ООП языка к мультипарадигменному языку с динамической типизацией и слабо реализованными классами.
То, что ты хочешь, делается любым схема валидатором (к примеру: https://www.npmjs.com/package/zod ). Из него уже достаётся непосредственно тип. И классы тут вот вообще ненужны. Они могут быть обёрткой для всего этого, но не более. Тем более не определять тип. Потому что данные — это объекты.