@junobuild/admin/dist/types/api/satellite.api.d.ts

A library for interfacing with admin features of Juno

import type { Principal } from '@dfinity/principal';
import type { AuthenticationConfig, CollectionType, Controller, CustomDomain, DbConfig, ListRulesParams, ListRulesResults, MemorySize, Rule, SetControllersArgs, SetRule, StorageConfig } from '../../declarations/satellite/satellite.did';
import type { SatelliteParameters } from '../types/actor.types';
export declare const setStorageConfig: ({ config, satellite }: {
    config: StorageConfig;
    satellite: SatelliteParameters;
}) => Promise<void>;
export declare const setDatastoreConfig: ({ config, satellite }: {
    config: DbConfig;
    satellite: SatelliteParameters;
}) => Promise<void>;
export declare const setAuthConfig: ({ config, satellite }: {
    config: AuthenticationConfig;
    satellite: SatelliteParameters;
}) => Promise<void>;
export declare const getStorageConfig: ({ satellite }: {
    satellite: SatelliteParameters;
}) => Promise<StorageConfig>;
export declare const getDatastoreConfig: ({ satellite }: {
    satellite: SatelliteParameters;
}) => Promise<[] | [DbConfig]>;
export declare const getAuthConfig: ({ satellite }: {
    satellite: SatelliteParameters;
}) => Promise<[] | [AuthenticationConfig]>;
export declare const listRules: ({ satellite, type, filter }: {
    satellite: SatelliteParameters;
    type: CollectionType;
    filter: ListRulesParams;
}) => Promise<ListRulesResults>;
export declare const setRule: ({ type, collection, rule, satellite }: {
    type: CollectionType;
    collection: string;
    rule: SetRule;
    satellite: SatelliteParameters;
}) => Promise<Rule>;
/**
 * @deprecated - Replaced in Satellite > v0.0.22 with public custom section juno:package
 */
export declare const version: ({ satellite }: {
    satellite: SatelliteParameters;
}) => Promise<string>;
/**
 * @deprecated TODO: for backwards compatibility - to be removed
 */
export declare const listDeprecatedControllers: ({ satellite }: {
    satellite: SatelliteParameters;
}) => Promise<Principal[]>;
/**
 * @deprecated TODO: for backwards compatibility - to be removed
 */
export declare const listDeprecatedNoScopeControllers: ({ satellite }: {
    satellite: SatelliteParameters;
}) => Promise<[Principal, Controller][]>;
export declare const listControllers: ({ satellite }: {
    satellite: SatelliteParameters;
}) => Promise<[Principal, Controller][]>;
export declare const listCustomDomains: ({ satellite }: {
    satellite: SatelliteParameters;
}) => Promise<[string, CustomDomain][]>;
export declare const setCustomDomain: ({ satellite, domainName, boundaryNodesId }: {
    satellite: SatelliteParameters;
    domainName: string;
    boundaryNodesId: string | undefined;
}) => Promise<void>;
export declare const memorySize: ({ satellite }: {
    satellite: SatelliteParameters;
}) => Promise<MemorySize>;
export declare const countDocs: ({ collection, satellite }: {
    collection: string;
    satellite: SatelliteParameters;
}) => Promise<bigint>;
export declare const countAssets: ({ collection, satellite }: {
    collection: string;
    satellite: SatelliteParameters;
}) => Promise<bigint>;
export declare const deleteDocs: ({ collection, satellite }: {
    collection: string;
    satellite: SatelliteParameters;
}) => Promise<void>;
export declare const deleteAssets: ({ collection, satellite }: {
    collection: string;
    satellite: SatelliteParameters;
}) => Promise<void>;
export declare const setControllers: ({ args, satellite }: {
    args: SetControllersArgs;
    satellite: SatelliteParameters;
}) => Promise<[Principal, Controller][]>;