`@codesoul-co/hypha-skills` / `remote-registry`

Package index: @codesoul-co/hypha-skills
Source: packages/skills/src/remote-registry.ts
Exports: 9

Using this module

Use the Remote registry module for registering and resolving versioned capabilities or implementations. It exports 1 class, 8 interfaces.

Import from the package entrypoint

import {
  HttpsSkillRegistryClient,
} from '@codesoul-co/hypha-skills';

import type {
  HttpsSkillRegistryClientOptions,
  SignedSkillRegistryEntry,
  SkillDependencyLock,
  SkillRegistryPage,
  SkillSbomRef,
  SkillSupplyChainManifest,
  SkillTransparencyProof,
  VerifiedSkillBundle,
} from '@codesoul-co/hypha-skills';

Usage patterns

Use the 8 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
`HttpsSkillRegistryClient`	class	`new HttpsSkillRegistryClient(options: HttpsSkillRegistryClientOptions): HttpsSkillRegistryClient`	HTTPS registry client that verifies publisher identity and transparency inclusion.
`HttpsSkillRegistryClientOptions`	interface	`interface HttpsSkillRegistryClientOptions`	Https Skill Registry Client Options interface with 13 public fields or methods.
`SignedSkillRegistryEntry`	interface	`interface SignedSkillRegistryEntry`	Signed Skill Registry Entry interface with 3 public fields or methods.
`SkillDependencyLock`	interface	`interface SkillDependencyLock`	Skill Dependency Lock interface with 3 public fields or methods.
`SkillRegistryPage`	interface	`interface SkillRegistryPage`	Skill Registry Page interface with 3 public fields or methods.
`SkillSbomRef`	interface	`interface SkillSbomRef`	Skill Sbom Ref interface with 3 public fields or methods.
`SkillSupplyChainManifest`	interface	`interface SkillSupplyChainManifest`	Skill Supply Chain Manifest interface with 11 public fields or methods.
`SkillTransparencyProof`	interface	`interface SkillTransparencyProof`	Skill Transparency Proof interface with 5 public fields or methods.
`VerifiedSkillBundle`	interface	`interface VerifiedSkillBundle`	Verified Skill Bundle interface with 2 public fields or methods.

`HttpsSkillRegistryClient`

HTTPS registry client that verifies publisher identity and transparency inclusion.

Kind: class
Import: import { HttpsSkillRegistryClient } from '@codesoul-co/hypha-skills';
Source module: remote-registry

Declaration

text

export declare class HttpsSkillRegistryClient {
    constructor(options: HttpsSkillRegistryClientOptions);
    resolve(skillId: string, version: string): Promise<SignedSkillRegistryEntry>;
    list(input?: {
            cursor?: string;
            limit?: number;
        }): Promise<SkillRegistryPage>;
    download(entryInput: SignedSkillRegistryEntry): Promise<VerifiedSkillBundle>;
    verifyOfflineBundle(bundle: VerifiedSkillBundle): VerifiedSkillBundle;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(options: HttpsSkillRegistryClientOptions): HttpsSkillRegistryClient`	Creates an instance of this class.
`download`	method	`download(entryInput: SignedSkillRegistryEntry): Promise<VerifiedSkillBundle>`	Public method; parameters and return type are shown in the signature.
`list`	method	`list(input?: { cursor?: string; limit?: number; }): Promise<SkillRegistryPage>`	Public method; parameters and return type are shown in the signature.
`resolve`	method	`resolve(skillId: string, version: string): Promise<SignedSkillRegistryEntry>`	Public method; parameters and return type are shown in the signature.
`verifyOfflineBundle`	method	`verifyOfflineBundle(bundle: VerifiedSkillBundle): VerifiedSkillBundle`	Public method; parameters and return type are shown in the signature.

`HttpsSkillRegistryClientOptions`

Https Skill Registry Client Options interface with 13 public fields or methods.

Kind: interface
Import: import type { HttpsSkillRegistryClientOptions } from '@codesoul-co/hypha-skills';
Source module: remote-registry

Declaration

text

export interface HttpsSkillRegistryClientOptions {
    endpoint: string;
    publisherKeys: Readonly<Record<string, string>>;
    transparencyLogKeys: Readonly<Record<string, string>>;
    tenantId?: string;
    authorization?: () => string | Promise<string>;
    artifactOrigins?: string[];
    maxMetadataBytes?: number;
    maxBundleBytes?: number;
    timeoutMs?: number;
    maxAttempts?: number;
    fetch?: typeof fetch;
    now?: () => number;
    sleep?: (ms: number) => Promise<void>;
}

Contract members

Member	Kind	Signature	Description
`artifactOrigins`	property	`artifactOrigins?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`authorization`	method	`authorization?(): string \| Promise<string>`	Public method; parameters and return type are shown in the signature.
`endpoint`	property	`endpoint: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`fetch`	method	`fetch?(input: RequestInfo \| URL, init?: RequestInit): Promise<Response> \| fetch?(input: string \| URL \| Request, init?: RequestInit): Promise<Response>`	Public method; parameters and return type are shown in the signature.
`maxAttempts`	property	`maxAttempts?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`maxBundleBytes`	property	`maxBundleBytes?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`maxMetadataBytes`	property	`maxMetadataBytes?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`now`	method	`now?(): number`	Public method; parameters and return type are shown in the signature.
`publisherKeys`	property	`publisherKeys: Readonly<Record<string, string>>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sleep`	method	`sleep?(ms: number): Promise<void>`	Public method; parameters and return type are shown in the signature.
`tenantId`	property	`tenantId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`timeoutMs`	property	`timeoutMs?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`transparencyLogKeys`	property	`transparencyLogKeys: Readonly<Record<string, string>>`	Public property; its type, readonly modifier and optionality are shown in the signature.

`SignedSkillRegistryEntry`

Signed Skill Registry Entry interface with 3 public fields or methods.

Kind: interface
Import: import type { SignedSkillRegistryEntry } from '@codesoul-co/hypha-skills';
Source module: remote-registry

Declaration

text

export interface SignedSkillRegistryEntry {
    manifest: SkillSupplyChainManifest;
    publisherSignature: string;
    transparency: SkillTransparencyProof;
}

Contract members

Member	Kind	Signature	Description
`manifest`	property	`manifest: SkillSupplyChainManifest`	Public property; its type, readonly modifier and optionality are shown in the signature.
`publisherSignature`	property	`publisherSignature: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`transparency`	property	`transparency: SkillTransparencyProof`	Public property; its type, readonly modifier and optionality are shown in the signature.

`SkillDependencyLock`

Skill Dependency Lock interface with 3 public fields or methods.

Kind: interface
Import: import type { SkillDependencyLock } from '@codesoul-co/hypha-skills';
Source module: remote-registry

Declaration

text

export interface SkillDependencyLock {
    id: string;
    version: string;
    contentSha256: string;
}

Contract members

Member	Kind	Signature	Description
`contentSha256`	property	`contentSha256: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`version`	property	`version: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`SkillRegistryPage`

Skill Registry Page interface with 3 public fields or methods.

Kind: interface
Import: import type { SkillRegistryPage } from '@codesoul-co/hypha-skills';
Source module: remote-registry

Declaration

text

export interface SkillRegistryPage {
    entries: SignedSkillRegistryEntry[];
    nextCursor?: string;
    revision?: string;
}

Contract members

Member	Kind	Signature	Description
`entries`	property	`entries: SignedSkillRegistryEntry[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`nextCursor`	property	`nextCursor?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`revision`	property	`revision?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`SkillSbomRef`

Skill Sbom Ref interface with 3 public fields or methods.

Kind: interface
Import: import type { SkillSbomRef } from '@codesoul-co/hypha-skills';
Source module: remote-registry

Declaration

text

export interface SkillSbomRef {
    format: 'cyclonedx-json' | 'spdx-json';
    sha256: string;
    url?: string;
}

Contract members

Member	Kind	Signature	Description
`format`	property	`format: "cyclonedx-json" \| "spdx-json"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sha256`	property	`sha256: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`url`	property	`url?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`SkillSupplyChainManifest`

Skill Supply Chain Manifest interface with 11 public fields or methods.

Kind: interface
Import: import type { SkillSupplyChainManifest } from '@codesoul-co/hypha-skills';
Source module: remote-registry

Declaration

text

export interface SkillSupplyChainManifest {
    skillId: string;
    version: string;
    revision?: string;
    contentSha256: string;
    downloadUrl: string;
    publisherId: string;
    issuedAt: string;
    expiresAt?: string;
    tenantIds?: string[];
    dependencies: SkillDependencyLock[];
    sbom: SkillSbomRef;
}

Contract members

Member	Kind	Signature	Description
`contentSha256`	property	`contentSha256: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`dependencies`	property	`dependencies: SkillDependencyLock[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`downloadUrl`	property	`downloadUrl: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expiresAt`	property	`expiresAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`issuedAt`	property	`issuedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`publisherId`	property	`publisherId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`revision`	property	`revision?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sbom`	property	`sbom: SkillSbomRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillId`	property	`skillId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tenantIds`	property	`tenantIds?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`version`	property	`version: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`SkillTransparencyProof`

Skill Transparency Proof interface with 5 public fields or methods.

Kind: interface
Import: import type { SkillTransparencyProof } from '@codesoul-co/hypha-skills';
Source module: remote-registry

Declaration

text

export interface SkillTransparencyProof {
    logId: string;
    logIndex: number;
    entryHash: string;
    checkpointHash: string;
    signature: string;
}

Contract members

Member	Kind	Signature	Description
`checkpointHash`	property	`checkpointHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`entryHash`	property	`entryHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`logId`	property	`logId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`logIndex`	property	`logIndex: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`signature`	property	`signature: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`VerifiedSkillBundle`

Verified Skill Bundle interface with 2 public fields or methods.

Kind: interface
Import: import type { VerifiedSkillBundle } from '@codesoul-co/hypha-skills';
Source module: remote-registry

Declaration

text

export interface VerifiedSkillBundle {
    entry: SignedSkillRegistryEntry;
    content: Uint8Array;
}

Contract members

Member	Kind	Signature	Description
`content`	property	`content: Uint8Array<ArrayBufferLike>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`entry`	property	`entry: SignedSkillRegistryEntry`	Public property; its type, readonly modifier and optionality are shown in the signature.

@codesoul-co/hypha-skills / remote-registry ​

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Public exports ​

HttpsSkillRegistryClient ​

Declaration ​

Public members ​

HttpsSkillRegistryClientOptions ​

Declaration ​

Contract members ​

SignedSkillRegistryEntry ​

Declaration ​

Contract members ​

SkillDependencyLock ​

Declaration ​

Contract members ​

SkillRegistryPage ​

Declaration ​

Contract members ​

SkillSbomRef ​

Declaration ​

Contract members ​

SkillSupplyChainManifest ​

Declaration ​

Contract members ​

SkillTransparencyProof ​

Declaration ​

Contract members ​

VerifiedSkillBundle ​

Declaration ​

Contract members ​

`@codesoul-co/hypha-skills` / `remote-registry`

Using this module

Import from the package entrypoint

Usage patterns

Public exports

`HttpsSkillRegistryClient`

Declaration

Public members

`HttpsSkillRegistryClientOptions`

Declaration

Contract members

`SignedSkillRegistryEntry`

Declaration

Contract members

`SkillDependencyLock`

Declaration

Contract members

`SkillRegistryPage`

Declaration

Contract members

`SkillSbomRef`

Declaration

Contract members

`SkillSupplyChainManifest`

Declaration

Contract members

`SkillTransparencyProof`

Declaration

Contract members

`VerifiedSkillBundle`

Declaration

Contract members