@codesoul-co/hypha-adapters-local / sqlite-artifact-record-repository

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/sqlite-artifact-record-repository.ts
• Exports: 2

Using this module

Use the Sqlite artifact record repository module for persisting and reading data at this boundary. It exports 1 class, 1 interface.

Import from the package entrypoint

import {
  SQLiteArtifactRecordRepository,
} from '@codesoul-co/hypha-adapters-local';

import type {
  SQLiteArtifactRecordRepositoryOptions,
} from '@codesoul-co/hypha-adapters-local';

Usage patterns

• Use the 1 type/interface export 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
SQLiteArtifactRecordRepository	class	new SQLiteArtifactRecordRepository(options: SQLiteArtifactRecordRepositoryOptions): SQLiteArtifactRecordRepository	SQLite Artifact Record Repository class with 14 public constructor or member entries; its exact declarations are listed below.
SQLiteArtifactRecordRepositoryOptions	interface	interface SQLiteArtifactRecordRepositoryOptions	SQLite Artifact Record Repository Options interface with 5 public fields or methods.

SQLiteArtifactRecordRepository

SQLite Artifact Record Repository class with 14 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SQLiteArtifactRecordRepository } from '@codesoul-co/hypha-adapters-local';
• Source module: sqlite-artifact-record-repository

Declaration

export declare class SQLiteArtifactRecordRepository implements ArtifactRecordRepository {
    readonly id: string;
    readonly filename: string;
    constructor(options: SQLiteArtifactRecordRepositoryOptions);
    get(artifactId: string, versionId?: string): Promise<StoredArtifactRecord | null>;
    getByVersionId(versionId: string): Promise<StoredArtifactRecord | null>;
    list(): Promise<StoredArtifactRecord[]>;
    findIdempotency(operationId: string, idempotencyKey: string): Promise<StoredArtifactRecord | null>;
    commit(request: ArtifactRecordCommitRequest): Promise<void>;
    listGarbageCollectionCandidates(request: ArtifactGarbageCollectionScanRequest): Promise<ArtifactGarbageCollectionCandidate[]>;
    claimGarbageCollection(request: ArtifactGarbageCollectionClaimRequest): Promise<boolean>;
    completeGarbageCollection(claimId: string, completedAt: string): Promise<void>;
    releaseGarbageCollection(claimId: string): Promise<void>;
    health(): Promise<ProviderHealth>;
    close(): Promise<void>;
}

Public members

Member	Kind	Signature	Description
claimGarbageCollection	method	claimGarbageCollection(request: ArtifactGarbageCollectionClaimRequest): Promise<boolean>	Public method; parameters and return type are shown in the signature.
close	method	close(): Promise<void>	Public method; parameters and return type are shown in the signature.
commit	method	commit(request: ArtifactRecordCommitRequest): Promise<void>	Public method; parameters and return type are shown in the signature.
completeGarbageCollection	method	completeGarbageCollection(claimId: string, completedAt: string): Promise<void>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: SQLiteArtifactRecordRepositoryOptions): SQLiteArtifactRecordRepository	Creates an instance of this class.
filename	property	readonly filename: string	Public property; its type, readonly modifier and optionality are shown in the signature.
findIdempotency	method	findIdempotency(operationId: string, idempotencyKey: string): Promise<StoredArtifactRecord | null>	Public method; parameters and return type are shown in the signature.
get	method	get(artifactId: string, versionId?: string): Promise<StoredArtifactRecord | null>	Public method; parameters and return type are shown in the signature.
getByVersionId	method	getByVersionId(versionId: string): Promise<StoredArtifactRecord | null>	Public method; parameters and return type are shown in the signature.
health	method	health(): Promise<ProviderHealth>	Public method; parameters and return type are shown in the signature.
id	property	readonly id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
list	method	list(): Promise<StoredArtifactRecord[]>	Public method; parameters and return type are shown in the signature.
listGarbageCollectionCandidates	method	listGarbageCollectionCandidates(request: ArtifactGarbageCollectionScanRequest): Promise<ArtifactGarbageCollectionCandidate[]>	Public method; parameters and return type are shown in the signature.
releaseGarbageCollection	method	releaseGarbageCollection(claimId: string): Promise<void>	Public method; parameters and return type are shown in the signature.

SQLiteArtifactRecordRepositoryOptions

SQLite Artifact Record Repository Options interface with 5 public fields or methods.

• Kind: interface
• Import: import type { SQLiteArtifactRecordRepositoryOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: sqlite-artifact-record-repository

Declaration

export interface SQLiteArtifactRecordRepositoryOptions {
    rootPath: string;
    filename?: string;
    id?: string;
    busyTimeoutMs?: number;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
busyTimeoutMs	property	busyTimeoutMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
filename	property	filename?: 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.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
rootPath	property	rootPath: string	Public property; its type, readonly modifier and optionality are shown in the signature.