@junobuild/core-peer 0.1.16 → 0.1.17

package/dist/types/index.d.ts

@@ -3,7 +3,7 @@ import type { User } from './types/auth.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';
+export { getIdentityOnce, signIn, signOut, unsafeIdentity } from './services/auth.services';
 export * from './services/doc.services';
 export * from './services/factory.services';
 export * from './services/storage.services';

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

@@ -22,3 +22,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/storage.services.d.ts

@@ -113,15 +113,32 @@ export declare const getManyAssets: ({ satellite, ...rest }: {
     satellite?: SatelliteOptions;
 }) => Promise<(AssetNoContent | undefined)[]>;
 /**
- * Generates a download URL for a given asset.
+ * Returns a public URL for accessing a specific asset stored on a Satellite.
  *
- * @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).
+ * 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
  *
- * @returns {string} The generated download URL.
+ * ### Example
+ * ```ts
+ * const url = downloadUrl({
+ *   assetKey: {
+ *     fullPath: '/images/logo.png',
+ *   }
+ * });
+ *
+ * // Usage in an <img> tag
+ * <img src={url} alt="Logo" />
+ * ```
+ *
+ * @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] - Required only in Node.js environments to specify which Satellite to use.
+ *
+ * @returns {string} A full URL pointing to the asset.
  */
 export declare const downloadUrl: ({ assetKey: { fullPath, token }, satellite: satelliteOptions }: {
     assetKey: Pick<Asset, "fullPath" | "token">;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/core-peer",
-  "version": "0.1.16",
+  "version": "0.1.17",
   "description": "JavaScript core client for Juno minus DFINITY agent-js dependencies",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",