craft-hub / ProjectRegistry

Class: ProjectRegistry

Defined in: packages/craft-hub/src/projects.ts:16

Constructors

Constructor

new ProjectRegistry(store): ProjectRegistry

Defined in: packages/craft-hub/src/projects.ts:17

Parameters

store

CraftHubStore

Returns

ProjectRegistry

Methods

add()

add(inputPath): Promise<ProjectRecord>

Defined in: packages/craft-hub/src/projects.ts:60

Parameters

inputPath

string

Returns

Promise<ProjectRecord>

---

get()

get(id): Promise<ProjectRecord>

Defined in: packages/craft-hub/src/projects.ts:84

Parameters

id

string

Returns

Promise<ProjectRecord>

---

iconPath()

iconPath(id): Promise<string | undefined>

Defined in: packages/craft-hub/src/projects.ts:148

Resolve a validated repository-local icon path for the local HTTP asset route.

Parameters

id

string

Returns

Promise<string | undefined>

---

identify()

identify(path): Promise<ProjectReference>

Defined in: packages/craft-hub/src/projects.ts:92

Derive the portable Project Reference represented by one local directory.

Parameters

path

string

Returns

Promise<ProjectReference>

---

list()

list(): Promise<ProjectRecord[]>

Defined in: packages/craft-hub/src/projects.ts:56

List registered projects with project-local metadata failures isolated.

Returns

Promise<ProjectRecord[]>

---

remove()

remove(id): Promise<ProjectRecord>

Defined in: packages/craft-hub/src/projects.ts:138

Unregister a project without deleting its directory.

Parameters

id

string

Returns

Promise<ProjectRecord>

---

reorder()

reorder(projectOrder): Promise<ProjectRecord[]>

Defined in: packages/craft-hub/src/projects.ts:127

Persist a complete ordering of registered projects.

Parameters

projectOrder

string[]

Returns

Promise<ProjectRecord[]>

---

resolveReference()

resolveReference(reference): Promise<ProjectRecord[]>

Defined in: packages/craft-hub/src/projects.ts:97

Resolve every registered Project that exactly matches a portable reference.

Parameters

reference

ProjectReference

Returns

Promise<ProjectRecord[]>

---

setTrust()

setTrust(id, trust): Promise<ProjectRecord>

Defined in: packages/craft-hub/src/projects.ts:106

Parameters

id

string

trust

TrustState

Returns

Promise<ProjectRecord>

---

setVisual()

setVisual(id, visual): Promise<ProjectRecord>

Defined in: packages/craft-hub/src/projects.ts:118

Update portable visual metadata for a trusted project without changing registration state.

Parameters

id

string

visual

ProjectVisualInput

Returns

Promise<ProjectRecord>

---

snapshot()

snapshot(): Promise<ProjectCatalogSnapshot>

Defined in: packages/craft-hub/src/projects.ts:20

Read registered projects while isolating project-local metadata failures.

Returns

Promise<ProjectCatalogSnapshot>

---

verifyReference()

verifyReference(path, reference): Promise<ProjectReference>

Defined in: packages/craft-hub/src/projects.ts:102

Verify a user-selected directory before an unresolved Project is registered.

Parameters

path

string

reference

ProjectReference

Returns

Promise<ProjectReference>