@pyric/cli 0.1.0-alpha.10 → 0.1.0-alpha.11

package/dist/serve/docs-ui/docs/pyric-ui-storage-reference-api.md

@@ -1,5 +1,4 @@
-
-<!-- Generated from published package declarations via TypeDoc. Do not edit by hand; run bun run docs:api:generate. -->
+<!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
 
 ## Interfaces
 
@@ -39,7 +38,7 @@ One `customMetadata` row. `id` is a stable render key — keys are
 | <a id="ondeleted"></a> `onDeleted?` | (`outcome`: [`StorageDeleteOutcome`](#storagedeleteoutcome)) => `void` | Fired after a run with NO failures (e.g. clear the selection + refresh the list). |
 | <a id="onfailed"></a> `onFailed?` | (`outcome`: [`StorageDeleteOutcome`](#storagedeleteoutcome)) => `void` | Fired after a run with failures (the toast already showed). |
 | <a id="rendertrigger"></a> `renderTrigger?` | (`props`: \{ `deniedReason?`: `string`; `disabled`: `boolean`; `isRunning`: `boolean`; `onClick`: () => `void`; `progress`: `number`; \}) => `ReactNode` | Render override for the trigger button. |
-| <a id="storage"></a> `storage` | `any` | The package's single Storage handle prop. |
+| <a id="storage"></a> `storage` | [`FirebaseStorage`](pyric-storage-reference-api.md#firebasestorage) | The package's single Storage handle prop. |
 | <a id="title"></a> `title?` | `string` | Confirm-dialog title. Default derives from the entry count. |
 
 ***
@@ -87,7 +86,7 @@ One dropped file, flattened from the drop's file/folder tree.
 | <a id="error-1"></a> `error?` | `Error` | Renders a `role="alert"` container with the message. Pair with the hook's typed `StorageError` for code-driven copy. |
 | <a id="gate-1"></a> `gate?` | `Pick`\<[`UseStorageRulesGateResult`](#usestoragerulesgateresult), `"verdictFor"`\> | Rules-aware affordances — pass `useStorageRulesGate(storage)`. Rows whose READ verdict denies are stamped `data-pyric-denied` (with the evaluator's reason trace on `data-pyric-denied-reason`). A denied folder row would throw `storage/unauthorized` on `listAll`; the stamp warns BEFORE the click. Rows stay clickable — the affordance is advisory and the sandbox enforcement layer remains authoritative. |
 | <a id="onnavigate"></a> `onNavigate?` | (`path`: `string`) => `void` | Folder row click — fired with the prefix's `fullPath`. Wire to `usePathState.enter` (or `setPath`). |
-| <a id="onselect"></a> `onSelect?` | (`ref`: `StorageReference`) => `void` | Object row click — fired with the object's reference. |
+| <a id="onselect"></a> `onSelect?` | (`ref`: [`StorageReference`](pyric-storage-reference-api.md#storagereference)) => `void` | Object row click — fired with the object's reference. |
 | <a id="renderentry"></a> `renderEntry?` | (`entry`: [`StorageListEntry`](#storagelistentry)) => `ReactNode` | Row-label slot. Default renders the entry name. The row button, its click wiring, and the `data-*` states stay with the component — the slot only owns the label content. |
 | <a id="renderrowaction"></a> `renderRowAction?` | (`entry`: [`StorageListEntry`](#storagelistentry)) => `ReactNode` | Optional per-row action rendered as a sibling of the navigation/select button. Use this for independent controls such as selection checkboxes. |
 | <a id="rowheight"></a> `rowHeight?` | `number` \| (`index`: `number`) => `number` | Estimated row height when virtualizing. Default 36. |
@@ -110,8 +109,8 @@ One dropped file, flattened from the drop's file/folder tree.
 | <a id="classname-2"></a> `className?` | `string` | - |
 | <a id="path"></a> `path` | `string` | Object path to inspect. `null` renders the idle shell — keep the inspector mounted and swap paths as the user selects rows. |
 | <a id="previews"></a> `previews?` | [`StoragePreview`](#storagepreview)[] | Consumer previews, tried BEFORE the built-ins (first match wins) — the extension channel of the preview registry. |
-| <a id="rendermetadata"></a> `renderMetadata?` | (`metadata`: `FullMetadata`) => `ReactNode` | Metadata-section slot. Default renders the standard field list. The header, preview, and state wiring stay with the component. |
-| <a id="storage-1"></a> `storage` | `any` | The package's sandbox Storage handle. |
+| <a id="rendermetadata"></a> `renderMetadata?` | (`metadata`: [`FullMetadata`](pyric-storage-reference-api.md#fullmetadata)) => `ReactNode` | Metadata-section slot. Default renders the standard field list. The header, preview, and state wiring stay with the component. |
+| <a id="storage-1"></a> `storage` | [`FirebaseStorage`](pyric-storage-reference-api.md#firebasestorage) | The package's sandbox Storage handle. |
 
 ***
 
@@ -213,7 +212,7 @@ rows, its `items` become `kind: 'object'` rows, folders first.
 | <a id="fullpath-1"></a> `fullPath` | `string` | Bucket-rooted path (no trailing slash, even for folders). |
 | <a id="kind"></a> `kind` | `"object"` \| `"folder"` | - |
 | <a id="name"></a> `name` | `string` | Last path segment, display name. |
-| <a id="ref"></a> `ref` | `StorageReference` | - |
+| <a id="ref"></a> `ref` | [`StorageReference`](pyric-storage-reference-api.md#storagereference) | - |
 
 ***
 
@@ -233,7 +232,7 @@ matcher.
 | Property | Type | Description |
 | :------ | :------ | :------ |
 | <a id="id-1"></a> `id` | `string` | Diagnostic id — also stamped on the preview container as `data-pyric-preview="<id>"`. |
-| <a id="match"></a> `match` | (`metadata`: `FullMetadata`) => `boolean` | - |
+| <a id="match"></a> `match` | (`metadata`: [`FullMetadata`](pyric-storage-reference-api.md#fullmetadata)) => `boolean` | - |
 | <a id="maxbytes"></a> `maxBytes?` | `number` | Skip the preview (and the blob download) for objects larger than this — the inspector renders its `data-pyric-preview-too-large` fallback instead. `undefined` = no cap. |
 | <a id="needsblob"></a> `needsBlob?` | `boolean` | Ask the inspector to `loadBlob()` before rendering. Default `false` (metadata-only previews render immediately). |
 | <a id="render"></a> `render` | (`ctx`: [`StoragePreviewContext`](#storagepreviewcontext)) => `ReactNode` | - |
@@ -253,7 +252,7 @@ What a preview's `render` receives. `blob`/`blobUrl` are only
 | :------ | :------ |
 | <a id="blob"></a> `blob` | `Blob` |
 | <a id="bloburl"></a> `blobUrl` | `string` |
-| <a id="metadata"></a> `metadata` | `FullMetadata` |
+| <a id="metadata"></a> `metadata` | [`FullMetadata`](pyric-storage-reference-api.md#fullmetadata) |
 
 ***
 
@@ -272,7 +271,7 @@ inject your own for server-driven deletes.
 
 | Property | Type |
 | :------ | :------ |
-| <a id="start"></a> `start` | (`target`: `StorageReference`) => `AsyncIterableIterator`\<[`StorageDeleteProgress`](#storagedeleteprogress)\> |
+| <a id="start"></a> `start` | (`target`: [`StorageReference`](pyric-storage-reference-api.md#storagereference)) => `AsyncIterableIterator`\<[`StorageDeleteProgress`](#storagedeleteprogress)\> |
 
 ***
 
@@ -321,8 +320,8 @@ Explicit-path upload input. `path` is relative to the hook's
 
 | Property | Type |
 | :------ | :------ |
-| <a id="data"></a> `data` | `Blob` \| `ArrayBuffer` \| `Uint8Array`\<`ArrayBufferLike`\> |
-| <a id="metadata-1"></a> `metadata?` | `SettableMetadata` |
+| <a id="data"></a> `data` | `ArrayBuffer` \| `Uint8Array`\<`ArrayBufferLike`\> \| `Blob` |
+| <a id="metadata-1"></a> `metadata?` | [`SettableMetadata`](pyric-storage-reference-api.md#settablemetadata) |
 | <a id="path-2"></a> `path` | `string` |
 
 ***
@@ -347,7 +346,7 @@ at `totalBytes`.
 | <a id="error-3"></a> `error?` | `Error` | Populated on `'error'` — a typed `StorageError` from the sandbox (`.code` is `storage/<code>`, e.g. `storage/unauthorized` for a rules-denied write). |
 | <a id="fullpath-3"></a> `fullPath` | `string` | Bucket-rooted destination path. |
 | <a id="id-2"></a> `id` | `string` | Stable id — key task rows on this, not on `fullPath` (two uploads can target the same path). |
-| <a id="metadata-2"></a> `metadata?` | `FullMetadata` | Populated on `'success'`. |
+| <a id="metadata-2"></a> `metadata?` | [`FullMetadata`](pyric-storage-reference-api.md#fullmetadata) | Populated on `'success'`. |
 | <a id="status-1"></a> `status` | [`UploadTaskStatus`](#uploadtaskstatus-1) | - |
 | <a id="totalbytes"></a> `totalBytes` | `number` | - |
 
@@ -361,7 +360,7 @@ at `totalBytes`.
 
 | Property | Type | Description |
 | :------ | :------ | :------ |
-| <a id="initial-1"></a> `initial?` | `SettableMetadata` | The metadata being edited — the same shape `useStorageObject`'s `metadata` carries. Read once on mount (the editor is a stateful workspace, like the document editor); `reset()` + remount to re-initialize. |
+| <a id="initial-1"></a> `initial?` | [`SettableMetadata`](pyric-storage-reference-api.md#settablemetadata) | The metadata being edited — the same shape `useStorageObject`'s `metadata` carries. Read once on mount (the editor is a stateful workspace, like the document editor); `reset()` + remount to re-initialize. |
 
 ***
 
@@ -384,13 +383,13 @@ at `totalBytes`.
 | <a id="isvalid"></a> `isValid` | `boolean` | Convenience: `errorCount === 0`. |
 | <a id="removecustomentry"></a> `removeCustomEntry` | (`id`: `string`) => `void` | - |
 | <a id="reset"></a> `reset` | () => `void` | Restore the initial values. Clears `isDirty`. |
-| <a id="save"></a> `save` | () => `Promise`\<`any`\> | `updateMetadata(ref(storage, path), toPatch())`. Errors surface via `saveError` (typed `StorageError`), not throws — resolves `undefined` on failure or when the draft is invalid. On success the draft becomes the new baseline (`isDirty` clears) and the fresh `FullMetadata` is returned. |
+| <a id="save"></a> `save` | () => `Promise`\<[`FullMetadata`](pyric-storage-reference-api.md#fullmetadata)\> | `updateMetadata(ref(storage, path), toPatch())`. Errors surface via `saveError` (typed `StorageError`), not throws — resolves `undefined` on failure or when the draft is invalid. On success the draft becomes the new baseline (`isDirty` clears) and the fresh `FullMetadata` is returned. |
 | <a id="saveerror"></a> `saveError` | `Error` | - |
 | <a id="setcachecontrol"></a> `setCacheControl` | (`value`: `string`) => `void` | - |
 | <a id="setcontenttype"></a> `setContentType` | (`value`: `string`) => `void` | - |
 | <a id="setcustomkey"></a> `setCustomKey` | (`id`: `string`, `key`: `string`) => `void` | - |
 | <a id="setcustomvalue"></a> `setCustomValue` | (`id`: `string`, `value`: `string`) => `void` | - |
-| <a id="topatch"></a> `toPatch` | () => `SettableMetadata` | Serialize the draft to an `updateMetadata` patch. Empty `contentType`/`cacheControl` become `undefined` — which LEAVES the previous value (the sandbox doesn't model null-clears; see `pyric/storage`'s `updateMetadata` doc). `customMetadata` is always included and replaces wholesale, so row removal works. |
+| <a id="topatch"></a> `toPatch` | () => [`SettableMetadata`](pyric-storage-reference-api.md#settablemetadata) | Serialize the draft to an `updateMetadata` patch. Empty `contentType`/`cacheControl` become `undefined` — which LEAVES the previous value (the sandbox doesn't model null-clears; see `pyric/storage`'s `updateMetadata` doc). `customMetadata` is always included and replaces wholesale, so row removal works. |
 
 ***
 
@@ -496,8 +495,8 @@ at `totalBytes`.
 | <a id="entries-2"></a> `entries` | [`StorageListEntry`](#storagelistentry)[] | Folders-first merged row model. Derived from `prefixes` + `items`. |
 | <a id="error-5"></a> `error` | `Error` | `StorageError` (with a typed `storage/<code>` on `.code`) from the sandbox. A denied list is `error.code === 'storage/unauthorized'` (ST-B2). |
 | <a id="insertitem"></a> `insertItem` | (`fullPath`: `string`) => `void` | Optimistic seam (consumed by M3 upload / M6 bulk ops, exposed now so those hooks layer on without reshaping this one). Inserts `fullPath` into the local list immediately, applying the same prefix→folder synthesis `listAll` would: a direct child becomes an item, a deeper descendant surfaces as its first-segment folder. A trailing slash declares a folder (the GCS placeholder convention `useObjectUpload.createFolder` writes): a direct trailing-slash child inserts a prefix, not an item. No-op for paths outside the listed path, duplicates, or when `status` is `'idle'`. What each call ACTUALLY inserted is recorded (keyed by the given `fullPath`) so `removeItem` can reverse it precisely. Rollback = `removeItem` or `refresh`. |
-| <a id="items"></a> `items` | `StorageReference`[] | Direct child objects under `path`. Sorted by `fullPath`. |
-| <a id="prefixes"></a> `prefixes` | `StorageReference`[] | Synthetic folder prefixes under `path`. Sorted by `fullPath`. |
+| <a id="items"></a> `items` | [`StorageReference`](pyric-storage-reference-api.md#storagereference)[] | Direct child objects under `path`. Sorted by `fullPath`. |
+| <a id="prefixes"></a> `prefixes` | [`StorageReference`](pyric-storage-reference-api.md#storagereference)[] | Synthetic folder prefixes under `path`. Sorted by `fullPath`. |
 | <a id="refresh"></a> `refresh` | () => `void` | Re-run `listAll` for the current path. |
 | <a id="removeitem"></a> `removeItem` | (`fullPath`: `string`) => `void` | Optimistic counterpart. When `fullPath` was previously given to `insertItem`, this reverses EXACTLY what that call inserted: a deep upload that synthesized a first-segment folder row removes that folder row, and an insert that was a no-op (the row already existed — e.g. a real, listed folder) removes NOTHING, so a failed upload can never delete server-truth rows. For paths never seen by `insertItem` it removes the matching item/folder row directly (the optimistic-delete use). Rollback = `refresh`. |
 | <a id="status-2"></a> `status` | [`StorageListStatus`](#storageliststatus) | `'idle'` only when `storage` is null/undefined. |
@@ -518,7 +517,7 @@ at `totalBytes`.
 | <a id="bloburl-1"></a> `blobUrl` | `string` | `URL.createObjectURL` handle for the loaded blob, used as the local preview channel. Revoked automatically when the blob is replaced, the path changes, or the hook unmounts. |
 | <a id="error-6"></a> `error` | `Error` | Typed `StorageError` (`storage/object-not-found`, `storage/unauthorized`, …). |
 | <a id="loadblob"></a> `loadBlob` | () => `void` | Fetch the bytes via `getBlob`. Subsequent calls re-fetch. |
-| <a id="metadata-3"></a> `metadata` | `any` | - |
+| <a id="metadata-3"></a> `metadata` | [`FullMetadata`](pyric-storage-reference-api.md#fullmetadata) | - |
 | <a id="refresh-1"></a> `refresh` | () => `void` | Re-read the metadata (also resets the blob, the object may have been overwritten). |
 | <a id="status-3"></a> `status` | [`StorageObjectStatus`](#storageobjectstatus) | Metadata read state. `'idle'` when `storage` or `path` is null. |
 
@@ -532,9 +531,9 @@ at `totalBytes`.
 
 | Property | Type | Description |
 | :------ | :------ | :------ |
-| <a id="identity"></a> `identity?` | `any` | Identity override. `null` is anonymous; OMIT the field to use the handle's own identity (the sandbox context's `auth`). |
+| <a id="identity"></a> `identity?` | [`StorageAuth`](pyric-storage-reference-api.md#storageauth) | Identity override. `null` is anonymous; OMIT the field to use the handle's own identity (the sandbox context's `auth`). |
 | <a id="paths"></a> `paths?` | `string` \| readonly `string`[] | Path (or paths) to pre-evaluate into `verdicts`, keyed by the normalized path. Ad-hoc paths (e.g. browser rows) go through `verdictFor` instead — the two are the same evaluation. |
-| <a id="rules"></a> `rules?` | `any` | Explicit rules source — raw rules text (parsed here; a malformed string surfaces as `status: 'error'`) or a pre-parsed `StorageRules` handle. Overrides the sandbox's deployed ruleset when both exist. |
+| <a id="rules"></a> `rules?` | `string` \| [`StorageRules`](pyric-storage-reference-api.md#storagerules) | Explicit rules source — raw rules text (parsed here; a malformed string surfaces as `status: 'error'`) or a pre-parsed `StorageRules` handle. Overrides the sandbox's deployed ruleset when both exist. |
 | <a id="writeresource"></a> `writeResource?` | \{ `contentType?`: `string`; `size`: `number`; \} | The about-to-write payload bound to `request.resource` for the WRITE evaluation — pass `{ size, contentType }` when gating a specific upload so size/contentType-conditioned rules evaluate truthfully. When omitted, `request.resource` is unset, which is exactly DELETE semantics (deletes carry no inbound payload) — a rule like `request.resource.size < N` then denies, the conservative answer for uploads. |
 | `writeResource.contentType?` | `string` | - |
 | `writeResource.size` | `number` | - |
@@ -551,7 +550,7 @@ at `totalBytes`.
 | :------ | :------ | :------ |
 | <a id="advisory"></a> `advisory` | `boolean` | Always false: `pyric/storage` handles are sandbox mirrors. |
 | <a id="error-7"></a> `error` | `Error` | Rules-resolution failure (e.g. a malformed `rules` string). |
-| <a id="identity-1"></a> `identity` | `any` | The identity the verdicts evaluate under. |
+| <a id="identity-1"></a> `identity` | [`StorageAuth`](pyric-storage-reference-api.md#storageauth) | The identity the verdicts evaluate under. |
 | <a id="source"></a> `source` | [`StorageRulesSource`](#storagerulessource) | Where the active ruleset came from. |
 | <a id="status-4"></a> `status` | [`StorageRulesGateStatus`](#storagerulesgatestatus) | `'idle'` only when `storage` is null/undefined. |
 | <a id="verdictfor"></a> `verdictFor` | (`path`: `string`) => [`StorageGateVerdict`](#storagegateverdict) | Evaluate an arbitrary path under the current ruleset + identity. Pure and synchronous once `status` is `'ready'`; before that (and whenever no rules are reachable) it returns the allow-all verdict — the gate FAILS OPEN, because affordances are advisory and the real enforcement (sandbox throw / server denial) stays authoritative. |
@@ -905,7 +904,7 @@ Sorted, deduped, normalized pending prefix paths.
 ### StorageApi
 
 ```ts
-type StorageApi = Pick<any,
+type StorageApi = Pick<pyric-storage-reference-api,
   | "ref"
   | "listAll"
   | "getMetadata"
@@ -1186,7 +1185,7 @@ names).
 ### initMetadataEditorState()
 
 ```ts
-function initMetadataEditorState(initial: any): MetadataEditorState;
+function initMetadataEditorState(initial: SettableMetadata): MetadataEditorState;
 ```
 
 Build the edit state from the metadata a `getMetadata` /
@@ -1196,7 +1195,7 @@ Build the edit state from the metadata a `getMetadata` /
 
 | Parameter | Type |
 | :------ | :------ |
-| `initial` | `any` |
+| `initial` | [`SettableMetadata`](pyric-storage-reference-api.md#settablemetadata) |
 
 #### Returns
 
@@ -1567,7 +1566,7 @@ means metadata-only.
 
 | Parameter | Type |
 | :------ | :------ |
-| `metadata` | `FullMetadata` |
+| `metadata` | [`FullMetadata`](pyric-storage-reference-api.md#fullmetadata) |
 | `consumerPreviews` | readonly [`StoragePreview`](#storagepreview)[] |
 
 #### Returns
@@ -1684,7 +1683,7 @@ Ships no visual styling. Consumers style via:
 
 ```ts
 function useMetadataEditor(
-   storage: any,
+   storage: FirebaseStorage,
    path: string,
    options?: UseMetadataEditorOptions): UseMetadataEditorResult;
 ```
@@ -1699,7 +1698,7 @@ helpers and the save half.
 
 | Parameter | Type |
 | :------ | :------ |
-| `storage` | `any` |
+| `storage` | [`FirebaseStorage`](pyric-storage-reference-api.md#firebasestorage) |
 | `path` | `string` |
 | `options?` | [`UseMetadataEditorOptions`](#usemetadataeditoroptions) |
 
@@ -1714,7 +1713,7 @@ helpers and the save half.
 ### useObjectUpload()
 
 ```ts
-function useObjectUpload(storage: any, options?: UseObjectUploadOptions): UseObjectUploadResult;
+function useObjectUpload(storage: FirebaseStorage, options?: UseObjectUploadOptions): UseObjectUploadResult;
 ```
 
 Multi-file upload over the package's single Storage handle prop.
@@ -1729,7 +1728,7 @@ the write fails (typed `StorageError` on `task.error`).
 
 | Parameter | Type |
 | :------ | :------ |
-| `storage` | `any` |
+| `storage` | [`FirebaseStorage`](pyric-storage-reference-api.md#firebasestorage) |
 | `options?` | [`UseObjectUploadOptions`](#useobjectuploadoptions) |
 
 #### Returns
@@ -1784,7 +1783,7 @@ Read the active Storage API bundle (defaults to in-process `pyric/storage`).
 ### useStorageDelete()
 
 ```ts
-function useStorageDelete(storage: any, options?: UseStorageDeleteOptions): UseStorageDeleteResult;
+function useStorageDelete(storage: FirebaseStorage, options?: UseStorageDeleteOptions): UseStorageDeleteResult;
 ```
 
 Drive bulk + recursive deletes from a React component — the
@@ -1796,7 +1795,7 @@ because storage selections are flat multi-row affairs.
 
 | Parameter | Type |
 | :------ | :------ |
-| `storage` | `any` |
+| `storage` | [`FirebaseStorage`](pyric-storage-reference-api.md#firebasestorage) |
 | `options?` | [`UseStorageDeleteOptions`](#usestoragedeleteoptions) |
 
 #### Returns
@@ -1810,7 +1809,7 @@ because storage selections are flat multi-row affairs.
 ### useStorageList()
 
 ```ts
-function useStorageList(storage: any, path: string): UseStorageListResult;
+function useStorageList(storage: FirebaseStorage, path: string): UseStorageListResult;
 ```
 
 List the objects + synthetic folders directly under `path` :
@@ -1826,7 +1825,7 @@ result (virtualize the rendering, which `<ObjectBrowser>` does).
 
 | Parameter | Type |
 | :------ | :------ |
-| `storage` | `any` |
+| `storage` | [`FirebaseStorage`](pyric-storage-reference-api.md#firebasestorage) |
 | `path` | `string` |
 
 #### Returns
@@ -1840,7 +1839,7 @@ result (virtualize the rendering, which `<ObjectBrowser>` does).
 ### useStorageObject()
 
 ```ts
-function useStorageObject(storage: any, path: string): UseStorageObjectResult;
+function useStorageObject(storage: FirebaseStorage, path: string): UseStorageObjectResult;
 ```
 
 One object's metadata + lazily-loaded bytes, the data source for
@@ -1851,7 +1850,7 @@ half: updates on `refresh`, `path` change, or `loadBlob`.
 
 | Parameter | Type |
 | :------ | :------ |
-| `storage` | `any` |
+| `storage` | [`FirebaseStorage`](pyric-storage-reference-api.md#firebasestorage) |
 | `path` | `string` |
 
 #### Returns
@@ -1865,7 +1864,7 @@ half: updates on `refresh`, `path` change, or `loadBlob`.
 ### useStorageRulesGate()
 
 ```ts
-function useStorageRulesGate(storage: any, options?: UseStorageRulesGateOptions): UseStorageRulesGateResult;
+function useStorageRulesGate(storage: FirebaseStorage, options?: UseStorageRulesGateOptions): UseStorageRulesGateResult;
 ```
 
 Pre-flight rules evaluation — the M7 differentiator. Evaluates the
@@ -1892,7 +1891,7 @@ common identity/path/payload-shaped rules evaluate exactly.
 
 | Parameter | Type |
 | :------ | :------ |
-| `storage` | `any` |
+| `storage` | [`FirebaseStorage`](pyric-storage-reference-api.md#firebasestorage) |
 | `options?` | [`UseStorageRulesGateOptions`](#usestoragerulesgateoptions) |
 
 #### Returns