@junobuild/core-standalone 0.1.0

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

@@ -0,0 +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/build.types.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Represents the type of build.
+ * @typedef {'stock' | 'extended'} BuildType
+ */
+export type BuildType = 'stock' | 'extended';

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

@@ -0,0 +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

@@ -0,0 +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

@@ -0,0 +1,170 @@
+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 timestamp matching criteria with mutually exclusive options.
+ * This type defines various ways to filter based on timestamp values.
+ */
+export type ListTimestampMatcher = {
+    /**
+     * Specifies an exact match for the timestamp.
+     */
+    matcher: 'equal';
+    /**
+     * The timestamp value to match exactly.
+     */
+    timestamp: bigint;
+} | {
+    /**
+     * Specifies a greater than comparison for the timestamp.
+     */
+    matcher: 'greaterThan';
+    /**
+     * The timestamp value that the target should be greater than.
+     */
+    timestamp: bigint;
+} | {
+    /**
+     * Specifies a less than comparison for the timestamp.
+     */
+    matcher: 'lessThan';
+    /**
+     * The timestamp value that the target should be less than.
+     * Used only when `matchType` is 'lessThan'.
+     */
+    timestamp: bigint;
+} | {
+    /**
+     * Specifies a range for the timestamp, inclusive of start and end.
+     */
+    matcher: 'between';
+    /**
+     * The range of timestamps to match, inclusive of both start and end values.
+     */
+    timestamps: {
+        start: bigint;
+        end: bigint;
+    };
+};
+/**
+ * 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;
+    /**
+     * Criteria for matching the creation timestamp.
+     */
+    createdAt?: ListTimestampMatcher;
+    /**
+     * Criteria for matching the update timestamp.
+     */
+    updatedAt?: ListTimestampMatcher;
+}
+/**
+ * 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/post-message.d.ts

@@ -0,0 +1,11 @@
+export type PostMessageRequest = 'junoStartAuthTimer' | 'junoStopAuthTimer';
+export type PostMessageResponse = 'junoSignOutAuthTimer' | 'junoDelegationRemainingTime';
+export type PostMessageDataRequest = never;
+export type PostMessageDataResponse = object;
+export interface PostMessageDataResponseAuth extends PostMessageDataResponse {
+    authRemainingTime: number;
+}
+export interface PostMessage<T extends PostMessageDataRequest | PostMessageDataResponse> {
+    msg: PostMessageRequest | PostMessageResponse;
+    data?: T;
+}

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

@@ -0,0 +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>;

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

@@ -0,0 +1,21 @@
+import type { Asset } from '@junobuild/storage';
+import type { AssetNoContent } from '../../declarations/satellite/satellite.did';
+import type { ListResults } from './list.types';
+/**
+ * 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 Omit<ListResults<AssetNoContent>, 'items'> {
+    /**
+     * The collection of assets.
+     * @type {Asset[]}
+     */
+    items: Asset[];
+    /**
+     * The collection of assets. Duplicates items for backwards compatibility. It will ultimately be removed.
+     * @deprecated Use {@link items} instead.
+     * @type {Asset[]}
+     */
+    assets: Asset[];
+}

package/dist/types/types/subscription.types.d.ts

@@ -0,0 +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/auth.utils.d.ts

@@ -0,0 +1,2 @@
+import { AuthClient } from '@dfinity/auth-client';
+export declare const createAuthClient: () => Promise<AuthClient>;

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

@@ -0,0 +1 @@
+export declare const sha256ToBase64String: (sha256: Iterable<number>) => string;

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

@@ -0,0 +1,2 @@
+import type { Doc } from '../../declarations/satellite/satellite.did';
+export declare const mapData: <D>({ data }: Pick<Doc, "data">) => Promise<D>;

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

@@ -0,0 +1,8 @@
+import type { DelDoc, Doc as DocApi, SetDoc } from '../../declarations/satellite/satellite.did';
+import type { Doc } from '../types/doc.types';
+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 }: {
+    doc: DocApi;
+    key: string;
+}) => Promise<Doc<D>>;

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

@@ -0,0 +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">;

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

@@ -0,0 +1,4 @@
+export declare const emit: <T>({ message, detail }: {
+    message: string;
+    detail?: T | undefined;
+}) => void;

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

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

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/dist/types/utils/window.utils.d.ts

@@ -0,0 +1,4 @@
+export declare const popupCenter: ({ width, height }: {
+    width: number;
+    height: number;
+}) => string | undefined;

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

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