DesignModel
Defined in: packages/core/src/models/design.ts:17
Data operations for design links; URLs are validated by the configured providers.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DesignModel(
db,providers,tables?):DesignModel
Defined in: packages/core/src/models/design.ts:22
Parameters
Section titled “Parameters”providers
Section titled “providers”readonly DesignProvider[]
tables?
Section titled “tables?”Returns
Section titled “Returns”DesignModel
Methods
Section titled “Methods”addProjectLink()
Section titled “addProjectLink()”addProjectLink(
projectId,input):Promise<void>
Defined in: packages/core/src/models/design.ts:41
Add a project-level design file link. Throws InvalidDesignUrlError.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
string
string
Returns
Section titled “Returns”Promise<void>
componentLinks()
Section titled “componentLinks()”componentLinks(
projectId):Promise<DesignLink[]>
Defined in: packages/core/src/models/design.ts:34
Component mapping overrides (import_path → URL), by path.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
Returns
Section titled “Returns”Promise<DesignLink[]>
projectLinks()
Section titled “projectLinks()”projectLinks(
projectId):Promise<DesignLink[]>
Defined in: packages/core/src/models/design.ts:29
Project-level design file links, oldest first.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
Returns
Section titled “Returns”Promise<DesignLink[]>
removeLink()
Section titled “removeLink()”removeLink(
projectId,id):Promise<void>
Defined in: packages/core/src/models/design.ts:60
Remove a link scoped to the project.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
string
Returns
Section titled “Returns”Promise<void>
setComponentLink()
Section titled “setComponentLink()”setComponentLink(
projectId,importPath,rawUrl):Promise<void>
Defined in: packages/core/src/models/design.ts:47
Map a story file to a design URL (replaces any existing mapping). Throws InvalidDesignUrlError.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
importPath
Section titled “importPath”string
rawUrl
Section titled “rawUrl”string
Returns
Section titled “Returns”Promise<void>