@junobuild/admin 0.5.0-next-2025-06-12 → 0.5.0-next-2025-06-20

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

@@ -1,5 +1,5 @@
 import type { Principal } from '@dfinity/principal';
-import type { AuthenticationConfig, CollectionType, Controller, CustomDomain, DbConfig, MemorySize, Rule, SetControllersArgs, SetRule, StorageConfig } from '../../declarations/satellite/satellite.did';
+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;
@@ -22,10 +22,11 @@ export declare const getDatastoreConfig: ({ satellite }: {
 export declare const getAuthConfig: ({ satellite }: {
     satellite: SatelliteParameters;
 }) => Promise<[] | [AuthenticationConfig]>;
-export declare const listRules: ({ satellite, type }: {
+export declare const listRules: ({ satellite, type, filter }: {
     satellite: SatelliteParameters;
     type: CollectionType;
-}) => Promise<[string, Rule][]>;
+    filter: ListRulesParams;
+}) => Promise<ListRulesResults>;
 export declare const setRule: ({ type, collection, rule, satellite }: {
     type: CollectionType;
     collection: string;

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

@@ -1,16 +1,19 @@
 import type { Rule, RulesType } from '@junobuild/config';
 import type { SatelliteParameters } from '../types/actor.types';
+import type { ListRulesMatcher, ListRulesResults } from '../types/list.types';
 /**
  * Lists the rules for a satellite.
  * @param {Object} params - The parameters for listing the rules.
  * @param {RulesType} params.type - The type of rules to list.
+ * @param {ListRulesMatcher} params.filter - The optional filter for the query.
  * @param {SatelliteParameters} params.satellite - The satellite parameters.
- * @returns {Promise<Rule[]>} A promise that resolves to an array of rules.
+ * @returns {Promise<ListRulesResults>} A promise that resolves to the resolved rules.
  */
-export declare const listRules: ({ type, satellite }: {
+export declare const listRules: ({ type, satellite, filter }: {
     type: RulesType;
+    filter?: ListRulesMatcher;
     satellite: SatelliteParameters;
-}) => Promise<Rule[]>;
+}) => Promise<ListRulesResults>;
 /**
  * Sets a rule for a satellite.
  * @param {Object} params - The parameters for setting the rule.

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

@@ -0,0 +1,44 @@
+import type { Rule } from '@junobuild/config';
+/**
+ * Represents matching parameters for a list call.
+ * @interface
+ */
+export interface ListRulesMatcher {
+    /**
+     * Include the system collections (prefixed with #).
+     * @type {boolean}
+     */
+    include_system: boolean;
+}
+/**
+ * Represents the parameters for listing the rules.
+ * @interface
+ */
+export interface ListRulesParams {
+    /**
+     * The matcher parameters for the query.
+     * @type {ListRulesMatcher}
+     */
+    matcher?: ListRulesMatcher;
+}
+/**
+ * Represents the results of list the rules.
+ * @interface
+ */
+export interface ListRulesResults {
+    /**
+     * The rules matching the query.
+     * @type {Rule[]}
+     */
+    items: Rule[];
+    /**
+     * The number of items - basically items.length.
+     * @type {bigint}
+     */
+    items_length: bigint;
+    /**
+     * The total number of matching results.
+     * @type {bigint}
+     */
+    matches_length: bigint;
+}

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

@@ -1,6 +1,8 @@
 import type { MemoryText, PermissionText, Rule, RulesType } from '@junobuild/config';
-import type { CollectionType as CollectionTypeApi, Memory, Permission, Rule as RuleApi, SetRule } from '../../declarations/satellite/satellite.did';
+import type { CollectionType as CollectionTypeApi, ListRulesParams as ListRulesParamsApi, Memory, Permission, Rule as RuleApi, SetRule } from '../../declarations/satellite/satellite.did';
+import type { ListRulesMatcher } from '../types/list.types';
 export declare const mapRuleType: (type: RulesType) => CollectionTypeApi;
+export declare const mapRulesFilter: (filter?: ListRulesMatcher) => ListRulesParamsApi;
 export declare const mapSetRule: ({ read, write, memory, maxSize, maxChangesPerUser, maxCapacity, version, mutablePermissions, maxTokens }: Pick<Rule, "read" | "write" | "maxSize" | "maxChangesPerUser" | "maxCapacity" | "version" | "memory" | "mutablePermissions" | "maxTokens">) => SetRule;
 export declare const mapRule: ([collection, rule]: [string, RuleApi]) => Rule;
 export declare const permissionToText: (permission: Permission) => PermissionText;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/admin",
-  "version": "0.5.0-next-2025-06-12",
+  "version": "0.5.0-next-2025-06-20",
   "description": "A library for interfacing with admin features of Juno",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",