@junobuild/core-peer 0.0.18 → 0.0.20

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

@@ -1,7 +1,8 @@
+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 { AssetKey, Assets, Storage } from '../types/storage.types';
+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.
@@ -83,3 +84,19 @@ export declare const getManyAssets: ({ satellite, ...rest }: {
     } & Pick<AssetKey, 'fullPath'>)[];
     satellite?: SatelliteOptions;
 }) => Promise<(AssetNoContent | undefined)[]>;
+/**
+ * Generates a download URL for a given asset.
+ *
+ * @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).
+ *
+ * @returns {string} The generated download URL.
+ */
+export declare const downloadUrl: ({ assetKey: { fullPath, token }, satellite: satelliteOptions }: {
+    assetKey: Pick<Asset, 'fullPath' | 'token'>;
+} & {
+    satellite?: SatelliteOptions;
+}) => string;

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

@@ -1,94 +1,6 @@
+import type { Asset } from '@junobuild/storage';
 import type { AssetNoContent } from '../../declarations/satellite/satellite.did';
 import type { ListResults } from './list.types';
-/**
- * Represents the encoding details of an asset.
- * @interface
- */
-export interface AssetEncoding {
-    /**
-     * The timestamp when the encoding was modified.
-     * @type {bigint}
-     */
-    modified: bigint;
-    /**
-     * The SHA-256 hash of the encoding.
-     * @type {string}
-     */
-    sha256: string;
-    /**
-     * The total length of the encoding.
-     * @type {bigint}
-     */
-    total_length: bigint;
-}
-/**
- * Represents the key details of an asset.
- * @interface
- */
-export interface AssetKey {
-    /**
-     * The full path of the asset, i.e., URL.pathname. Except for the dApps assets (HTML, JS, etc.), the full path must start with `/collection/`.
-     * @type {string}
-     */
-    fullPath: string;
-    /**
-     * The name of the asset.
-     * @type {string}
-     */
-    name: string;
-    /**
-     * The download URL of the asset.
-     * @type {string}
-     */
-    downloadUrl: string;
-}
-/**
- * Type representing the possible encoding types.
- * @typedef {('identity' | 'gzip' | 'compress' | 'deflate' | 'br')} ENCODING_TYPE
- */
-export type ENCODING_TYPE = 'identity' | 'gzip' | 'compress' | 'deflate' | 'br';
-/**
- * Represents an asset with its key details, encodings, and metadata.
- * @interface
- * @extends {AssetKey}
- */
-export interface Asset extends AssetKey {
-    /**
-     * An optional description of the asset. A field which can be used to filter assets when listing those.
-     * @type {string}
-     */
-    description?: string;
-    /**
-     * An optional token associated with the asset. Tokens are used to protect assets on the web. If a token is provided, the asset is delivered on the web only if the query parameter `token` is provided with a matching value.
-     * @type {string}
-     */
-    token?: string;
-    /**
-     * The headers associated with the asset.
-     * @type {[string, string][]}
-     */
-    headers: [string, string][];
-    /**
-     * The encodings of the asset.
-     * @type {Record<ENCODING_TYPE, AssetEncoding>}
-     */
-    encodings: Record<ENCODING_TYPE, AssetEncoding>;
-    /**
-     * The owner of the asset.
-     * @type {string}
-     */
-    owner?: string;
-    /**
-     * The timestamp when the asset was created.
-     * @type {bigint}
-     */
-    created_at?: bigint;
-    /**
-     * The timestamp when the asset was last updated.
-     * @type {bigint}
-     */
-    updated_at?: bigint;
-}
 /**
  * Represents a collection of assets with pagination details.
  * @interface
@@ -107,49 +19,3 @@ export interface Assets extends Omit<ListResults<AssetNoContent>, 'items'> {
      */
     assets: Asset[];
 }
-/**
- * Represents the details required to store an asset.
- * @interface
- */
-export interface Storage {
-    /**
-     * The filename of the asset.
-     * @type {string}
-     */
-    filename: string;
-    /**
-     * The data of the asset.
-     * @type {Blob}
-     */
-    data: Blob;
-    /**
-     * The collection to which the asset belongs.
-     * @type {string}
-     */
-    collection: string;
-    /**
-     * The full path of the asset, i.e., URL.pathname. Except for the dApps assets (HTML, JS, etc.), the full path must start with `/collection/`.
-     * @type {string}
-     */
-    fullPath?: string;
-    /**
-     * The headers associated with the asset.
-     * @type {[string, string][]}
-     */
-    headers?: [string, string][];
-    /**
-     * An optional token associated with the asset.  Tokens are used to protect assets on the web. If a token is provided, the asset is delivered on the web only if the query parameter `token` is provided with a matching value.
-     * @type {string}
-     */
-    token?: string;
-    /**
-     * The encoding type of the asset.
-     * @type {ENCODING_TYPE}
-     */
-    encoding?: ENCODING_TYPE;
-    /**
-     * An optional description of the asset. A field which can be used to filter assets when listing those.
-     * @type {string}
-     */
-    description?: string;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/core-peer",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "description": "JavaScript core client for Juno minus DFINITY agent-js dependencies",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",
@@ -54,7 +54,8 @@
   ],
   "homepage": "https://juno.build",
   "dependencies": {
-    "@junobuild/utils": "*"
+    "@junobuild/utils": "*",
+    "@junobuild/storage": "*"
   },
   "peerDependencies": {
     "@dfinity/agent": "^1.3.0",