@junobuild/core-peer 0.0.14 → 0.0.16

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import type { User } from './types/auth.types';
-import type { Environment } from './types/env.types';
+import type { UserEnvironment } from './types/env.types';
 import type { Unsubscribe } from './types/subscription.types';
 export * from './providers/auth.providers';
 export { signIn, signOut, unsafeIdentity } from './services/auth.services';
@@ -12,5 +12,24 @@ export { ListOrder, ListPaginate, ListParams, ListResults } from './types/list.t
 export * from './types/satellite.types';
 export * from './types/storage.types';
 export * from './types/subscription.types';
-export declare const initJuno: (env: Environment) => Promise<Unsubscribe[]>;
+/**
+ * Initializes Juno with the provided optional environment parameters.
+ * If no environment is provided, the variables injected by the Vite or NextJS plugins will be used.
+ * @deprecated Use {@link initSatellite} instead.
+ * @param {UserEnvironment} [userEnv] - The optional user environment configuration.
+ * @returns {Promise<Unsubscribe[]>} A promise that resolves to an array of unsubscribe functions.
+ */
+export declare const initJuno: (userEnv?: UserEnvironment) => Promise<Unsubscribe[]>;
+/**
+ * Initializes a Juno satellite with the provided optional environment parameters.
+ * If no environment is provided, the variables injected by the Vite or NextJS plugins will be used.
+ * @param {UserEnvironment} [userEnv] - The optional user environment configuration.
+ * @returns {Promise<Unsubscribe[]>} A promise that resolves to an array of unsubscribe functions.
+ */
+export declare const initSatellite: (userEnv?: UserEnvironment) => Promise<Unsubscribe[]>;
+/**
+ * Subscribes to authentication state changes. i.e. each time a user signs in or signs out, the callback will be triggered.
+ * @param {function(User | null): void} callback - The callback function to execute when the authentication state changes.
+ * @returns {Unsubscribe} A function to unsubscribe from the authentication state changes.
+ */
 export declare const authSubscribe: (callback: (authUser: User | null) => void) => Unsubscribe;

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

@@ -1,21 +1,79 @@
 import type { InternetIdentityConfig, NFIDConfig, Provider, SignInOptions } from '../types/auth.types';
+/**
+ * Options for signing in with an authentication provider.
+ * @interface AuthProviderSignInOptions
+ */
 export interface AuthProviderSignInOptions {
+    /**
+     * The URL of the identity provider - commonly Internet Identity.
+     */
     identityProvider: string;
+    /**
+     * Optional features for the window opener.
+     */
     windowOpenerFeatures?: string;
 }
+/**
+ * Common traits for all authentication providers
+ * @interface AuthProvider
+ */
 export interface AuthProvider {
+    /**
+     * The unique identifier of the provider.
+     */
     readonly id: Provider;
+    /**
+     * Method to get the sign-in options for the provider.
+     * @param options - The sign-in options.
+     * @returns The sign-in options for the provider that can be use to effectively perform a sign-in.
+     */
     signInOptions: (options: Pick<SignInOptions, 'windowed'>) => AuthProviderSignInOptions;
 }
+/**
+ * Internet Identity authentication provider.
+ * @class InternetIdentityProvider
+ * @implements {AuthProvider}
+ */
 export declare class InternetIdentityProvider implements AuthProvider {
     #private;
+    /**
+     * Creates an instance of InternetIdentityProvider.
+     * @param {InternetIdentityConfig} config - The configuration for Internet Identity.
+     */
     constructor({ domain }: InternetIdentityConfig);
+    /**
+     * Gets the identifier of the provider.
+     * @returns {Provider} The identifier of the provider - `internet_identity`.
+     */
     get id(): Provider;
+    /**
+     * Gets the sign-in options for Internet Identity.
+     * @param {Pick<SignInOptions, 'windowed'>} options - The sign-in options.
+     * @returns {AuthProviderSignInOptions} The sign-in options for Internet Identity.
+     */
     signInOptions({ windowed }: Pick<SignInOptions, 'windowed'>): AuthProviderSignInOptions;
 }
+/**
+ * NFID authentication provider.
+ * @class NFIDProvider
+ * @implements {AuthProvider}
+ */
 export declare class NFIDProvider implements AuthProvider {
     #private;
+    /**
+     * Creates an instance of NFIDProvider.
+     * @param {NFIDConfig} config - The configuration for NFID.
+     */
     constructor({ appName, logoUrl }: NFIDConfig);
+    /**
+     * Gets the identifier of the provider.
+     * @returns {Provider} The identifier of the provider- nfid.
+     */
     get id(): Provider;
+    /**
+     * Gets the sign-in options for NFID.
+     * @param {Pick<SignInOptions, 'windowed'>} options - The sign-in options.
+     * @returns {AuthProviderSignInOptions} The sign-in options to effectively sign-in with NFID.
+     */
     signInOptions({ windowed }: Pick<SignInOptions, 'windowed'>): AuthProviderSignInOptions;
 }

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

@@ -1,11 +1,23 @@
 import type { Identity } from '@dfinity/agent';
 import type { Provider, SignInOptions } from '../types/auth.types';
 export declare const initAuth: (provider?: Provider) => Promise<void>;
+/**
+ * Signs in a user with the specified options.
+ * @param {SignInOptions} [options] - The options for signing in.
+ * @returns {Promise<void>} A promise that resolves when the sign-in process is complete and the authenticated user is initialized.
+ * @throws Will throw an error if the sign-in process fails.
+ */
 export declare const signIn: (options?: SignInOptions) => Promise<void>;
+/**
+ * Signs out the current user.
+ * @returns {Promise<void>} A promise that resolves when the sign-out process is complete.
+ */
 export declare const signOut: () => Promise<void>;
 export declare const getIdentity: () => Identity | undefined;
 /**
- * Return what can be the identity of a sign-in user or an anonymous identity.
- * Useful to load an identity in web workers.
+ * Returns the identity of a signed-in user or an anonymous identity.
+ * This function is useful for loading an identity in web workers.
+ * Used to imperatively get the identity. Please be certain before using it.
+ * @returns {Promise<Identity>} A promise that resolves to the identity of the user or an anonymous identity.
  */
 export declare const unsafeIdentity: () => Promise<Identity>;

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

@@ -1,21 +1,53 @@
 import type { Doc } from '../types/doc.types';
 import type { ListParams, ListResults } from '../types/list.types';
 import type { SatelliteOptions } from '../types/satellite.types';
+/**
+ * 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.
+ * @returns {Promise<Doc<D> | undefined>} A promise that resolves to the document or undefined if not found.
+ */
 export declare const getDoc: <D>({ satellite, ...rest }: {
     collection: string;
     satellite?: SatelliteOptions;
 } & 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).
+ * @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 }: {
     docs: ({
         collection: string;
     } & Pick<Doc<any>, 'key'>)[];
     satellite?: SatelliteOptions;
 }) => 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).
+ * @returns {Promise<Doc<D>>} A promise that resolves to the added or updated document.
+ */
 export declare const setDoc: <D>({ satellite, ...rest }: {
     collection: string;
     doc: Doc<D>;
     satellite?: SatelliteOptions;
 }) => 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).
+ * @returns {Promise<Array<Doc<any>>>} A promise that resolves to an array of added or updated documents.
+ */
 export declare const setManyDocs: ({ satellite, ...rest }: {
     docs: {
         collection: string;
@@ -23,11 +55,27 @@ export declare const setManyDocs: ({ satellite, ...rest }: {
     }[];
     satellite?: SatelliteOptions;
 }) => 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).
+ * @returns {Promise<void>} A promise that resolves when the document is deleted.
+ */
 export declare const deleteDoc: <D>({ satellite, ...rest }: {
     collection: string;
     doc: Doc<D>;
     satellite?: SatelliteOptions;
 }) => 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).
+ * @returns {Promise<void>} A promise that resolves when the documents are deleted.
+ */
 export declare const deleteManyDocs: ({ satellite, ...rest }: {
     docs: {
         collection: string;
@@ -35,6 +83,15 @@ export declare const deleteManyDocs: ({ satellite, ...rest }: {
     }[];
     satellite?: SatelliteOptions;
 }) => 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).
+ * @returns {Promise<ListResults<Doc<D>>>} A promise that resolves to the list of documents.
+ */
 export declare const listDocs: <D>({ satellite, filter, ...rest }: {
     collection: string;
     filter?: ListParams;

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

@@ -2,33 +2,81 @@ import type { AssetNoContent } from '../../declarations/satellite/satellite.did'
 import type { ListParams } from '../types/list.types';
 import type { SatelliteOptions } from '../types/satellite.types';
 import type { AssetKey, Assets, Storage } 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.
+ * @returns {Promise<AssetKey>} A promise that resolves to the asset key.
+ */
 export declare const uploadBlob: (params: Storage & {
     satellite?: SatelliteOptions;
 }) => 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.
+ * @returns {Promise<AssetKey>} A promise that resolves to the asset key.
+ */
 export declare const uploadFile: (params: Partial<Pick<Storage, 'filename'>> & Omit<Storage, 'filename' | 'data'> & {
     data: File;
 } & {
     satellite?: SatelliteOptions;
 }) => 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.
+ * @returns {Promise<Assets>} A promise that resolves to the list of assets.
+ */
 export declare const listAssets: ({ collection, satellite: satelliteOptions, filter }: {
     collection: string;
     satellite?: SatelliteOptions;
     filter?: ListParams;
 }) => Promise<Assets>;
+/**
+ * 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.
+ * @returns {Promise<void>} A promise that resolves when the asset is deleted.
+ */
 export declare const deleteAsset: ({ collection, fullPath, satellite }: {
     collection: string;
     satellite?: SatelliteOptions;
 } & 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).
+ * @returns {Promise<void>} A promise that resolves when the assets are deleted.
+ */
 export declare const deleteManyAssets: ({ assets, satellite }: {
     assets: ({
         collection: string;
     } & Pick<AssetKey, 'fullPath'>)[];
     satellite?: SatelliteOptions;
 } & Pick<AssetKey, 'fullPath'>) => 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.
+ * @returns {Promise<AssetNoContent | undefined>} A promise that resolves to the asset or undefined if not found.
+ */
 export declare const getAsset: ({ satellite, ...rest }: {
     collection: string;
     satellite?: SatelliteOptions;
 } & 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).
+ * @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 }: {
     assets: ({
         collection: string;

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

@@ -1,22 +1,90 @@
 import type { InternetIdentityProvider, NFIDProvider } from '../providers/auth.providers';
 import type { Doc } from './doc.types';
+/**
+ * Type representing the available authentication providers.
+ * @typedef {('internet_identity' | 'nfid')} Provider
+ */
 export type Provider = 'internet_identity' | 'nfid';
+/**
+ * Interface representing user data.
+ * @interface UserData
+ */
 export interface UserData {
+    /**
+     * The potential provider used to sign-in. There is no guarantee that the information can be set by the browser during the sign-in flow, therefore it is optional.
+     * @type {Provider}
+     */
     provider?: Provider;
 }
+/**
+ * Type representing a user document.
+ * @typedef {Doc<UserData>} User
+ */
 export type User = Doc<UserData>;
+/**
+ * Interface representing sign-in options.
+ * @interface SignInOptions
+ */
 export interface SignInOptions {
+    /**
+     * Maximum time to live for the session. Cannot be extended.
+     * @type {bigint}
+     */
     maxTimeToLive?: bigint;
+    /**
+     * Origin for derivation. Useful when sign-in using the same domain - e.g. sign-in on www.hello.com for hello.com.
+     * @type {(string | URL)}
+     */
     derivationOrigin?: string | URL;
+    /**
+     * Whether to open the sign-in window.
+     * @default true
+     * @type {boolean}
+     */
     windowed?: boolean;
+    /**
+     * Whether to allow the infamous PIN authentication.
+     * @default false
+     * @type {boolean}
+     */
     allowPin?: boolean;
+    /**
+     * The authentication provider to use.
+     * @default InternetIdentityProvider
+     * @type {(InternetIdentityProvider | NFIDProvider)}
+     */
     provider?: InternetIdentityProvider | NFIDProvider;
 }
+/**
+ * Type representing the available Internet Identity domains.
+ * @typedef {('internetcomputer.org' | 'ic0.app')} InternetIdentityDomain
+ */
 export type InternetIdentityDomain = 'internetcomputer.org' | 'ic0.app';
+/**
+ * Interface representing the configuration for Internet Identity.
+ * @interface InternetIdentityConfig
+ */
 export interface InternetIdentityConfig {
+    /**
+     * The domain for Internet Identity.
+     * @default internetcomputer.org
+     * @type {InternetIdentityDomain}
+     */
     domain?: InternetIdentityDomain;
 }
+/**
+ * Interface representing the configuration for NFID.
+ * @interface NFIDConfig
+ */
 export interface NFIDConfig {
+    /**
+     * The name of the application.
+     * @type {string}
+     */
     appName: string;
+    /**
+     * The URL of the application's logo.
+     * @type {string}
+     */
     logoUrl: string;
 }

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

@@ -1,9 +1,42 @@
+/**
+ * Represents a document stored in a collection.
+ * @template D - The type of data contained in the document.
+ * @interface
+ */
 export interface Doc<D> {
+    /**
+     * The unique key identifying the document within the collection.
+     * @type {string}
+     */
     key: string;
+    /**
+     * An optional description of the document which can also be used to filter document when listing those.
+     * @type {string}
+     */
     description?: string;
+    /**
+     * The data contained in the document.
+     * @type {D}
+     */
     data: D;
+    /**
+     * The owner of the document.
+     * @type {string}
+     */
     owner?: string;
+    /**
+     * The timestamp when the document was created.
+     * @type {bigint}
+     */
     created_at?: bigint;
+    /**
+     * The timestamp when the document was last updated.
+     * @type {bigint}
+     */
     updated_at?: bigint;
+    /**
+     * The version of the document. When updating a document, the current version must be provided to ensure the correct document is updated.
+     * @type {bigint}
+     */
     version?: bigint;
 }

package/dist/types/types/env.types.d.ts

@@ -1,10 +1,43 @@
 import type { Satellite } from './satellite.types';
+/**
+ * Represents the path to a web worker.
+ * @typedef {string} EnvironmentWorkerPath
+ */
 export type EnvironmentWorkerPath = string;
+/**
+ * Represents a web worker which can be a enable for default path or provided with a specific path string.
+ * @typedef {true | EnvironmentWorkerPath} EnvironmentWorker
+ */
 export type EnvironmentWorker = true | EnvironmentWorkerPath;
+/**
+ * Represents the environment workers.
+ * @interface
+ */
 export interface EnvironmentWorkers {
+    /**
+     * The authentication worker configuration. A worker which takes cares of validating the session and if expired, triggers an event to ultimately logout the user automatically.
+     * @type {EnvironmentWorker}
+     */
     auth?: EnvironmentWorker;
 }
+/**
+ * The environment configuration.
+ * @typedef {Object} Environment
+ * @property {string} [internetIdentityId] - The optional Internet Identity ID. Generally not provided.
+ * @property {EnvironmentWorkers} [workers] - The optional web workers configuration.
+ * @property {string} satelliteId - The satellite ID (required).
+ * @property {string} [container] - The container. Commonly true to use local development with Docker.
+ */
 export type Environment = {
     internetIdentityId?: string;
     workers?: EnvironmentWorkers;
 } & Required<Pick<Satellite, 'satelliteId'>> & Pick<Satellite, 'container'>;
+/**
+ * Represents the user environment configuration. i.e. the optional parameters the user is providing to initialize Juno.
+ * @typedef {Object} UserEnvironment
+ * @property {string} [internetIdentityId] - The optional Internet Identity ID. Generally not provided.
+ * @property {EnvironmentWorkers} [workers] - The environment workers configuration.
+ * @property {string} satelliteId - An optional satellite ID. If not provided, the library tries to load the information injected by the Vite and NextJS plugins.
+ * @property {string} [container] - The container. If not provided, the library tries to load the information injected by the Vite and NextJS plugins.
+ */
+export type UserEnvironment = Omit<Environment, 'satelliteId'> & Pick<Satellite, 'satelliteId'>;

package/dist/types/types/list.types.d.ts

@@ -1,28 +1,117 @@
 import type { Principal } from '@dfinity/principal';
+/**
+ * Represents the results of a list call.
+ * @template T - The type of items in the list.
+ * @interface
+ */
 export interface ListResults<T> {
+    /**
+     * The data - e.g., the documents or assets depending on which list was called.
+     * @type {T[]}
+     */
     items: T[];
+    /**
+     * The number of items - basically items.length.
+     * @type {bigint}
+     */
     items_length: bigint;
+    /**
+     * If the query is paginated, the page number (starting from 0) where the items are found.
+     * @type {bigint}
+     */
     items_page?: bigint;
+    /**
+     * The total number of matching results.
+     * @type {bigint}
+     */
     matches_length: bigint;
+    /**
+     * If the query is paginated, the total number of pages (starting from 0).
+     * @type {bigint}
+     */
     matches_pages?: bigint;
 }
+/**
+ * Represents pagination parameters for a list call.
+ * @interface
+ */
 export interface ListPaginate {
+    /**
+     * The key to start after for pagination.
+     * @type {string}
+     */
     startAfter?: string;
+    /**
+     * The maximum number of items to return.
+     * @type {number}
+     */
     limit?: number;
 }
+/**
+ * Type representing the fields by which the list can be ordered.
+ * @typedef {('keys' | 'updated_at' | 'created_at')} ListOrderField
+ */
 export type ListOrderField = 'keys' | 'updated_at' | 'created_at';
+/**
+ * Represents the order parameters for a list cal.
+ * @interface
+ */
 export interface ListOrder {
+    /**
+     * Whether the order is descending.
+     * @type {boolean}
+     */
     desc: boolean;
+    /**
+     * The field by which to order the list.
+     * @type {ListOrderField}
+     */
     field: ListOrderField;
 }
+/**
+ * Type representing the owner of a list item, either a string or a Principal.
+ * @typedef {(string | Principal)} ListOwner
+ */
 export type ListOwner = string | Principal;
+/**
+ * Represents matching parameters for a list call.
+ * @interface
+ */
 export interface ListMatcher {
+    /**
+     * The key to match. Support Regex (must comply with Rust regex).
+     * @type {string}
+     */
     key?: string;
+    /**
+     * The description to match. Support Regex (must comply with Rust regex).
+     * @type {string}
+     */
     description?: string;
 }
+/**
+ * Represents the parameters for a list query.
+ * @interface
+ */
 export interface ListParams {
+    /**
+     * The matcher parameters for the query.
+     * @type {ListMatcher}
+     */
     matcher?: ListMatcher;
+    /**
+     * The pagination parameters for the query.
+     * @type {ListPaginate}
+     */
     paginate?: ListPaginate;
+    /**
+     * The order parameters for the query.
+     * @type {ListOrder}
+     */
     order?: ListOrder;
+    /**
+     * The owner of the items to match.
+     * @type {ListOwner}
+     */
     owner?: ListOwner;
 }

package/dist/types/types/satellite.types.d.ts

@@ -1,8 +1,32 @@
 import type { Identity } from '@dfinity/agent';
+/**
+ * Represents the configuration for a satellite.
+ * @interface
+ */
 export interface Satellite {
+    /**
+     * The identity associated with the satellite.
+     * @type {Identity}
+     */
     identity: Identity;
+    /**
+     * The unique identifier for the satellite.
+     * @type {string}
+     */
     satelliteId?: string;
+    /**
+     * A custom fetch function to use for network requests.
+     * @type {typeof fetch}
+     */
     fetch?: typeof fetch;
+    /**
+     * Specifies whether the satellite is running in a container or provides the container URL. i.e. URL to Docker local development.
+     * @type {boolean | string}
+     */
     container?: boolean | string;
 }
+/**
+ * Represents partial configuration options for a satellite. To be used only on NodeJS or rarely used for browser.
+ * @typedef {Partial<Satellite>} SatelliteOptions
+ */
 export type SatelliteOptions = Partial<Satellite>;