@junobuild/core-peer 0.0.14 → 0.0.15

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

@@ -1,35 +1,149 @@
 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
+ * @extends {Pick<ListResults<AssetNoContent>, 'items_length' | 'items_page' | 'matches_length' | 'matches_pages'>}
+ */
 export interface Assets extends Pick<ListResults<AssetNoContent>, 'items_length' | 'items_page' | 'matches_length' | 'matches_pages'> {
+    /**
+     * The collection of assets.
+     * @type {Asset[]}
+     */
     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/dist/types/types/subscription.types.d.ts

@@ -1 +1,6 @@
+/**
+ * Represents a function that unsubscribes from an event or a subscription.
+ * @typedef {Function} Unsubscribe
+ * @returns {void}
+ */
 export type Unsubscribe = () => void;

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

@@ -0,0 +1,2 @@
+export declare const envSatelliteId: () => string | undefined;
+export declare const envContainer: () => string | undefined;

package/package.json

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