@junobuild/core-peer 0.1.16 → 1.0.0

package/dist/types/api/_actor.factory.d.ts

@@ -0,0 +1,5 @@
+import type { _SERVICE as SatelliteActor } from '../../declarations/satellite/satellite.did';
+import { idlFactory as idlFactorySatellite } from '../../declarations/satellite/satellite.factory.did.js';
+import { idlFactory as idlCertifiedFactorySatellite } from '../../declarations/satellite/satellite.factory.certified.did.js';
+import { idlFactory as idlFactorySputnik } from '../../declarations/sputnik/sputnik.factory.did.js';
+export { idlCertifiedFactorySatellite, idlFactorySatellite, idlFactorySputnik, type SatelliteActor };

package/dist/types/api/actor.api.d.ts

@@ -1,9 +1,12 @@
-import type { ActorSubclass } from '@dfinity/agent';
-import type { ActorMethod } from '@dfinity/agent/lib/esm/actor';
+import type { ActorMethod, ActorSubclass } from '@dfinity/agent';
 import type { IDL } from '@dfinity/candid';
-import type { _SERVICE as SatelliteActor } from '../../declarations/satellite/satellite.did';
-import type { Satellite } from '../types/satellite.types';
-export declare const getSatelliteActor: (satellite: Satellite) => Promise<SatelliteActor>;
-export declare const getSatelliteExtendedActor: <T = Record<string, ActorMethod>>({ idlFactory, ...rest }: Satellite & {
+import type { CallOptions } from '../types/call-options';
+import type { SatelliteContext } from '../types/satellite';
+import { type SatelliteActor } from './_actor.factory';
+export declare const getSatelliteActor: ({ satellite, options: { certified } }: {
+    satellite: SatelliteContext;
+    options: CallOptions;
+}) => Promise<SatelliteActor>;
+export declare const getSatelliteExtendedActor: <T = Record<string, ActorMethod>>({ idlFactory, ...rest }: SatelliteContext & {
     idlFactory: IDL.InterfaceFactory;
 }) => Promise<ActorSubclass<T>>;

package/dist/types/api/doc.api.d.ts

@@ -1,52 +1,43 @@
-import type { Doc } from '../types/doc.types';
-import type { ListParams, ListResults } from '../types/list.types';
-import type { Satellite } from '../types/satellite.types';
-export declare const getDoc: <D>({ collection, key, satellite }: {
+import type { ActorReadParams, ActorUpdateParams } from '../types/actor';
+import type { Doc } from '../types/doc';
+import type { ListParams, ListResults } from '../types/list';
+export declare const getDoc: <D>({ collection, key, ...rest }: {
     collection: string;
-    satellite: Satellite;
-} & Pick<Doc<D>, "key">) => Promise<Doc<D> | undefined>;
-export declare const getManyDocs: ({ docs, satellite }: {
+} & ActorReadParams & Pick<Doc<D>, "key">) => Promise<Doc<D> | undefined>;
+export declare const getManyDocs: ({ docs, ...rest }: {
     docs: ({
         collection: string;
     } & Pick<Doc<any>, "key">)[];
-    satellite: Satellite;
-}) => Promise<(Doc<any> | undefined)[]>;
-export declare const setDoc: <D>({ collection, doc, satellite }: {
+} & ActorReadParams) => Promise<(Doc<any> | undefined)[]>;
+export declare const setDoc: <D>({ collection, doc, ...rest }: {
     collection: string;
     doc: Doc<D>;
-    satellite: Satellite;
-}) => Promise<Doc<D>>;
-export declare const setManyDocs: ({ docs, satellite }: {
+} & ActorUpdateParams) => Promise<Doc<D>>;
+export declare const setManyDocs: ({ docs, ...rest }: {
     docs: {
         collection: string;
         doc: Doc<any>;
     }[];
-    satellite: Satellite;
-}) => Promise<Doc<any>[]>;
-export declare const deleteDoc: <D>({ collection, doc, satellite }: {
+} & ActorUpdateParams) => Promise<Doc<any>[]>;
+export declare const deleteDoc: <D>({ collection, doc, ...rest }: {
     collection: string;
     doc: Doc<D>;
-    satellite: Satellite;
-}) => Promise<void>;
-export declare const deleteManyDocs: ({ docs, satellite }: {
+} & ActorUpdateParams) => Promise<void>;
+export declare const deleteManyDocs: ({ docs, ...rest }: {
     docs: {
         collection: string;
         doc: Doc<any>;
     }[];
-    satellite: Satellite;
-}) => Promise<void>;
-export declare const deleteFilteredDocs: ({ collection, filter, satellite }: {
+} & ActorUpdateParams) => Promise<void>;
+export declare const deleteFilteredDocs: ({ collection, filter, ...rest }: {
     collection: string;
     filter: ListParams;
-    satellite: Satellite;
-}) => Promise<void>;
-export declare const listDocs: <D>({ collection, filter, satellite }: {
+} & ActorUpdateParams) => Promise<void>;
+export declare const listDocs: <D>({ collection, filter, ...rest }: {
     collection: string;
     filter: ListParams;
-    satellite: Satellite;
-}) => Promise<ListResults<Doc<D>>>;
-export declare const countDocs: ({ collection, filter, satellite }: {
+} & ActorReadParams) => Promise<ListResults<Doc<D>>>;
+export declare const countDocs: ({ collection, filter, ...rest }: {
     collection: string;
     filter: ListParams;
-    satellite: Satellite;
-}) => Promise<bigint>;
+} & ActorReadParams) => Promise<bigint>;

package/dist/types/api/storage.api.d.ts

@@ -1,42 +1,35 @@
 import { type AssetKey, type UploadAsset } from '@junobuild/storage';
 import type { AssetNoContent } from '../../declarations/satellite/satellite.did';
-import type { ListParams, ListResults } from '../types/list.types';
-import type { Satellite } from '../types/satellite.types';
-export declare const uploadAsset: ({ satellite, ...asset }: UploadAsset & {
-    satellite: Satellite;
-}) => Promise<void>;
-export declare const listAssets: ({ collection, satellite, filter }: {
+import type { ActorReadParams, ActorUpdateParams } from '../types/actor';
+import type { ListParams, ListResults } from '../types/list';
+export declare const uploadAsset: ({ asset, ...rest }: {
+    asset: UploadAsset;
+} & ActorUpdateParams) => Promise<void>;
+export declare const listAssets: ({ collection, filter, ...rest }: {
     collection: string;
-    satellite: Satellite;
     filter: ListParams;
-}) => Promise<ListResults<AssetNoContent>>;
-export declare const countAssets: ({ collection, satellite, filter }: {
+} & ActorReadParams) => Promise<ListResults<AssetNoContent>>;
+export declare const countAssets: ({ collection, filter, ...rest }: {
     collection: string;
-    satellite: Satellite;
     filter: ListParams;
-}) => Promise<bigint>;
-export declare const deleteAsset: ({ collection, fullPath, satellite }: {
+} & ActorReadParams) => Promise<bigint>;
+export declare const deleteAsset: ({ collection, fullPath, ...rest }: {
     collection: string;
-    satellite: Satellite;
-} & Pick<AssetKey, "fullPath">) => Promise<void>;
+} & ActorUpdateParams & Pick<AssetKey, "fullPath">) => Promise<void>;
 export declare const deleteManyAssets: ({ assets, satellite }: {
     assets: ({
         collection: string;
     } & Pick<AssetKey, "fullPath">)[];
-    satellite: Satellite;
-}) => Promise<void>;
-export declare const deleteFilteredAssets: ({ collection, satellite, filter }: {
+} & ActorUpdateParams) => Promise<void>;
+export declare const deleteFilteredAssets: ({ collection, filter, ...rest }: {
     collection: string;
-    satellite: Satellite;
     filter: ListParams;
-}) => Promise<void>;
-export declare const getAsset: ({ collection, fullPath, satellite }: {
+} & ActorUpdateParams) => Promise<void>;
+export declare const getAsset: ({ collection, fullPath, ...rest }: {
     collection: string;
-    satellite: Satellite;
-} & Pick<AssetKey, "fullPath">) => Promise<AssetNoContent | undefined>;
-export declare const getManyAssets: ({ assets, satellite }: {
+} & ActorReadParams & Pick<AssetKey, "fullPath">) => Promise<AssetNoContent | undefined>;
+export declare const getManyAssets: ({ assets, ...rest }: {
     assets: ({
         collection: string;
     } & Pick<AssetKey, "fullPath">)[];
-    satellite: Satellite;
-}) => Promise<(AssetNoContent | undefined)[]>;
+} & ActorReadParams) => Promise<(AssetNoContent | undefined)[]>;

package/dist/types/constants/call-options.constants.d.ts

@@ -0,0 +1,9 @@
+import type { ReadOptions } from '../types/call-options';
+/**
+ * Default options for read operations.
+ *
+ * For backwards compatibility and because most developers probably prioritize speed over
+ * additional security when fetching read-only data from the Internet Computer,
+ * read operations are performed in an uncertified way by default.
+ */
+export declare const DEFAULT_READ_OPTIONS: ReadOptions;

package/dist/types/index.d.ts

@@ -1,21 +1,21 @@
 import type { Asset, AssetEncoding, AssetKey, EncodingType, Storage } from '@junobuild/storage';
-import type { User } from './types/auth.types';
-import type { UserEnvironment } from './types/env.types';
-import type { Unsubscribe } from './types/subscription.types';
+import type { User } from './types/auth';
+import type { UserEnvironment } from './types/env';
+import type { Unsubscribe } from './types/subscription';
 export * from './providers/auth.providers';
-export { signIn, signOut, unsafeIdentity } from './services/auth.services';
+export { getIdentityOnce, signIn, signOut, unsafeIdentity } from './services/auth.services';
 export * from './services/doc.services';
-export * from './services/factory.services';
+export * from './services/functions.services';
 export * from './services/storage.services';
-export type * from './types/auth.types';
-export type * from './types/doc.types';
-export type * from './types/env.types';
-export * from './types/errors.types';
-export { ListOrder, ListPaginate, ListParams, ListResults } from './types/list.types';
-export type * from './types/satellite.types';
+export type * from './types/auth';
+export type * from './types/doc';
+export type * from './types/env';
+export * from './types/errors';
+export { ListOrder, ListPaginate, ListParams, ListResults } from './types/list';
+export type * from './types/satellite';
 export type * from './types/storage.types';
-export type * from './types/subscription.types';
-export type * from './types/utility.types';
+export type * from './types/subscription';
+export type * from './types/utility';
 export type { Asset, AssetEncoding, AssetKey, EncodingType, Storage };
 /**
  * Initializes Juno with the provided optional environment parameters.

package/dist/types/providers/auth.providers.d.ts

@@ -1,4 +1,4 @@
-import type { InternetIdentityConfig, NFIDConfig, Provider, SignInOptions } from '../types/auth.types';
+import type { InternetIdentityConfig, NFIDConfig, Provider, SignInOptions } from '../types/auth';
 /**
  * Options for signing in with an authentication provider.
  * @interface AuthProviderSignInOptions

package/dist/types/services/_identity.services.d.ts

@@ -0,0 +1,2 @@
+import { type Identity } from '@dfinity/agent';
+export declare const getAnyIdentity: (identity?: Identity) => Identity;

package/dist/types/services/{user.services.d.ts → _user.services.d.ts}

@@ -1,2 +1,2 @@
-import type { Provider, User } from '../types/auth.types';
+import type { Provider, User } from '../types/auth';
 export declare const initUser: (provider?: Provider) => Promise<User>;

package/dist/types/services/auth-timout.services.d.ts

@@ -1,3 +1,3 @@
-import type { EnvironmentWorker } from '../types/env.types';
-import type { Unsubscribe } from '../types/subscription.types';
+import type { EnvironmentWorker } from '../types/env';
+import type { Unsubscribe } from '../types/subscription';
 export declare const initAuthTimeoutWorker: (auth: EnvironmentWorker) => Unsubscribe;

package/dist/types/services/auth.services.d.ts

@@ -1,5 +1,5 @@
 import type { Identity } from '@dfinity/agent';
-import type { Provider, SignInOptions } from '../types/auth.types';
+import type { Provider, SignInOptions } from '../types/auth';
 export declare const initAuth: (provider?: Provider) => Promise<void>;
 /**
  * Signs in a user with the specified options.
@@ -14,6 +14,10 @@ export declare const signIn: (options?: SignInOptions) => Promise<void>;
  * @returns {Promise<void>} A promise that resolves when the sign-out process is complete.
  */
 export declare const signOut: () => Promise<void>;
+/**
+ * ℹ️ Exposed for testing purpose only. Should not be leaked to consumer or used by the library.
+ */
+export declare const resetAuth: () => Promise<void>;
 export declare const getIdentity: () => Identity | undefined;
 /**
  * Returns the identity of a signed-in user or an anonymous identity.
@@ -22,3 +26,16 @@ export declare const getIdentity: () => Identity | undefined;
  * @returns {Promise<Identity>} A promise that resolves to the identity of the user or an anonymous identity.
  */
 export declare const unsafeIdentity: () => Promise<Identity>;
+/**
+ * Returns the current identity if the user is authenticated.
+ *
+ * ⚠️ Use this function imperatively only. Do **not** persist the identity in global state.
+ * It is intended for short-lived or one-time operations.
+ *
+ * Typical use case is to enable developers to implement custom features for the Internet Computer:
+ * - Passing the identity to temporarily create an actor or agent to call a canister
+ * - Signing a message or making a one-time authenticated call
+ *
+ * @returns The authenticated identity, or null if unavailable.
+ */
+export declare const getIdentityOnce: () => Promise<Identity | null>;

package/dist/types/services/doc.services.d.ts

@@ -1,39 +1,47 @@
-import type { Doc } from '../types/doc.types';
-import type { ListParams, ListResults } from '../types/list.types';
-import type { SatelliteOptions } from '../types/satellite.types';
+import type { ReadOptions } from '../types/call-options';
+import type { Doc } from '../types/doc';
+import type { ListParams, ListResults } from '../types/list';
+import type { SatelliteOptions } from '../types/satellite';
 /**
  * Retrieves a single document from a collection.
+ *
  * @template D
  * @param {Object} params - The parameters for retrieving the document.
  * @param {string} params.collection - The name of the collection.
- * @param {SatelliteOptions} [params.satellite] - Options for the satellite (useful for NodeJS usage only).
  * @param {string} params.key - The key of the document to retrieve.
+ * @param {ReadOptions} [params.options] - Call options controlling certification. Defaults to uncertified reads for performance unless specified.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<Doc<D> | undefined>} A promise that resolves to the document or undefined if not found.
  */
-export declare const getDoc: <D>({ satellite, ...rest }: {
+export declare const getDoc: <D>({ satellite, options, ...rest }: {
     collection: string;
     satellite?: SatelliteOptions;
+    options?: ReadOptions;
 } & Pick<Doc<D>, "key">) => Promise<Doc<D> | undefined>;
 /**
  * Retrieves multiple documents from a single or different collections in a single call.
+ *
  * @param {Object} params - The parameters for retrieving the documents.
  * @param {Array} params.docs - The list of documents with their collections and keys.
- * @param {SatelliteOptions} [params.satellite] - Options for the satellite (useful for NodeJS usage only).
+ * @param {ReadOptions} [params.options] - Call options controlling certification. Defaults to uncertified reads for performance unless specified.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<Array<Doc<any> | undefined>>} A promise that resolves to an array of documents or undefined if not found.
  */
-export declare const getManyDocs: ({ satellite, ...rest }: {
+export declare const getManyDocs: ({ satellite, options, ...rest }: {
     docs: ({
         collection: string;
     } & Pick<Doc<any>, "key">)[];
     satellite?: SatelliteOptions;
+    options?: ReadOptions;
 }) => Promise<(Doc<any> | undefined)[]>;
 /**
  * Adds or updates a single document in a collection.
+ *
  * @template D
  * @param {Object} params - The parameters for adding or updating the document.
  * @param {string} params.collection - The name of the collection.
  * @param {Doc<D>} params.doc - The document to add or update.
- * @param {SatelliteOptions} [params.satellite] - Options for the satellite (useful for NodeJS usage only).
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<Doc<D>>} A promise that resolves to the added or updated document.
  */
 export declare const setDoc: <D>({ satellite, ...rest }: {
@@ -43,9 +51,10 @@ export declare const setDoc: <D>({ satellite, ...rest }: {
 }) => Promise<Doc<D>>;
 /**
  * Adds or updates multiple documents in a or different collections.
+ *
  * @param {Object} params - The parameters for adding or updating the documents.
  * @param {Array} params.docs - The list of documents with their collections and data.
- * @param {SatelliteOptions} [params.satellite] - Options for the satellite (useful for NodeJS usage only).
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<Array<Doc<any>>>} A promise that resolves to an array of added or updated documents.
  */
 export declare const setManyDocs: ({ satellite, ...rest }: {
@@ -57,11 +66,12 @@ export declare const setManyDocs: ({ satellite, ...rest }: {
 }) => Promise<Doc<any>[]>;
 /**
  * Deletes a single document from a collection.
+ *
  * @template D
  * @param {Object} params - The parameters for deleting the document.
  * @param {string} params.collection - The name of the collection.
  * @param {Doc<D>} params.doc - The document to delete.
- * @param {SatelliteOptions} [params.satellite] - Options for the satellite (useful for NodeJS usage only).
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<void>} A promise that resolves when the document is deleted.
  */
 export declare const deleteDoc: <D>({ satellite, ...rest }: {
@@ -71,9 +81,10 @@ export declare const deleteDoc: <D>({ satellite, ...rest }: {
 }) => Promise<void>;
 /**
  * Deletes multiple documents from a or different collections.
+ *
  * @param {Object} params - The parameters for deleting the documents.
  * @param {Array} params.docs - The list of documents with their collections and data.
- * @param {SatelliteOptions} [params.satellite] - Options for the satellite (useful for NodeJS usage only).
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<void>} A promise that resolves when the documents are deleted.
  */
 export declare const deleteManyDocs: ({ satellite, ...rest }: {
@@ -89,8 +100,7 @@ export declare const deleteManyDocs: ({ satellite, ...rest }: {
  * @param {Object} params - The parameters for deleting documents.
  * @param {string} params.collection - The name of the collection.
  * @param {ListParams} [params.filter] - The filter criteria to match documents for deletion.
- * @param {SatelliteOptions} [params.satellite] - Options for the satellite (useful for NodeJS usage only).
- *
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<void>} A promise that resolves when the documents are deleted.
  */
 export declare const deleteFilteredDocs: ({ satellite, filter, ...rest }: {
@@ -100,28 +110,34 @@ export declare const deleteFilteredDocs: ({ satellite, filter, ...rest }: {
 }) => Promise<void>;
 /**
  * Lists documents in a collection with optional filtering.
+ *
  * @template D
  * @param {Object} params - The parameters for listing the documents.
  * @param {string} params.collection - The name of the collection.
  * @param {ListParams} [params.filter] - Optional filter parameters.
- * @param {SatelliteOptions} [params.satellite] - Options for the satellite (useful for NodeJS usage only).
+ * @param {ReadOptions} [params.options] - Call options controlling certification. Defaults to uncertified reads for performance unless specified.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<ListResults<Doc<D>>>} A promise that resolves to the list of documents.
  */
-export declare const listDocs: <D>({ satellite, filter, ...rest }: {
+export declare const listDocs: <D>({ satellite, options, filter, ...rest }: {
     collection: string;
     filter?: ListParams;
     satellite?: SatelliteOptions;
+    options?: ReadOptions;
 }) => Promise<ListResults<Doc<D>>>;
 /**
  * Counts documents in a collection with optional filtering.
+ *
  * @param {Object} params - The parameters for counting the documents.
  * @param {string} params.collection - The name of the collection.
  * @param {ListParams} [params.filter] - Optional filter parameters.
- * @param {SatelliteOptions} [params.satellite] - Options for the satellite (useful for NodeJS usage only).
+ * @param {ReadOptions} [params.options] - Call options controlling certification. Defaults to uncertified reads for performance unless specified.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<bigint>} A promise that resolves to the count of documents as a bigint.
  */
-export declare const countDocs: ({ satellite, filter, ...rest }: {
+export declare const countDocs: ({ satellite, options, filter, ...rest }: {
     collection: string;
     filter?: ListParams;
     satellite?: SatelliteOptions;
+    options?: ReadOptions;
 }) => Promise<bigint>;

package/dist/types/services/functions.services.d.ts

@@ -0,0 +1,26 @@
+import type { ActorSubclass } from '@dfinity/agent';
+import type { ActorMethod } from '@dfinity/agent/lib/esm/actor';
+import type { IDL } from '@dfinity/candid';
+import type { SatelliteOptions } from '../types/satellite';
+/**
+ * Returns an extended satellite actor instance using the provided IDL factory and satellite options.
+ *
+ * This function is intended for advanced use cases where developers have implemented
+ * custom endpoints in their serverless functions using the extended build type.
+ *
+ * In most cases, developers should not need to call this directly.
+ * Extended actors are typically mapped and handled automatically.
+ *
+ * @template T - The actor interface type.
+ *
+ * @param {Object} params - The parameters for creating the actor.
+ * @param {IDL.InterfaceFactory} params.idlFactory - The IDL factory defining the custom actor interface.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only.
+ * In browser environments, configuration is automatically inherited from `initSatellite()`.
+ *
+ * @returns {Promise<ActorSubclass<T>>} A promise that resolves to the extended actor instance.
+ */
+export declare const getSatelliteExtendedActor: <T = Record<string, ActorMethod>>({ idlFactory, satellite }: {
+    idlFactory: IDL.InterfaceFactory;
+    satellite?: SatelliteOptions;
+}) => Promise<ActorSubclass<T>>;

package/dist/types/services/storage.services.d.ts

@@ -1,11 +1,13 @@
 import type { Asset, AssetKey, Storage } from '@junobuild/storage';
 import type { AssetNoContent } from '../../declarations/satellite/satellite.did';
-import type { ListParams } from '../types/list.types';
-import type { SatelliteOptions } from '../types/satellite.types';
+import type { ReadOptions } from '../types/call-options';
+import type { ListParams } from '../types/list';
+import type { SatelliteOptions } from '../types/satellite';
 import type { Assets } from '../types/storage.types';
 /**
  * Uploads a blob to the storage.
- * @param {Storage & {satellite?: SatelliteOptions}} params - The storage parameters. Satellite options are required only in NodeJS environment.
+ *
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<AssetKey>} A promise that resolves to the asset key.
  */
 export declare const uploadBlob: (params: Storage & {
@@ -13,7 +15,8 @@ export declare const uploadBlob: (params: Storage & {
 }) => Promise<AssetKey>;
 /**
  * Uploads a file to the storage.
- * @param {Partial<Pick<Storage, 'filename'>> & Omit<Storage, 'filename' | 'data'> & {data: File} & {satellite?: SatelliteOptions}} params - The storage parameters. Satellite options are required only in NodeJS environment.
+ *
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<AssetKey>} A promise that resolves to the asset key.
  */
 export declare const uploadFile: (params: Partial<Pick<Storage, "filename">> & Omit<Storage, "filename" | "data"> & {
@@ -23,36 +26,43 @@ export declare const uploadFile: (params: Partial<Pick<Storage, "filename">> & O
 }) => Promise<AssetKey>;
 /**
  * Lists assets in a collection with optional filtering.
+ *
  * @param {Object} params - The parameters for listing the assets.
  * @param {string} params.collection - The name of the collection.
- * @param {SatelliteOptions} [params.satellite] - The satellite options (required only in NodeJS environment).
  * @param {ListParams} [params.filter] - The filter parameters.
+ * @param {ReadOptions} [params.options] - Call options controlling certification. Defaults to uncertified reads for performance unless specified.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<Assets>} A promise that resolves to the list of assets.
  */
-export declare const listAssets: ({ collection, satellite: satelliteOptions, filter }: {
+export declare const listAssets: ({ collection, filter, satellite: satelliteOptions, options }: {
     collection: string;
-    satellite?: SatelliteOptions;
     filter?: ListParams;
+    satellite?: SatelliteOptions;
+    options?: ReadOptions;
 }) => Promise<Assets>;
 /**
  * Counts assets in a collection with optional filtering.
+ *
  * @param {Object} params - The parameters for counting the assets.
  * @param {string} params.collection - The name of the collection.
- * @param {SatelliteOptions} [params.satellite] - The satellite options (required only in NodeJS environment).
  * @param {ListParams} [params.filter] - The filter parameters for narrowing down the count.
+ * @param {ReadOptions} [params.options] - Call options controlling certification. Defaults to uncertified reads for performance unless specified.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<bigint>} A promise that resolves to the count of assets as a bigint.
  */
-export declare const countAssets: ({ collection, satellite: satelliteOptions, filter }: {
+export declare const countAssets: ({ collection, filter, satellite: satelliteOptions, options }: {
     collection: string;
-    satellite?: SatelliteOptions;
     filter?: ListParams;
+    satellite?: SatelliteOptions;
+    options?: ReadOptions;
 }) => Promise<bigint>;
 /**
  * Deletes an asset from the storage.
+ *
  * @param {Object} params - The parameters for deleting the asset.
  * @param {string} params.collection - The name of the collection.
- * @param {SatelliteOptions} [params.satellite] - The satellite options (required only in NodeJS environment).
  * @param {string} params.fullPath - The full path of the asset.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<void>} A promise that resolves when the asset is deleted.
  */
 export declare const deleteAsset: ({ collection, fullPath, satellite }: {
@@ -61,9 +71,10 @@ export declare const deleteAsset: ({ collection, fullPath, satellite }: {
 } & Pick<AssetKey, "fullPath">) => Promise<void>;
 /**
  * Deletes multiple assets from the storage.
+ *
  * @param {Object} params - The parameters for deleting the assets.
  * @param {Array} params.assets - The list of assets with their collections and full paths.
- * @param {SatelliteOptions} [params.satellite] - The satellite options (required only in NodeJS environment).
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<void>} A promise that resolves when the assets are deleted.
  */
 export declare const deleteManyAssets: ({ assets, satellite }: {
@@ -71,15 +82,14 @@ export declare const deleteManyAssets: ({ assets, satellite }: {
         collection: string;
     } & Pick<AssetKey, "fullPath">)[];
     satellite?: SatelliteOptions;
-} & Pick<AssetKey, "fullPath">) => Promise<void>;
+}) => Promise<void>;
 /**
  * Deletes multiple assets from a collection based on filtering criteria.
  *
  * @param {Object} params - The parameters for deleting the assets.
  * @param {string} params.collection - The name of the collection from which to delete assets.
- * @param {SatelliteOptions} [params.satellite] - The satellite options (required only in NodeJS environment).
  * @param {ListParams} [params.filter] - The filter criteria to match assets for deletion.
- *
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<void>} A promise that resolves when the assets matching the filter criteria are deleted.
  */
 export declare const deleteFilteredAssets: ({ collection, satellite: satelliteOptions, filter }: {
@@ -89,39 +99,61 @@ export declare const deleteFilteredAssets: ({ collection, satellite: satelliteOp
 }) => Promise<void>;
 /**
  * Retrieves an asset from the storage.
+ *
  * @param {Object} params - The parameters for retrieving the asset.
  * @param {string} params.collection - The name of the collection.
- * @param {SatelliteOptions} [params.satellite] - The satellite options (required only in NodeJS environment).
  * @param {string} params.fullPath - The full path of the asset.
+ * @param {ReadOptions} [params.options] - Call options controlling certification. Defaults to uncertified reads for performance unless specified.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<AssetNoContent | undefined>} A promise that resolves to the asset or undefined if not found.
  */
-export declare const getAsset: ({ satellite, ...rest }: {
+export declare const getAsset: ({ satellite, options, ...rest }: {
     collection: string;
     satellite?: SatelliteOptions;
+    options?: ReadOptions;
 } & Pick<AssetKey, "fullPath">) => Promise<AssetNoContent | undefined>;
 /**
  * Retrieves multiple assets from the storage.
+ *
  * @param {Object} params - The parameters for retrieving the assets.
  * @param {Array} params.assets - The list of assets with their collections and full paths.
- * @param {SatelliteOptions} [params.satellite] - The satellite options (required only in NodeJS environment).
+ * @param {ReadOptions} [params.options] - Call options controlling certification. Defaults to uncertified reads for performance unless specified.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
  * @returns {Promise<Array<AssetNoContent | undefined>>} A promise that resolves to an array of assets or undefined if not found.
  */
-export declare const getManyAssets: ({ satellite, ...rest }: {
+export declare const getManyAssets: ({ satellite, options, ...rest }: {
     assets: ({
         collection: string;
     } & Pick<AssetKey, "fullPath">)[];
     satellite?: SatelliteOptions;
+    options?: ReadOptions;
 }) => Promise<(AssetNoContent | undefined)[]>;
 /**
- * Generates a download URL for a given asset.
+ * Returns a public URL for accessing a specific asset stored on a Satellite.
+ *
+ * This URL can be used to:
+ * - Open the file directly in a browser
+ * - Embed the asset in HTML elements like `<img src="...">`, `<video src="...">`, or `<a href="...">`
+ * - Programmatically download or display the asset in your application
+ *
+ * ### Example
+ * ```ts
+ * const url = downloadUrl({
+ *   assetKey: {
+ *     fullPath: '/images/logo.png',
+ *   }
+ * });
  *
- * @param {Object} params - The parameters for generating the download URL.
- * @param {Object} params.assetKey - The key details of the asset.
- * @param {string} params.assetKey.fullPath - The full path of the asset.
- * @param {string} params.assetKey.token - The access token for the asset.
- * @param {SatelliteOptions} [params.satellite] -  The satellite options (required only in NodeJS environment).
+ * // Usage in an <img> tag
+ * <img src={url} alt="Logo" />
+ * ```
  *
- * @returns {string} The generated download URL.
+ * @param {Object} params - Parameters for generating the URL.
+ * @param {Object} params.assetKey - Identifies the asset to generate the URL for.
+ * @param {string} params.assetKey.fullPath - The full path of the asset (e.g., `/folder/file.jpg`).
+ * @param {string} [params.assetKey.token] - Optional access token for accessing protected assets.
+ * @param {SatelliteOptions} [params.satellite] - Options to specify a satellite in a NodeJS environment only. In browser environments, the satellite configuration is inherited from the initialization through `initSatellite()`.
+ * @returns {string} A full URL pointing to the asset.
  */
 export declare const downloadUrl: ({ assetKey: { fullPath, token }, satellite: satelliteOptions }: {
     assetKey: Pick<Asset, "fullPath" | "token">;

package/dist/types/stores/_agent.factory.d.ts

@@ -0,0 +1,4 @@
+import { HttpAgent } from '@dfinity/agent';
+import type { SatelliteContext } from '../types/satellite';
+export type CreateAgentParams = Required<Pick<SatelliteContext, 'identity'>> & Pick<SatelliteContext, 'container'>;
+export declare const createAgent: ({ identity, container }: CreateAgentParams) => Promise<HttpAgent>;