Skip to content
Darkroom0.3.1
API reference

browser

Import

Section titled “Import”
Import
import * as api from "@fungi.computer/darkroom/browser";

Exports

Section titled “Exports”
Kind Export Description
type alias MediaGenerationDiagnostic Host diagnostic sink; generation errors and retry truth remain transport-owned.
type alias MediaFailure Sanitized Media failure carried from the authenticated host to Agar.
constant mediaFailureSchema Sanitized HTTP refusal emitted by a Media host and decoded at the browser boundary.
function readMediaFailure() Read and decode one Media host failure at the browser HTTP boundary.

MediaGenerationDiagnostictype alias

Section titled “MediaGenerationDiagnostic”
Signature
type MediaGenerationDiagnostic = (operation, cause, details?) => void;

Host diagnostic sink; generation errors and retry truth remain transport-owned.

Parameters

Section titled “Parameters”
Parameter Type
operation | "app_media_pending_response_unavailable" | "media_failure_body_read_failed"
cause unknown
details? Readonly<{ status: number; }>

Returns

Section titled “Returns”

void

MediaFailuretype alias

Section titled “MediaFailure”
Signature
type MediaFailure = z.output<typeof mediaFailureSchema>;

Sanitized Media failure carried from the authenticated host to Agar.

mediaFailureSchemaconstant

Section titled “mediaFailureSchema”
Signature
const mediaFailureSchema: ZodObject<{
  error: ZodString;
  stage: ZodEnum<{
     admission: "admission";
     generation-authorization: "generation-authorization";
     settings: "settings";
     estimate: "estimate";
     billing: "billing";
     operation: "operation";
     provider: "provider";
     normalization: "normalization";
     artifact: "artifact";
     destination-authorization: "destination-authorization";
     destination-write: "destination-write";
  }>;
  code: ZodEnum<{
     CAPABILITY_DENIED: "CAPABILITY_DENIED";
     INSUFFICIENT_CREDIT: "INSUFFICIENT_CREDIT";
     HOST_FAILURE: "HOST_FAILURE";
     INVALID_ARGUMENT: "INVALID_ARGUMENT";
     SAFETY_FILTER_REFUSED: "SAFETY_FILTER_REFUSED";
  }>;
  retryable: ZodBoolean;
  provider: ZodOptional<ZodPipe<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, ZodTransform<
     | Readonly<{
     category:   | "InferenceUpstreamError"
        | "AiInternalError"
        | "TypeError"
        | "AbortError"
        | "TimeoutError"
        | "Error";
     code: number | null;
   }>
     | Readonly<{
     category: "result_download";
     status: number;
  }>, unknown>>>;
}, $strict>;

Sanitized HTTP refusal emitted by a Media host and decoded at the browser boundary.

readMediaFailure()function

Section titled “readMediaFailure()”
Signature
function readMediaFailure(
  response,
  diagnostic?,
): Promise<{
  error: string;
  stage:
    | "provider"
    | "admission"
    | "generation-authorization"
    | "settings"
    | "estimate"
    | "billing"
    | "operation"
    | "normalization"
    | "artifact"
    | "destination-authorization"
    | "destination-write";
  code:
    | "CAPABILITY_DENIED"
    | "INSUFFICIENT_CREDIT"
    | "HOST_FAILURE"
    | "INVALID_ARGUMENT"
    | "SAFETY_FILTER_REFUSED";
  retryable: boolean;
  provider?:
    | Readonly<{
        category:
          | "InferenceUpstreamError"
          | "AiInternalError"
          | "TypeError"
          | "AbortError"
          | "TimeoutError"
          | "Error";
        code: number | null;
      }>
    | Readonly<{
        category: "result_download";
        status: number;
      }>;
} | null>;

Read and decode one Media host failure at the browser HTTP boundary.

Parameters

Section titled “Parameters”
Parameter Type Default value
response Response undefined
diagnostic MediaGenerationDiagnostic reportCatchFailure

Returns

Section titled “Returns”

Promise< | { error: string; stage: | "provider" | "admission" | "generation-authorization" | "settings" | "estimate" | "billing" | "operation" | "normalization" | "artifact" | "destination-authorization" | "destination-write"; code: | "CAPABILITY_DENIED" | "INSUFFICIENT_CREDIT" | "HOST_FAILURE" | "INVALID_ARGUMENT" | "SAFETY_FILTER_REFUSED"; retryable: boolean; provider?: | Readonly<{ category: | "InferenceUpstreamError" | "AiInternalError" | "TypeError" | "AbortError" | "TimeoutError" | "Error"; code: number | null; }> | Readonly<{ category: "result_download"; status: number; }>; } | null>

References

Section titled “References”

MAX_MEDIA_PROMPT_LENGTH

Section titled “MAX_MEDIA_PROMPT_LENGTH”

Re-exports MAX_MEDIA_PROMPT_LENGTH