@fungi.computer/darkroom 0.0.0-stage → 0.0.1

package/docs/api/modules.md

@@ -0,0 +1,19 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/darkroom**](README.md)
+
+---
+
+# @fungi.computer/darkroom
+
+## Modules
+
+| Module                                        | Description |
+| --------------------------------------------- | ----------- |
+| [app-media-contracts](app-media-contracts.md) | -           |
+| [browser](browser.md)                         | -           |
+| [cloudflare](cloudflare.md)                   | -           |
+| [effect](effect.md)                           | -           |
+| [index](index.md)                             | -           |
+| [provenance-export](provenance-export.md)     | -           |
+| [server](server.md)                           | -           |

package/docs/api/provenance-export.md

@@ -0,0 +1,114 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/darkroom**](README.md)
+
+---
+
+[@fungi.computer/darkroom](modules.md) / provenance-export
+
+# provenance-export
+
+## Classes
+
+### ProvenanceExportError
+
+A refusal to export unsafe, unsupported or oversized image bytes.
+
+#### Extends
+
+- `Error`
+
+#### Constructors
+
+##### Constructor
+
+```ts
+new ProvenanceExportError(reason, options?): ProvenanceExportError;
+```
+
+###### Parameters
+
+| Parameter  | Type                                                  | Description             |
+| ---------- | ----------------------------------------------------- | ----------------------- |
+| `reason`   | [`ProvenanceExportFailure`](#provenanceexportfailure) | Bounded refusal reason. |
+| `options?` | `ErrorOptions`                                        | -                       |
+
+###### Returns
+
+[`ProvenanceExportError`](#provenanceexporterror)
+
+###### Overrides
+
+```ts
+Error.constructor;
+```
+
+#### Properties
+
+##### name
+
+```ts
+readonly name: "ProvenanceExportError" = "ProvenanceExportError";
+```
+
+Stable export refusal name.
+
+###### Overrides
+
+```ts
+Error.name;
+```
+
+##### reason
+
+```ts
+readonly reason: ProvenanceExportFailure;
+```
+
+Bounded refusal reason.
+
+## Type Aliases
+
+### ProvenanceExportFailure
+
+```ts
+type ProvenanceExportFailure =
+  "too-large" | "signed-image" | "invalid-image" | "unsupported-format";
+```
+
+Why a lossless public image export was refused.
+
+## Variables
+
+### maximumPrintDownloadBytes
+
+```ts
+const maximumPrintDownloadBytes: number;
+```
+
+The admitted Computer file read and generated output share this launch bound.
+
+## Functions
+
+### stripPrivateProvenance()
+
+```ts
+function stripPrivateProvenance(bytes): Promise<{
+  bytes: Uint8Array;
+  type: string;
+  extension: string;
+}>;
+```
+
+Lossless browser export. Never mutates the input or falls back to private bytes.
+
+#### Parameters
+
+| Parameter | Type         |
+| --------- | ------------ |
+| `bytes`   | `Uint8Array` |
+
+#### Returns
+
+`Promise`\<\{ `bytes`: `Uint8Array`; `type`: `string`; `extension`: `string`;
+\}\>