plugins

Documentation

Index

• type AppConfig
  • func NewAppConfig(plugin *Plugin, app AppLike, set map[string]any) *AppConfig
  • func (ac *AppConfig) AddSchemas(schemas ...*schema.Schema)
  • func (ac *AppConfig) OnPostDBCreate(value *qjs.Value) error
  • func (ac *AppConfig) OnPostDBDelete(value *qjs.Value) error
  • func (ac *AppConfig) OnPostDBExec(value *qjs.Value) error
  • func (ac *AppConfig) OnPostDBQuery(value *qjs.Value) error
  • func (ac *AppConfig) OnPostDBUpdate(value *qjs.Value) error
  • func (ac *AppConfig) OnPostResolve(value *qjs.Value) (err error)
  • func (ac *AppConfig) OnPreDBCreate(value *qjs.Value) error
  • func (ac *AppConfig) OnPreDBDelete(value *qjs.Value) error
  • func (ac *AppConfig) OnPreDBExec(value *qjs.Value) error
  • func (ac *AppConfig) OnPreDBQuery(value *qjs.Value) (err error)
  • func (ac *AppConfig) OnPreDBUpdate(value *qjs.Value) error
  • func (ac *AppConfig) OnPreResolve(value *qjs.Value) (err error)
  • func (ac *AppConfig) Set(config map[string]any) error
• type AppLike
• type Builder
  • func (b *Builder) Count(ctx context.Context) (int, error)
  • func (b *Builder) Create(ctx context.Context, value map[string]any) (*entity.Entity, error)
  • func (b *Builder) Delete(ctx context.Context) (int, error)
  • func (b *Builder) First(ctx context.Context) (*entity.Entity, error)
  • func (b *Builder) Get(ctx context.Context) ([]*entity.Entity, error)
  • func (b *Builder) Limit(limit uint) *Builder
  • func (b *Builder) Offset(offset uint) *Builder
  • func (b *Builder) Only(ctx context.Context) (*entity.Entity, error)
  • func (b *Builder) Select(fields []string) *Builder
  • func (b *Builder) Update(ctx context.Context, value map[string]any) ([]*entity.Entity, error)
  • func (b *Builder) Where(predicates ...map[string]any) (*Builder, error)
• type DB
  • func NewDB(db func() db.Client) *DB
  • func (d *DB) Builder(schemaName string) (*Builder, error)
  • func (d *DB) Close() error
  • func (d *DB) Commit() error
  • func (d *DB) Create(ctx context.Context, schemaName string, value map[string]any) (*entity.Entity, error)
  • func (d *DB) Exec(ctx context.Context, query string, args []any) (sql.Result, error)
  • func (d *DB) Query(ctx context.Context, query string, args []any) ([]*entity.Entity, error)
  • func (d *DB) Rollback() error
  • func (d *DB) Tx(ctx context.Context) (*DB, error)
• type Manager
  • func NewManager(app AppLike, dir string, ...) (*Manager, error)
  • func (m *Manager) Config() error
  • func (m *Manager) Get(name string) (*Plugin, bool)
  • func (m *Manager) Init() error
• type Plugin
  • func NewPlugin(app AppLike, pluginDir string, ...) (p *Plugin, err error)
  • func (p *Plugin) Config() (err error)
  • func (p *Plugin) EvalPluginFile(rt *qjs.Runtime, inPool bool) (err error)
  • func (p *Plugin) Init() (err error)
  • func (p *Plugin) InvokeJsFunc(jsFuncName string, args ...any) (*qjs.Value, error)
  • func (p *Plugin) Name() string
  • func (p *Plugin) WithJSFuncName(v *qjs.Value, cb func(jsFuncName string)) error
• type Resource
  • func NewResource(resource *fs.Resource, plugin *Plugin) *Resource
  • func (r *Resource) Add(value *qjs.Value, metas ...*fs.Meta) (*Resource, error)
  • func (r *Resource) Find(id string) *Resource
  • func (r *Resource) Group(name string, metas ...*fs.Meta) *Resource

Types

type AppConfig

type AppConfig struct {
	// contains filtered or unexported fields
}

func NewAppConfig

func NewAppConfig(plugin *Plugin, app AppLike, set map[string]any) *AppConfig

func (*AppConfig) AddSchemas

func (ac *AppConfig) AddSchemas(schemas ...*schema.Schema)

func (*AppConfig) OnPostDBCreate

func (ac *AppConfig) OnPostDBCreate(value *qjs.Value) error

func (*AppConfig) OnPostDBDelete

func (ac *AppConfig) OnPostDBDelete(value *qjs.Value) error

func (*AppConfig) OnPostDBExec

func (ac *AppConfig) OnPostDBExec(value *qjs.Value) error

func (*AppConfig) OnPostDBQuery

func (ac *AppConfig) OnPostDBQuery(value *qjs.Value) error

func (*AppConfig) OnPostDBUpdate

func (ac *AppConfig) OnPostDBUpdate(value *qjs.Value) error

func (*AppConfig) OnPostResolve

func (ac *AppConfig) OnPostResolve(value *qjs.Value) (err error)

func (*AppConfig) OnPreDBCreate

func (ac *AppConfig) OnPreDBCreate(value *qjs.Value) error

func (*AppConfig) OnPreDBDelete

func (ac *AppConfig) OnPreDBDelete(value *qjs.Value) error

func (*AppConfig) OnPreDBExec

func (ac *AppConfig) OnPreDBExec(value *qjs.Value) error

func (*AppConfig) OnPreDBQuery

func (ac *AppConfig) OnPreDBQuery(value *qjs.Value) (err error)

func (*AppConfig) OnPreDBUpdate

func (ac *AppConfig) OnPreDBUpdate(value *qjs.Value) error

func (*AppConfig) OnPreResolve

func (ac *AppConfig) OnPreResolve(value *qjs.Value) (err error)

func (*AppConfig) Set

func (ac *AppConfig) Set(config map[string]any) error

type AppLike

type AppLike interface {
	fs.Hookable
	DB() db.Client
	Resources() *fs.ResourcesManager
	Config() *fs.Config
	Logger() logger.Logger
	Dir() string
}

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func (*Builder) Count

func (b *Builder) Count(ctx context.Context) (int, error)

func (*Builder) Create

func (b *Builder) Create(ctx context.Context, value map[string]any) (*entity.Entity, error)

func (*Builder) Delete

func (b *Builder) Delete(ctx context.Context) (int, error)

func (*Builder) First

func (b *Builder) First(ctx context.Context) (*entity.Entity, error)

func (*Builder) Get

func (b *Builder) Get(ctx context.Context) ([]*entity.Entity, error)

func (*Builder) Limit

func (b *Builder) Limit(limit uint) *Builder

func (*Builder) Offset

func (b *Builder) Offset(offset uint) *Builder

func (*Builder) Only

func (b *Builder) Only(ctx context.Context) (*entity.Entity, error)

func (*Builder) Select

func (b *Builder) Select(fields []string) *Builder

func (*Builder) Update

func (b *Builder) Update(ctx context.Context, value map[string]any) ([]*entity.Entity, error)

func (*Builder) Where

func (b *Builder) Where(predicates ...map[string]any) (*Builder, error)

type DB

type DB struct {
	// contains filtered or unexported fields
}

func NewDB

func NewDB(db func() db.Client) *DB

func (*DB) Builder

func (d *DB) Builder(schemaName string) (*Builder, error)

func (*DB) Close

func (d *DB) Close() error

func (*DB) Commit

func (d *DB) Commit() error

func (*DB) Create

func (d *DB) Create(ctx context.Context, schemaName string, value map[string]any) (*entity.Entity, error)

func (*DB) Exec

func (d *DB) Exec(ctx context.Context, query string, args []any) (sql.Result, error)

func (*DB) Query

func (d *DB) Query(ctx context.Context, query string, args []any) ([]*entity.Entity, error)

func (*DB) Rollback

func (d *DB) Rollback() error

func (*DB) Tx

func (d *DB) Tx(ctx context.Context) (*DB, error)

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func NewManager

func NewManager(
	app AppLike,
	dir string,
	runtimeSetupFunc func(rt *qjs.Runtime, inPool bool) error,
) (*Manager, error)

func (*Manager) Config

func (m *Manager) Config() error

Config allows plugins to update the app configuration before initialization

func (*Manager) Get

func (m *Manager) Get(name string) (*Plugin, bool)

Get returns the plugin by name

func (*Manager) Init

func (m *Manager) Init() error

Init initializes the plugin after the app and Config have been initialized

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func NewPlugin

func NewPlugin(
	app AppLike,
	pluginDir string,
	runtimeSetupFunc func(rt *qjs.Runtime, inPool bool) error,
	qjsWasmBytes []byte,
) (p *Plugin, err error)

NewPlugin creates a new plugin instance

• app: the fastschema app instance
• dir: the relative path to the plugin directory

func (*Plugin) Config

func (p *Plugin) Config() (err error)

func (*Plugin) EvalPluginFile

func (p *Plugin) EvalPluginFile(rt *qjs.Runtime, inPool bool) (err error)

func (*Plugin) Init

func (p *Plugin) Init() (err error)

func (*Plugin) InvokeJsFunc

func (p *Plugin) InvokeJsFunc(jsFuncName string, args ...any) (*qjs.Value, error)

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) WithJSFuncName

func (p *Plugin) WithJSFuncName(v *qjs.Value, cb func(jsFuncName string)) error

type Resource

type Resource struct {
	// contains filtered or unexported fields
}

func NewResource

func NewResource(resource *fs.Resource, plugin *Plugin) *Resource

func (*Resource) Add

func (r *Resource) Add(value *qjs.Value, metas ...*fs.Meta) (*Resource, error)

func (*Resource) Find

func (r *Resource) Find(id string) *Resource

func (*Resource) Group

func (r *Resource) Group(name string, metas ...*fs.Meta) *Resource