@baeta/generator-sdk

Enumerations

GeneratorPluginVersion

Enumeration Members

Enumeration Member	Value
V1	"v1"

Classes

File

Extended by

• FileBlock

Constructors

new File()

new File(filename, content, tag, options?): File

Parameters

Parameter	Type
filename	string
content	string
tag	string
options?	FileOptions

Returns

File

Properties

Property	Modifier	Type	Default value
content	public	string	undefined
filename	public	string	undefined
persisted	public	boolean	false
tag	public	string	undefined

Methods

buildContent()

protected buildContent(): Promise<string>

Returns

Promise<string>

buildHeader()

protected buildHeader(): string

Returns

string

createComment()

protected createComment(comment): string

Parameters

Parameter	Type
comment	string

Returns

string

unlink()

unlink(): Promise<void>

Returns

Promise<void>

write()

write(): Promise<void>

Returns

Promise<void>

---

FileBlock

Extends

• File

Constructors

new FileBlock()

new FileBlock(filename, content, start, end, tag, options?): FileBlock

Parameters

Parameter	Type
filename	string
content	string
start	string
end	string
tag	string
options?	FileOptions

Returns

FileBlock

Overrides

File.constructor

Properties

Property	Modifier	Type	Default value	Inherited from
content	public	string	undefined	File.content
end	public	string	undefined	‐
filename	public	string	undefined	File.filename
persisted	public	boolean	false	File.persisted
start	public	string	undefined	‐
tag	public	string	undefined	File.tag

Methods

addBlockToContent()

protected addBlockToContent(existingContent): string

Parameters

Parameter	Type
existingContent	string

Returns

string

buildContent()

protected buildContent(): Promise<string>

Returns

Promise<string>

Inherited from

File.buildContent

buildHeader()

protected buildHeader(): string

Returns

string

Inherited from

File.buildHeader

buildPadding()

protected buildPadding(existingContent): "" | "\n" | "\n\n"

Parameters

Parameter	Type
existingContent	string

Returns

"" | "\n" | "\n\n"

createComment()

protected createComment(comment): string

Parameters

Parameter	Type
comment	string

Returns

string

Inherited from

File.createComment

getExistingContent()

protected getExistingContent(): Promise<readonly [string, FileHandle] | readonly ["", null]>

Returns

Promise<readonly [string, FileHandle] | readonly ["", null]>

getSlices()

protected getSlices(existingContent): readonly [string, "", false] | readonly [string, string, true]

Parameters

Parameter	Type
existingContent	string

Returns

readonly [string, "", false] | readonly [string, string, true]

unlink()

unlink(): Promise<void>

Returns

Promise<void>

Overrides

File.unlink

write()

write(): Promise<void>

Returns

Promise<void>

Overrides

File.write

---

FileManager

Constructors

new FileManager()

new FileManager(fileOptions?): FileManager

Parameters

Parameter	Type
fileOptions?	FileOptions

Returns

FileManager

Properties

Property	Modifier	Type	Default value
files	public	File[]	[]
fileOptions?	public	FileOptions	undefined

Methods

add()

add(...file): void

Parameters

Parameter	Type
...file	File[]

Returns

void

createAndAdd()

createAndAdd(filename, content, tag): File

Parameters

Parameter	Type
filename	string
content	string
tag	string

Returns

File

get()

get(filename): undefined | File

Parameters

Parameter	Type
filename	string

Returns

undefined | File

getAll()

getAll(): File[]

Returns

File[]

getByTag()

getByTag(tag): File[]

Parameters

Parameter	Type
tag	string

Returns

File[]

getPersistedFiles()

getPersistedFiles(): File[]

Returns

File[]

remove()

remove(filename): void

Parameters

Parameter	Type
filename	string

Returns

void

removeAll()

removeAll(): void

Returns

void

removeByTag()

removeByTag(tag): void

Parameters

Parameter	Type
tag	string

Returns

void

unlinkAll()

unlinkAll(): Promise<void>

Returns

Promise<void>

writeAll()

writeAll(): Promise<void[]>

Returns

Promise<void[]>

writeByTag()

writeByTag(tag): Promise<void[]>

Parameters

Parameter	Type
tag	string

Returns

Promise<void[]>

---

Watcher

Constructors

new Watcher()

new Watcher(cwd, options?): Watcher

Parameters

Parameter	Type
cwd	string
options?	Options

Returns

Watcher

Methods

close()

close(): Promise<void>

Returns

Promise<void>

createSubscription()

createSubscription(): object

Returns

object

Name	Type
unsubscribe	() => Promise<void>

ignore()

ignore(pattern): void

Parameters

Parameter	Type
pattern	MatchPattern

Returns

void

off()

off(event, listener): void

Parameters

Parameter	Type
event	EventType
listener	WatcherListener

Returns

void

on()

on(event, listener): void

Parameters

Parameter	Type
event	EventType
listener	WatcherListener

Returns

void

onEvents()

onEvents(err, events): void

Parameters

Parameter	Type
err	null | Error
events	Event[]

Returns

void

unignore()

unignore(pattern): void

Parameters

Parameter	Type
pattern	MatchPattern

Returns

void

---

WatcherIgnore

Constructors

new WatcherIgnore()

new WatcherIgnore(cwd): WatcherIgnore

Parameters

Parameter	Type
cwd	string

Returns

WatcherIgnore

Methods

ignore()

ignore(pattern): void

Parameters

Parameter	Type
pattern	MatchPattern

Returns

void

isIgnored()

isIgnored(path): boolean

Parameters

Parameter	Type
path	string

Returns

boolean

isMicromatch()

isMicromatch(pattern): boolean

Parameters

Parameter	Type
pattern	string

Returns

boolean

resolveFile()

resolveFile(file): string

Parameters

Parameter	Type
file	string

Returns

string

unignore()

unignore(pattern): void

Parameters

Parameter	Type
pattern	MatchPattern

Returns

void

Interfaces

FileOptions

Options for generated files.

Properties

Property	Type	Default value	Description
addEslintDisableHeader?	boolean	true;	Add eslint-disable comment at the beginning of the file.
addGenerationNoticeHeader?	boolean	true;	Add generation notice at the beginning of the file.
addHeader?	(name: string, content: string, tag: string) => string	undefined	Add custom header at the beginning of the file.
transformContent?	(name: string, content: string, tag: string) => string | Promise<string>	undefined	Edit the content of the file before writing it.

---

GeneratorOptions

Options for the Baeta Generator.

Properties

Property	Type	Default value	Description
schemas	string[]	["src/∗∗/∗.gql", "src/∗∗/∗.graphql"];	Glob pattern(s) to locate GraphQL schema files.
baseTypesPath?	string	`${modulesDir}/../__generated__/types.ts`;	Output path for the generated base types file.
contextType?	string	undefined;	Path to the context type definition. Supports both named and default exports. Examples contextType: "src/types/context.ts#Context"; // for named export contextType: "src/types/context.ts"; // for default export
cwd?	string	process.cwd();	Current working directory for resolving relative paths.
extensions?	string	undefined;	Path to Baeta Extensions (ex. auth-extension). Only default export is supported. Example extensions: "src/extensions.ts";
fileOptions?	FileOptions	undefined	Configuration options for generated files.
importExtension?	false | ".js" | ".ts"	".ts";	File extension to use in generated import statements. Set to false to omit extensions.
loaders?	Loader<any>[]	undefined	Custom schema loaders for processing schema files.
moduleDefinitionName?	string	"typedef.ts";	Filename for the generated module definition file. Contains type definitions and the GraphQL AST.
modulesDir?	string	"src/modules";	Root directory where GraphQL modules are defined.
scalars?	Record<string, string>	undefined;	Custom scalar type mappings. Maps GraphQL scalar types to TypeScript types. Supports global types and imports. Example { DateTime: 'Date', JSON: 'Record<string, unknown>' } *

---

GeneratorPluginV1<Store>

Type Parameters

Type Parameter	Default type
Store	unknown

Properties

Property	Type
actionName	string
end	GeneratorPluginV1Fn<Store>
generate	GeneratorPluginV1Fn<Store>
name	string
setup	GeneratorPluginV1Fn<Store>
type	Generator
version	V1
watch	GeneratorPluginV1WatchOptions

---

Loader<TOptions>

Interface for custom schema loaders.

Type Parameters

Type Parameter	Default type
TOptions	any

Methods

load()

load(pointer, options?): Promise<null | any[]>

Parameters

Parameter	Type
pointer	string
options?	TOptions

Returns

Promise<null | any[]>

loadSync()?

optional loadSync(pointer, options?): null | any[]

Parameters

Parameter	Type
pointer	string
options?	TOptions

Returns

null | any[]

---

NormalizedGeneratorOptions

Properties

Property	Type
baseTypesPath	string
cwd	string
moduleDefinitionName	string
modulesDir	string
schemas	string[]
contextType?	string
extensions?	string
fileOptions?	FileOptions
importExtension?	".js" | ".ts"
loaders?	Loader<any>[]
scalars?	Record<string, string>

---

WatcherFile

Properties

Property	Type
path	string
relativePath	string
type	EventType

Type Aliases

Ctx<T>

Ctx<T>: object & T

Type declaration

Name	Type
didEnd	string[]
didGenerate	string[]
didSetup	string[]
fileManager	FileManager
generatorOptions	NormalizedGeneratorOptions
pluginNames	string[]
watching	boolean
changedFile?	WatcherFile

Type Parameters

Type Parameter	Default type
T	unknown

---

GeneratorPluginV1Factory<Store>

GeneratorPluginV1Factory<Store>: object

Type Parameters

Type Parameter	Default type
Store	unknown

Type declaration

Name	Type
actionName	string
name	string
end?	GeneratorPluginV1Fn<Store>
generate?	GeneratorPluginV1Fn<Store>
setup?	GeneratorPluginV1Fn<Store>
watch?	GeneratorPluginV1WatchOptions

---

GeneratorPluginV1Fn()<Store>

GeneratorPluginV1Fn<Store>: (ctx, next) => Promise<void>

Type Parameters

Type Parameter	Default type
Store	unknown

Parameters

Parameter	Type
ctx	Ctx<Store>
next	() => Promise<void>

Returns

Promise<void>

---

GeneratorPluginV1ReloadFn()

GeneratorPluginV1ReloadFn: (file) => void

Parameters

Parameter	Type
file	WatcherFile

Returns

void

---

GeneratorPluginV1WatchOptions()

GeneratorPluginV1WatchOptions: (options, watcher, reload) => void

Parameters

Parameter	Type
options	NormalizedGeneratorOptions
watcher	Watcher
reload	GeneratorPluginV1ReloadFn

Returns

void

---

MatchFn()

MatchFn: (testString) => boolean

Parameters

Parameter	Type
testString	string

Returns

boolean

---

MatchPattern

MatchPattern: string | RegExp | MatchFn

---

WatcherListener()

WatcherListener: (path) => void

Parameters

Parameter	Type
path	WatcherFile

Returns

void

Functions

createPluginV1()

createPluginV1<Store>(options): GeneratorPluginV1<Store>

Type Parameters

Type Parameter	Default type
Store	unknown

Parameters

Parameter	Type
options	GeneratorPluginV1Factory<Store>

Returns

GeneratorPluginV1<Store>

---

getGeneratorPlugins()

getGeneratorPlugins(plugins?): GeneratorPluginV1<unknown>[]

Parameters

Parameter	Type
plugins?	object[]

Returns

GeneratorPluginV1<unknown>[]

---

getModuleCreateName()

getModuleCreateName(name): string

Parameters

Parameter	Type
name	string

Returns

string

---

getModuleGetName()

getModuleGetName(name): string

Parameters

Parameter	Type
name	string

Returns

string

---

getModuleVariableName()

getModuleVariableName(name): string

Parameters

Parameter	Type
name	string

Returns

string

---

isGeneratorPlugin()

isGeneratorPlugin(plugin): plugin is GeneratorPluginV1<unknown>

Parameters

Parameter	Type
plugin	{ type: PluginType; }
plugin.type	PluginType

Returns

plugin is GeneratorPluginV1<unknown>

---

isMatch()

isMatch(string, pattern, options?): boolean

Returns true if the specified string matches the given glob pattern.

Parameters

Parameter	Type	Description
string	string	String to match
pattern	string | readonly string[]	Glob pattern to use for matching.
options?	Options	See available options for changing how matches are performed

Returns

boolean

Returns true if the string matches the glob pattern.

Example

var mm = require('micromatch');
mm.isMatch(string, pattern[, options]);

console.log(mm.isMatch('a.a', '*.a'));
//=> true
console.log(mm.isMatch('a.b', '*.a'));
//=> false

---

loadOptions()

loadOptions(options): NormalizedGeneratorOptions

Parameters

Parameter	Type
options	GeneratorOptions

Returns

NormalizedGeneratorOptions

---

micromatch()

micromatch(list, patterns, options?): string[]

The main function takes a list of strings and one or more glob patterns to use for matching.

Parameters

Parameter	Type	Description
list	readonly string[]	A list of strings to match
patterns	string | readonly string[]	One or more glob patterns to use for matching.
options?	Options	See available options for changing how matches are performed

Returns

string[]

Returns an array of matches

Example

var mm = require('micromatch');
mm(list, patterns[, options]);

console.log(mm(['a.js', 'a.txt'], ['*.js']));
//=> [ 'a.js' ]

Namespaces

• micromatch