About 'flarum/common/extenders'

Burial0268

I am migrating the JavaScript part of my extension to TypeScript, but there is a statement in my plugin that dynamically adds the prototype of post which is like this:
app.store.models.posts.prototype.foo = Model.hasOne('bar');

I see that 'flarum/common/extenders' has been added since Flarum 1.7, can I use this extenders to solve my problem? If so, how do I proceed?

SychO

create a extend.ts inside forum or admin depending on your case.

import Extend from 'flarum/common/extenders';
import Post from 'flarum/common/models/Post';

export default [
  new Extend.Model(Post)
    .hasOne<Bar>('bar')
]

export that from index.ts

export { default as extend } from './extend';

https://docs.flarum.org/extend/models/#extending-models-1

Burial0268

clarkwinkelmann

SychO

Thank you both for your answers, I will modify my original code according to my understanding.
Again, thank you both for your help.

clarkwinkelmann

You can still use the old method if you want. To make the typescript error go away, both during declaration and later during use you can create a definition override for the model, something like here:

https://github.com/clarkwinkelmann/flarum-ext-who-read/blob/master/js/shims.d.ts

import UserState from './src/forum/models/UserState';

declare module 'flarum/common/models/Discussion' {
    export default interface Discussion {
        clarkwinkelmannWhoReaders(): (UserState | undefined)[] | false
    }
}

That example is for a hasMany() relation. For a hasOne the return type would just be relationName(): RelationModel | false

I have other such examples across the Flamarkt extensions, like https://github.com/flamarkt/library/blob/main/js/shims.d.ts

declare module 'flamarkt/core/common/models/Product' {
    export default interface Product {
        thumbnail: () => File | false
    }
}

The shims file can then be registered in tsconfig.json: (https://github.com/clarkwinkelmann/flarum-ext-who-read/blob/master/js/tsconfig.json)

    "files": [
        "shims.d.ts"
    ],

I have been using that method in many extensions. The only downside/issue I found is that I don't know how to import the declaration when another extension extends the first extension. But that's quite a specific use case.