Class CatalogClient

sdk.catalog — registry reads (public) + publish/verification/curation (admin). See the module doc for the auth split.

Index

Constructors

Methods

createCase decideCase get getBundleUrl list listCases publish reportVerification

Constructors

constructor

new CatalogClient(call: Caller, callPublic?: Caller): CatalogClient
Parameters
- call: Caller
  authed Caller for the admin-gated write endpoints.
- callPublic: Caller = call
  auth-less Caller for the public, cacheable read endpoints (index/detail/bundle URL). Defaults to call so existing tests can construct with a single caller.
Returns CatalogClient
- Defined in src/resources/catalog.ts:211

Methods

createCase

createCase(
payload: CreateCurationCaseRequest,
opts?: RequestOptions,
): Promise<CurationCase>
Open a curation case (ADR-0013). Admin.
Parameters
- payload: CreateCurationCaseRequest
- Optionalopts: RequestOptions
Returns Promise<CurationCase>
- Defined in src/resources/catalog.ts:297

decideCase

decideCase(
    caseId: string,
    decision: CurationCaseDecision,
    opts?: RequestOptions,
): Promise<CurationCase>
Decide a curation case (approve / reject / request-changes). Admin.
Parameters
- caseId: string
- decision: CurationCaseDecision
- Optionalopts: RequestOptions
Returns Promise<CurationCase>
Throws
NotFoundError if the case does not exist.
- Defined in src/resources/catalog.ts:321

get

get(
    name: string,
    version?: string,
    opts?: RequestOptions,
): Promise<CatalogTemplateDetail>
Fetch one template's full detail (manifest included). Public.
Parameters
- name: string
- Optionalversion: string
  optional exact version; omitted resolves the latest.
- Optionalopts: RequestOptions
Returns Promise<CatalogTemplateDetail>
Throws
NotFoundError if the template (or version) does not exist.
- Defined in src/resources/catalog.ts:251

getBundleUrl

getBundleUrl(digest: string, opts?: RequestOptions): Promise<CatalogBundleUrl>
Resolve a presigned URL for a compose bundle by digest. Public.
Parameters
- digest: string
- Optionalopts: RequestOptions
Returns Promise<CatalogBundleUrl>
- Defined in src/resources/catalog.ts:264

list

list(
filters?: CatalogListFilters,
opts?: RequestOptions,
): Promise<CatalogTemplateSummary[]>
List published templates, optionally filtered. Public — no credentials required.
Parameters
- filters: CatalogListFilters = {}
- Optionalopts: RequestOptions
Returns Promise<CatalogTemplateSummary[]>
- Defined in src/resources/catalog.ts:219

listCases

listCases(
params?: { status?: CurationCaseStatus },
opts?: RequestOptions,
): Promise<CurationCase[]>
List curation cases, optionally filtered by status (queue view). Admin.
Parameters
- params: { status?: CurationCaseStatus } = {}
- Optionalopts: RequestOptions
Returns Promise<CurationCase[]>
- Defined in src/resources/catalog.ts:305

publish

publish(
payload: PublishTemplateRequest,
opts?: RequestOptions,
): Promise<CatalogTemplateDetail>
Publish a template version (manifest + bundle digest + image map). Admin.
Parameters
- payload: PublishTemplateRequest
- Optionalopts: RequestOptions
Returns Promise<CatalogTemplateDetail>
Throws
AuthorizationError if the caller is not an admin.
- Defined in src/resources/catalog.ts:277

reportVerification

reportVerification(
    name: string,
    result: CatalogVerificationResult,
    opts?: RequestOptions,
): Promise<void>
Report a nightly verification outcome for a template (Phase 8 writer). Admin.
Parameters
- name: string
- result: CatalogVerificationResult
- Optionalopts: RequestOptions
Returns Promise<void>
Throws
AuthorizationError if the caller is not an admin.
- Defined in src/resources/catalog.ts:289