Class SheetRepository

Constructors

constructor

new SheetRepository(): SheetRepository
Returns SheetRepository

Properties

`Protected` `Readonly`spec_sheets

spec_sheets: SpecSheet[] = []

Accessors

sheets

get sheets(): SpecSheet[]
Returns a shallow copy of all sheets.

Returns SpecSheet[]
Repository sheets snapshot.
- Defined in src/sheets/sheet.repository.ts:210

sheetNames

get sheetNames(): { id: string; name: string }[]
Returns ids and names for all available sheets.

Returns { id: string; name: string }[]
Array of selectable sheet metadata.
- Defined in src/sheets/sheet.repository.ts:218

Methods

upsertSheet

upsertSheet(sheet: SpecSheet): void
Inserts a new sheet or updates an existing one by id.
Parameters
- sheet: SpecSheet
  Sheet payload to store.
Returns void
- Defined in src/sheets/sheet.repository.ts:14

deleteSheet

deleteSheet(sheet_id: string): void
Removes a sheet from the repository by id.
Parameters
- sheet_id: string
  Identifier of the sheet to remove.
Returns void
- Defined in src/sheets/sheet.repository.ts:28

publishSheetAs

publishSheetAs(
    source_sheet_id: string,
    sheet_id: string,
    name: string,
    description?: string,
): SpecSheet
Clones a source sheet into a new reusable sheet id and name.
Parameters
- source_sheet_id: string
  Existing sheet id to clone from.
- sheet_id: string
  Target id for the published sheet.
- name: string
  Target display name for the published sheet.
- Optionaldescription: string
  Optional description override.
Returns SpecSheet
The newly published sheet.
- Defined in src/sheets/sheet.repository.ts:43

readEmbedded

readEmbedded(json: any): EmbeddedSheet
Reads an embedded sheet payload into normalized sheet data.
Parameters
- json: any
  Raw embedded sheet payload.
Returns EmbeddedSheet
Normalized embedded sheet object.
- Defined in src/sheets/sheet.repository.ts:76

resolveSheetSource

resolveSheetSource(
    source:
        | string
        | EmbeddedSheet
        | SpecSheet
        | { sheet?: EmbeddedSheet
        | SpecSheet },
    preferId?: string,
): SpecSheet
Resolves a stylesheet source payload into a normalized spec sheet. Accepts JSON text, embedded/spec-sheet objects, or envelope objects with a nested sheet field.
Parameters
- source: string | EmbeddedSheet | SpecSheet | { sheet?: EmbeddedSheet | SpecSheet }
  Stylesheet source payload.
- OptionalpreferId: string
  Optional id used when source omits an id.
Returns SpecSheet
Normalized spec sheet.
- Defined in src/sheets/sheet.repository.ts:97

upsertSheetFromSource

upsertSheetFromSource(
    source:
        | string
        | EmbeddedSheet
        | SpecSheet
        | { sheet?: EmbeddedSheet
        | SpecSheet },
    preferId?: string,
): SpecSheet
Resolves a stylesheet source payload and upserts it into the repository.
Parameters
- source: string | EmbeddedSheet | SpecSheet | { sheet?: EmbeddedSheet | SpecSheet }
  Stylesheet source payload.
- OptionalpreferId: string
  Optional id used when source omits an id.
Returns SpecSheet
The stored spec sheet.
- Defined in src/sheets/sheet.repository.ts:137

writeEmbedded

writeEmbedded(sheet_id: string): EmbeddedSheet
Writes a repository sheet to an embedded-serialization payload.
Parameters
- sheet_id: string
  Sheet identifier to serialize.
Returns EmbeddedSheet
Embedded sheet payload.
- Defined in src/sheets/sheet.repository.ts:148

makeCustomSheetId

makeCustomSheetId(owner_id: string): string
Builds a diagram-scoped custom sheet id.
Parameters
- owner_id: string
  Diagram identifier that owns the custom sheet.
Returns string
Custom sheet id.
- Defined in src/sheets/sheet.repository.ts:171

isCustomSheetId

isCustomSheetId(sheet_id?: string): boolean
Checks whether a sheet id follows the custom-sheet naming convention.
Parameters
- Optionalsheet_id: string
  Sheet id to test.
Returns boolean
True when the id is custom-scoped; otherwise false.
- Defined in src/sheets/sheet.repository.ts:180

writeSheet

writeSheet(sheet_id: string): SpecSheet
Returns a sheet reference for read/write operations.
Parameters
- sheet_id: string
  Sheet identifier.
Returns SpecSheet
The resolved sheet.
- Defined in src/sheets/sheet.repository.ts:190

clear

clear(): void
Removes all sheets from the repository.

Returns void
- Defined in src/sheets/sheet.repository.ts:202

sheetClasses

sheetClasses(sheet_id: string): string[]
Lists class names defined in a sheet.
Parameters
- sheet_id: string
  Sheet identifier.
Returns string[]
Class name list.
- Defined in src/sheets/sheet.repository.ts:231

sheet

sheet(sheet_id: string): SpecSheet | undefined
Finds a sheet by id.
Parameters
- sheet_id: string
  Sheet identifier.
Returns SpecSheet | undefined
Resolved sheet or undefined when not found.
- Defined in src/sheets/sheet.repository.ts:245

applyToDiagram

applyToDiagram(diagram: Diagram, sheet_id: string): void
Applies diagram-level and node-level styles from a sheet.
Parameters
- diagram: Diagram
  Target diagram.
- sheet_id: string
  Source sheet identifier.
Returns void
- Defined in src/sheets/sheet.repository.ts:254

applyToNode

applyToNode(node: INode, sheet_id: string): void
Applies the computed style of a sheet to a single node.
Parameters
- node: INode
  Target node.
- sheet_id: string
  Source sheet identifier.
Returns void
- Defined in src/sheets/sheet.repository.ts:272

applyStyleToNode

applyStyleToNode(node: INode, style: Partial<NodeStyle>): void
Merges a partial node style into a node's current style values.
Parameters
- node: INode
  Target node to mutate.
- style: Partial<NodeStyle>
  Partial style values to apply.
Returns void
- Defined in src/sheets/sheet.repository.ts:297

upsertTypeStyle

upsertTypeStyle(type_name: string, style: NodeStyle, sheet_id: string): void
Inserts or updates a type style in a sheet.
Parameters
- type_name: string
  Node type key.
- style: NodeStyle
  Style payload.
- sheet_id: string
  Target sheet identifier.
Returns void
- Defined in src/sheets/sheet.repository.ts:314

upsertClassStyle

upsertClassStyle(style_class: string, style: NodeStyle, sheet_id: string): void
Inserts or updates a class style in a sheet.
Parameters
- style_class: string
  Style class key.
- style: NodeStyle
  Style payload.
- sheet_id: string
  Target sheet identifier.
Returns void
- Defined in src/sheets/sheet.repository.ts:329

renameClass

renameClass(old_name: string, new_name: string, sheet_id: string): void
Renames a class style key inside a sheet.
Parameters
- old_name: string
  Existing class key.
- new_name: string
  Replacement class key.
- sheet_id: string
  Target sheet identifier.
Returns void
- Defined in src/sheets/sheet.repository.ts:344

Class SheetRepository

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SheetRepository

Properties

Protected Readonlyspec_sheets

Accessors

sheets

Returns SpecSheet[]

sheetNames

Returns { id: string; name: string }[]

Methods

upsertSheet

Parameters

Returns void

deleteSheet

Parameters

Returns void

publishSheetAs

Parameters

Returns SpecSheet

readEmbedded

Parameters

Returns EmbeddedSheet

resolveSheetSource

Parameters

Returns SpecSheet

upsertSheetFromSource

Parameters

Returns SpecSheet

writeEmbedded

Parameters

Returns EmbeddedSheet

makeCustomSheetId

Parameters

Returns string

isCustomSheetId

Parameters

Returns boolean

writeSheet

Parameters

Returns SpecSheet

clear

Returns void

sheetClasses

Parameters

Returns string[]

sheet

Parameters

Returns SpecSheet | undefined

applyToDiagram

Parameters

Returns void

applyToNode

Parameters

Returns void

applyStyleToNode

Parameters

Returns void

upsertTypeStyle

Parameters

Returns void

upsertClassStyle

Parameters

Returns void

renameClass

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`spec_sheets