@junobuild/core-peer 0.1.17 → 1.0.0

package/dist/types/stores/agent.store.d.ts

@@ -1,13 +1,10 @@
-import { type Agent } from '@dfinity/agent';
-import type { Satellite } from '../types/satellite.types';
-type AgentParams = Required<Pick<Satellite, 'identity'>> & Pick<Satellite, 'container'>;
+import type { Agent } from '@dfinity/agent';
+import { type CreateAgentParams } from './_agent.factory';
 export declare class AgentStore {
     #private;
     private static instance;
     private constructor();
     static getInstance(): AgentStore;
-    getAgent({ identity, ...rest }: AgentParams): Promise<Agent>;
+    getAgent({ identity, ...rest }: CreateAgentParams): Promise<Agent>;
     reset(): void;
-    private createAgent;
 }
-export {};

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

@@ -1,6 +1,6 @@
-import type { User } from '../types/auth.types';
-import type { Unsubscribe } from '../types/subscription.types';
-import { Store } from './store';
+import type { User } from '../types/auth';
+import type { Unsubscribe } from '../types/subscription';
+import { Store } from './_store';
 export declare class AuthStore extends Store<User | null> {
     private static instance;
     private authUser;

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

@@ -1,11 +1,12 @@
-import type { Environment } from '../types/env.types';
-import { Store } from './store';
+import type { Environment } from '../types/env';
+import { Store } from './_store';
 export declare class EnvStore extends Store<Environment | undefined> {
     private static instance;
     private env;
     private constructor();
     static getInstance(): EnvStore;
     set(env: Environment | undefined): void;
-    get(): Environment | undefined;
+    get(): Environment | undefined | null;
+    reset(): void;
     subscribe(callback: (data: Environment | null | undefined) => void): () => void;
 }

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

@@ -0,0 +1,51 @@
+import type { ReadOptions, UpdateOptions } from './call-options';
+import type { SatelliteContext } from './satellite';
+/**
+ * Represents the type of build.
+ * @typedef {'stock' | 'extended'} BuildType
+ */
+export type BuildType = 'stock' | 'extended';
+/**
+ * Represents how read calls are handled by the actor.
+ *
+ * - `'update'`: Query endpoints are implemented as update calls to ensure certification.
+ * - `'query'`: Query endpoints use standard query calls without certification.
+ *
+ * @typedef {'update' | 'query'} ActorReadStrategy
+ */
+export type ActorReadStrategy = 'update' | 'query';
+/**
+ * Represents a unique key that identifies an actor configuration.
+ * Combines the build type and the read strategy.
+ *
+ * Example values:
+ * - `'stock#update'`
+ * - `'extended#query'`
+ *
+ * @typedef {`${BuildType}#${ActorReadStrategy}`} ActorKey
+ */
+export type ActorKey = `${BuildType}#${ActorReadStrategy}`;
+/**
+ * Parameters required to perform a read call using an actor.
+ *
+ * @property {SatelliteContext} satellite - The satellite configuration.
+ * @property {ReadOptions} options - Options controlling read call behavior, such as certification.
+ *
+ * @interface
+ */
+export interface ActorReadParams {
+    satellite: SatelliteContext;
+    options: ReadOptions;
+}
+/**
+ * Parameters required to perform an update call using an actor.
+ *
+ * @property {SatelliteContext} satellite - The satellite connection configuration.
+ * @property {UpdateOptions} options - Options controlling update call behavior. Certification is always enforced.
+ *
+ * @interface
+ */
+export interface ActorUpdateParams {
+    satellite: SatelliteContext;
+    options: UpdateOptions;
+}

package/dist/types/types/{auth.types.d.ts → auth.d.ts}

@@ -1,5 +1,5 @@
 import type { InternetIdentityProvider, NFIDProvider } from '../providers/auth.providers';
-import type { Doc } from './doc.types';
+import type { Doc } from './doc';
 /**
  * Type representing the available authentication providers.
  * @typedef {('internet_identity' | 'nfid')} Provider

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

@@ -0,0 +1,43 @@
+/**
+ * Options that control the behavior of update call operations.
+ *
+ * Update calls on the Internet Computer are always certified.
+ * This type enforces that `certified` is always `true` and exists
+ * for consistency across all call-related configurations.
+ *
+ * @interface
+ */
+export interface UpdateOptions {
+    /**
+     * For update calls: always `true`.
+     * Certification is enforced by the Internet Computer protocol.
+     *
+     * @type {true}
+     */
+    certified: true;
+}
+/**
+ * Options that control the behavior of read call operations.
+ *
+ * These options apply to methods that perform read calls,
+ * such as datastore queries or asset retrievals.
+ */
+export interface ReadOptions {
+    /**
+     * If true, performs read operations using certified calls.
+     * Certified calls provide cryptographic proof that the data is verified by the Internet Computer.
+     * This ensures data integrity but may increase latency compared to regular (non-certified) query calls.
+     *
+     * Defaults to false.
+     *
+     * @type {boolean}
+     * @optional
+     */
+    certified?: boolean;
+}
+/**
+ * Union type representing call options for both read and update operations.
+ *
+ * @typedef {UpdateOptions | ReadOptions} CallOptions
+ */
+export type CallOptions = UpdateOptions | ReadOptions;

package/dist/types/types/{doc.types.d.ts → doc.d.ts}

@@ -1,4 +1,4 @@
-import type { ExcludeDate } from './utility.types';
+import type { ExcludeDate } from './utility';
 /**
  * Represents a document stored in a collection.
  * @template D - The type of data contained in the document.

package/dist/types/types/{env.types.d.ts → env.d.ts}

@@ -1,4 +1,4 @@
-import type { Satellite } from './satellite.types';
+import type { SatelliteContext } from './satellite';
 /**
  * Represents the path to a web worker.
  * @typedef {string} EnvironmentWorkerPath
@@ -31,7 +31,7 @@ export interface EnvironmentWorkers {
 export type Environment = {
     internetIdentityId?: string;
     workers?: EnvironmentWorkers;
-} & Required<Pick<Satellite, 'satelliteId'>> & Pick<Satellite, 'container'>;
+} & Required<Pick<SatelliteContext, 'satelliteId'>> & Pick<SatelliteContext, 'container'>;
 /**
  * Represents the user environment configuration. i.e. the optional parameters the user is providing to initialize Juno.
  * @typedef {Object} UserEnvironment
@@ -40,4 +40,4 @@ export type Environment = {
  * @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'>;
+export type UserEnvironment = Omit<Environment, 'satelliteId'> & Pick<SatelliteContext, 'satelliteId'>;

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

@@ -0,0 +1,40 @@
+import type { Identity } from '@dfinity/agent';
+/**
+ * Configuration options for connecting to a satellite.
+ * @interface
+ */
+export interface SatelliteContext {
+    /**
+     * The identity used to authenticate with the satellite.
+     * Typically derived from Internet Identity or another supported identity type.
+     *
+     * @type {Identity}
+     */
+    identity: Identity;
+    /**
+     * The unique ID of the satellite to interact with.
+     * If not provided, attempts to use one defined in environment variables.
+     * If ultimately none is available, the call will fail.
+     *
+     * @type {string}
+     * @optional
+     */
+    satelliteId?: string;
+    /**
+     * Indicates if the satellite is running in a local container, or provides the container URL.
+     * - If `true`, connects to the default local container (for development).
+     * - If a string, specifies the full container URL (e.g., "http://localhost:4943").
+     * - If not set, connects to the production satellite.
+     *
+     * @type {boolean | string}
+     * @optional
+     */
+    container?: boolean | string;
+}
+/**
+ * Represents partial configuration options for connecting to a satellite.
+ * Typically used in Node.js environments or for advanced configuration scenarios in the browser.
+ *
+ * @typedef {Partial<SatelliteContext>} SatelliteOptions
+ */
+export type SatelliteOptions = Partial<SatelliteContext>;

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

@@ -1,6 +1,6 @@
 import type { Asset } from '@junobuild/storage';
 import type { AssetNoContent } from '../../declarations/satellite/satellite.did';
-import type { ListResults } from './list.types';
+import type { ListResults } from './list';
 /**
  * Represents a collection of assets with pagination details.
  * @interface

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

@@ -1,5 +1,5 @@
 import type { DelDoc, Doc as DocApi, SetDoc } from '../../declarations/satellite/satellite.did';
-import type { Doc } from '../types/doc.types';
+import type { Doc } from '../types/doc';
 export declare const toSetDoc: <D>(doc: Doc<D>) => Promise<SetDoc>;
 export declare const toDelDoc: <D>(doc: Doc<D>) => DelDoc;
 export declare const fromDoc: <D>({ doc, key }: {

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

@@ -1,4 +1,4 @@
-import type { Satellite } from '../types/satellite.types';
-export declare const satelliteUrl: ({ satelliteId: customSatelliteId, container: customContainer }: Satellite) => string;
-export declare const customOrEnvSatelliteId: ({ satelliteId }: Pick<Satellite, "satelliteId">) => Pick<Satellite, "satelliteId">;
-export declare const customOrEnvContainer: ({ container: customContainer }: Pick<Satellite, "container">) => Pick<Satellite, "container">;
+import type { SatelliteContext } from '../types/satellite';
+export declare const satelliteUrl: ({ satelliteId: customSatelliteId, container: customContainer }: SatelliteContext) => string;
+export declare const customOrEnvSatelliteId: ({ satelliteId }: Pick<SatelliteContext, "satelliteId">) => Pick<SatelliteContext, "satelliteId">;
+export declare const customOrEnvContainer: ({ container: customContainer }: Pick<SatelliteContext, "container">) => Pick<SatelliteContext, "container">;

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

@@ -1,3 +1,3 @@
 import type { ListParams as ListParamsApi } from '../../declarations/satellite/satellite.did';
-import type { ListParams } from '../types/list.types';
+import type { ListParams } from '../types/list';
 export declare const toListParams: ({ matcher, paginate, order, owner }: ListParams) => ListParamsApi;

package/dist/types/workers/_auth.worker.handler.d.ts

@@ -0,0 +1,11 @@
+import type { PostMessage, PostMessageDataRequest } from '../types/post-message';
+export declare const onAuthMessage: ({ data }: MessageEvent<PostMessage<PostMessageDataRequest>>) => void;
+/**
+ * The timer is executed only if user has signed in
+ */
+export declare const startTimer: () => NodeJS.Timeout;
+export declare const stopTimer: () => void;
+/**
+ * ℹ️ Exported for test purpose only.
+ */
+export declare const onTimerSignOut: () => Promise<void>;

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

@@ -1,5 +1 @@
-/**
- * The timer is executed only if user has signed in
- */
-export declare const startTimer: () => NodeJS.Timeout;
-export declare const stopTimer: () => void;
+export {};