@codesoul-co/hypha-adapters-local / local-artifact-manifest

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/local-artifact-manifest.ts
• Exports: 5

Using this module

Use the Local artifact manifest module for using the public contracts and operations for this capability boundary. It exports 4 functions, 1 interface.

Import from the package entrypoint

import {
  deleteLocalArtifactManifest,
  listLocalArtifactManifests,
  readLocalArtifactManifest,
  writeLocalArtifactManifest,
} from '@codesoul-co/hypha-adapters-local';

import type {
  LocalArtifactObjectManifest,
} 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 4 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
deleteLocalArtifactManifest	function	deleteLocalArtifactManifest(paths: LocalArtifactStorePaths, objectKey: string): Promise<void>	Delete Local Artifact Manifest function with 1 public call signature; parameters and return types are listed below.
listLocalArtifactManifests	function	listLocalArtifactManifests(paths: LocalArtifactStorePaths): Promise<LocalArtifactObjectManifest[]>	List Local Artifact Manifests function with 1 public call signature; parameters and return types are listed below.
readLocalArtifactManifest	function	readLocalArtifactManifest(paths: LocalArtifactStorePaths, objectKey: string): Promise<LocalArtifactObjectManifest | null>	Read Local Artifact Manifest function with 1 public call signature; parameters and return types are listed below.
writeLocalArtifactManifest	function	writeLocalArtifactManifest(paths: LocalArtifactStorePaths, manifest: LocalArtifactObjectManifest, options?: { ifAbsent?: boolean; }): Promise<void>	Write Local Artifact Manifest function with 1 public call signature; parameters and return types are listed below.
LocalArtifactObjectManifest	interface	interface LocalArtifactObjectManifest	Local Artifact Object Manifest interface with 8 public fields or methods.

deleteLocalArtifactManifest

Delete Local Artifact Manifest function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { deleteLocalArtifactManifest } from '@codesoul-co/hypha-adapters-local';
• Source module: local-artifact-manifest

Declaration

export declare function deleteLocalArtifactManifest(paths: LocalArtifactStorePaths, objectKey: string): Promise<void>;

Call signature

deleteLocalArtifactManifest(paths: LocalArtifactStorePaths, objectKey: string): Promise<void>

Parameters

Parameter	Type	Required	Description
paths	LocalArtifactStorePaths	Yes	Required parameter; accepted values are defined by the type column.
objectKey	string	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: Promise<void>
• Description: The return contract is defined by the type shown above.

listLocalArtifactManifests

List Local Artifact Manifests function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { listLocalArtifactManifests } from '@codesoul-co/hypha-adapters-local';
• Source module: local-artifact-manifest

Declaration

export declare function listLocalArtifactManifests(paths: LocalArtifactStorePaths): Promise<LocalArtifactObjectManifest[]>;

Call signature

listLocalArtifactManifests(paths: LocalArtifactStorePaths): Promise<LocalArtifactObjectManifest[]>

Parameters

Parameter	Type	Required	Description
paths	LocalArtifactStorePaths	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: Promise<LocalArtifactObjectManifest[]>
• Description: The return contract is defined by the type shown above.

readLocalArtifactManifest

Read Local Artifact Manifest function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { readLocalArtifactManifest } from '@codesoul-co/hypha-adapters-local';
• Source module: local-artifact-manifest

Declaration

export declare function readLocalArtifactManifest(paths: LocalArtifactStorePaths, objectKey: string): Promise<LocalArtifactObjectManifest | null>;

Call signature

readLocalArtifactManifest(paths: LocalArtifactStorePaths, objectKey: string): Promise<LocalArtifactObjectManifest | null>

Parameters

Parameter	Type	Required	Description
paths	LocalArtifactStorePaths	Yes	Required parameter; accepted values are defined by the type column.
objectKey	string	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: Promise<LocalArtifactObjectManifest>
• Description: The return contract is defined by the type shown above.

writeLocalArtifactManifest

Write Local Artifact Manifest function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { writeLocalArtifactManifest } from '@codesoul-co/hypha-adapters-local';
• Source module: local-artifact-manifest

Declaration

export declare function writeLocalArtifactManifest(paths: LocalArtifactStorePaths, manifest: LocalArtifactObjectManifest, options?: {
    ifAbsent?: boolean;
}): Promise<void>;

Call signature

writeLocalArtifactManifest(paths: LocalArtifactStorePaths, manifest: LocalArtifactObjectManifest, options?: { ifAbsent?: boolean; }): Promise<void>

Parameters

Parameter	Type	Required	Description
paths	LocalArtifactStorePaths	Yes	Required parameter; accepted values are defined by the type column.
manifest	LocalArtifactObjectManifest	Yes	Required parameter; accepted values are defined by the type column.
options	{ ifAbsent?: boolean; }	No	Optional parameter; accepted values are defined by the type column.

Returns

• Type: Promise<void>
• Description: The return contract is defined by the type shown above.

LocalArtifactObjectManifest

Local Artifact Object Manifest interface with 8 public fields or methods.

• Kind: interface
• Import: import type { LocalArtifactObjectManifest } from '@codesoul-co/hypha-adapters-local';
• Source module: local-artifact-manifest

Declaration

export interface LocalArtifactObjectManifest {
    schemaVersion: 1;
    objectKey: string;
    contentHash: string;
    sizeBytes: number;
    mimeType?: string;
    etag: string;
    metadata?: Record<string, string>;
    lastModifiedAt: string;
}

Contract members

Member	Kind	Signature	Description
contentHash	property	contentHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
etag	property	etag: string	Public property; its type, readonly modifier and optionality are shown in the signature.
lastModifiedAt	property	lastModifiedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, string>	Public property; its type, readonly modifier and optionality are shown in the signature.
mimeType	property	mimeType?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
objectKey	property	objectKey: string	Public property; its type, readonly modifier and optionality are shown in the signature.
schemaVersion	property	schemaVersion: 1	Public property; its type, readonly modifier and optionality are shown in the signature.
sizeBytes	property	sizeBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.