lazypock 0.1.2 → 0.1.5

package/dist/index.d.cts

@@ -288,11 +288,27 @@ declare class CollectionService<T = ApiRecord> {
     constructor(http: HttpClient, collectionName: string, authStore?: AuthStore, realtime?: RealtimeService);
     private encodeId;
     /**
-     * List records with optional filter/sort/pagination.
-     * @param params Query parameters including `filter`, `sort`, `page`, `perPage`, `expand`.
+     * Fetch a paginated list of records (PocketBase `getList`).
+     *
+     * @param page Page number (default 1).
+     * @param perPage Records per page (default 30).
+     * @param options Query params (`filter`, `sort`, `expand`, `fields`) + request options.
+     */
+    getList<T2 = T>(page?: number, perPage?: number, options?: Record<string, unknown> & RequestOptions): Promise<ListResult<T2> | null>;
+    /**
+     * Fetch all records at once (auto-paginates). Mirrors PocketBase's
+     * `pb.collection(name).getFullList()`.
+     *
+     * @param options Query params (`sort`, `filter`, `batch`, etc.) + request options.
+     */
+    getFullList<T2 = T>(options?: Record<string, unknown> & RequestOptions): Promise<Array<T2>>;
+    /**
+     * Fetch the first record matching a filter (PocketBase `getFirstListItem`).
+     *
+     * @param filter Filter expression (e.g. `title = 'x'`).
      * @param options Optional request options.
      */
-    list(params?: Record<string, string>, options?: RequestOptions): Promise<ListResult<T> | null>;
+    getFirstListItem<T2 = T>(filter: string, options?: RequestOptions): Promise<T2 | null>;
     /**
      * Get a single record by ID.
      * @param id Record ID.
@@ -432,6 +448,82 @@ declare class FilesService {
     delete(fileId: string, options?: RequestOptions): Promise<null>;
 }
 
+/**
+ * Registry-level realtime events for the collections admin channel.
+ * The backend (AdminChannel) broadcasts the action as the *event name*,
+ * with the collection JSON as the payload.
+ */
+interface CollectionsMessage {
+    action: "create" | "update" | "delete";
+    /** The collection payload (id + metadata), or {} when unavailable. */
+    collection: Record<string, unknown>;
+    topic?: string;
+}
+/**
+ * Registry service for collections (list/create/update/delete + realtime
+ * registry events). Mirrors PocketBase's `pb.collections`.
+ */
+declare class CollectionsService {
+    private http?;
+    private realtime?;
+    /** @internal */
+    constructor(http?: HttpClient, realtime?: RealtimeService);
+    /**
+     * Fetch a paginated list of collections (admin).
+     *
+     * @param params Optional query params (`page`, `perPage`, `filter`, `sort`).
+     * @param options Optional request options.
+     */
+    getList<T = ApiRecord>(params?: Record<string, unknown>, options?: RequestOptions): Promise<ListResult<T> | null>;
+    /**
+     * Fetch all collections at once (auto-paginates). Mirrors PocketBase's
+     * `pb.collections.getFullList()` — defaults to listing everything.
+     *
+     * @param options Query params (`sort`, `batch`, etc.) or request options.
+     */
+    getFullList<T = ApiRecord>(options?: Record<string, unknown> & RequestOptions): Promise<Array<T>>;
+    /**
+     * Get a single collection by ID or name (admin).
+     *
+     * @param id Collection ID or name.
+     * @param options Optional request options.
+     */
+    getOne<T = ApiRecord>(id: string, options?: RequestOptions): Promise<T | null>;
+    /**
+     * Create a new collection (admin).
+     *
+     * @param data Collection definition (name, type, fields, options, rules, etc.).
+     * @param options Optional request options.
+     */
+    create<T = ApiRecord>(data: Record<string, unknown>, options?: RequestOptions): Promise<T | null>;
+    /**
+     * Update an existing collection (admin).
+     *
+     * @param id Collection ID or name.
+     * @param data Updated collection fields.
+     * @param options Optional request options.
+     */
+    update<T = ApiRecord>(id: string, data: Record<string, unknown>, options?: RequestOptions): Promise<T | null>;
+    /**
+     * Delete a collection (admin).
+     *
+     * @param id Collection ID or name.
+     * @param options Optional request options.
+     */
+    delete(id: string, options?: RequestOptions): Promise<boolean>;
+    /**
+     * Subscribe to collection registry changes.
+     *
+     * @param callback Received on every collection create/update/delete.
+     * @returns A function that unsubscribes this callback.
+     */
+    subscribe(callback: (e: CollectionsMessage) => void): () => void;
+    /**
+     * Unsubscribe all callbacks from the registry channel.
+     */
+    unsubscribe(): void;
+}
+
 /** A single field definition as returned by `GET /collections`. */
 interface SchemaField {
     id?: string;
@@ -534,13 +626,14 @@ interface LazypockClientOptions {
  * ```ts
  * const client = new LazypockClient({ baseUrl: 'http://localhost:4000/api' });
  * await client.login('admin@example.com', 'password');
- * const posts = await client.collection('posts').list();
+ * const posts = await client.collection('posts').getList();
  * ```
  */
 declare class LazypockClient {
     readonly http: HttpClient;
     readonly authStore: AuthStore;
     readonly realtime: RealtimeService;
+    readonly collections: CollectionsService;
     readonly files: FilesService;
     private collectionCache;
     private schemaByName?;
@@ -635,79 +728,6 @@ declare class LazypockClient {
     logout(): void;
     /** Ping the API health endpoint. */
     health(options?: RequestOptions): Promise<Record<string, unknown> | null>;
-    /**
-     * List all collections (admin).
-     * @param q URL query string (e.g. `page=1&perPage=200`).
-     * @param options Optional request options.
-     */
-    listCollections(q?: string, options?: RequestOptions): Promise<ListResult<ApiRecord> | null>;
-    /**
-     * Get a single collection by ID or name.
-     * @param id Collection ID or name.
-     * @param options Optional request options.
-     */
-    getCollection(id: string, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Create a new collection (admin).
-     * @param data Collection definition (name, type, fields, options, rules, etc.).
-     * @param options Optional request options.
-     */
-    createCollection(data: Record<string, unknown>, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Update an existing collection (admin).
-     * @param id Collection ID or name.
-     * @param data Updated collection fields.
-     * @param options Optional request options.
-     */
-    updateCollection(id: string, data: Record<string, unknown>, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Delete a collection (admin).
-     * @param id Collection ID or name.
-     * @param options Optional request options.
-     */
-    deleteCollection(id: string, options?: RequestOptions): Promise<null>;
-    /**
-     * List records from a dynamic collection with optional filter/sort/pagination.
-     *
-     * @param coll Collection name.
-     * @param params Query parameters including:
-     *   - `filter` — PocketBase filter syntax (e.g. `title~'hello' && published=true`)
-     *   - `sort` — Comma-separated, `-` prefix for DESC (e.g. `-created,title`)
-     *   - `page` — Page number (default: 1)
-     *   - `perPage` — Items per page (default: 30, max: 200)
-     *   - `expand` — Comma-separated relation fields (e.g. `author,category`)
-     * @param options Optional request options.
-     */
-    listRecords(coll: string, params?: Record<string, string>, options?: RequestOptions): Promise<ListResult<ApiRecord> | null>;
-    /**
-     * Get a single record by ID.
-     * @param coll Collection name.
-     * @param id Record ID.
-     * @param options Optional request options.
-     */
-    getRecord(coll: string, id: string, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Create a record in a dynamic collection.
-     * @param coll Collection name.
-     * @param data Record fields.
-     * @param options Optional request options.
-     */
-    createRecord(coll: string, data: Record<string, unknown>, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Update a record in a dynamic collection.
-     * @param coll Collection name.
-     * @param id Record ID.
-     * @param data Updated record fields.
-     * @param options Optional request options.
-     */
-    updateRecord(coll: string, id: string, data: Record<string, unknown>, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Delete a record from a dynamic collection.
-     * @param coll Collection name.
-     * @param id Record ID.
-     * @param options Optional request options.
-     */
-    deleteRecord(coll: string, id: string, options?: RequestOptions): Promise<null>;
 }
 
 /**
@@ -738,4 +758,4 @@ declare class TypedClient<TCollections extends LazypockCollections = LazypockCol
  */
 declare function createClient<TCollections extends LazypockCollections = LazypockCollections>(options: LazypockClientOptions): TypedClient<TCollections>;
 
-export { ApiError, type ApiRecord, type AuthModel, AuthStore, type CollectionSchema, CollectionService, type CreateData, type FileRecord, FilesService, LazypockClient, type LazypockClientOptions, type LazypockCollections, type ListResult, type RealtimeCallback, type RealtimeMessage, RealtimeService, type RecordShape, type RequestOptions, type SchemaField, type StorageAdapter, type SystemFields, TypedClient, type UpdateData, collectionTypeName, createClient, fieldTypeKind, fieldTypeScriptType, generateTypes, getFileUrl, schemaFieldType, wsUrlFromBaseUrl };
+export { ApiError, type ApiRecord, type AuthModel, AuthStore, type CollectionSchema, CollectionService, type CollectionsMessage, CollectionsService, type CreateData, type FileRecord, FilesService, LazypockClient, type LazypockClientOptions, type LazypockCollections, type ListResult, type RealtimeCallback, type RealtimeMessage, RealtimeService, type RecordShape, type RequestOptions, type SchemaField, type StorageAdapter, type SystemFields, TypedClient, type UpdateData, collectionTypeName, createClient, fieldTypeKind, fieldTypeScriptType, generateTypes, getFileUrl, schemaFieldType, wsUrlFromBaseUrl };

package/dist/index.d.ts

@@ -288,11 +288,27 @@ declare class CollectionService<T = ApiRecord> {
     constructor(http: HttpClient, collectionName: string, authStore?: AuthStore, realtime?: RealtimeService);
     private encodeId;
     /**
-     * List records with optional filter/sort/pagination.
-     * @param params Query parameters including `filter`, `sort`, `page`, `perPage`, `expand`.
+     * Fetch a paginated list of records (PocketBase `getList`).
+     *
+     * @param page Page number (default 1).
+     * @param perPage Records per page (default 30).
+     * @param options Query params (`filter`, `sort`, `expand`, `fields`) + request options.
+     */
+    getList<T2 = T>(page?: number, perPage?: number, options?: Record<string, unknown> & RequestOptions): Promise<ListResult<T2> | null>;
+    /**
+     * Fetch all records at once (auto-paginates). Mirrors PocketBase's
+     * `pb.collection(name).getFullList()`.
+     *
+     * @param options Query params (`sort`, `filter`, `batch`, etc.) + request options.
+     */
+    getFullList<T2 = T>(options?: Record<string, unknown> & RequestOptions): Promise<Array<T2>>;
+    /**
+     * Fetch the first record matching a filter (PocketBase `getFirstListItem`).
+     *
+     * @param filter Filter expression (e.g. `title = 'x'`).
      * @param options Optional request options.
      */
-    list(params?: Record<string, string>, options?: RequestOptions): Promise<ListResult<T> | null>;
+    getFirstListItem<T2 = T>(filter: string, options?: RequestOptions): Promise<T2 | null>;
     /**
      * Get a single record by ID.
      * @param id Record ID.
@@ -432,6 +448,82 @@ declare class FilesService {
     delete(fileId: string, options?: RequestOptions): Promise<null>;
 }
 
+/**
+ * Registry-level realtime events for the collections admin channel.
+ * The backend (AdminChannel) broadcasts the action as the *event name*,
+ * with the collection JSON as the payload.
+ */
+interface CollectionsMessage {
+    action: "create" | "update" | "delete";
+    /** The collection payload (id + metadata), or {} when unavailable. */
+    collection: Record<string, unknown>;
+    topic?: string;
+}
+/**
+ * Registry service for collections (list/create/update/delete + realtime
+ * registry events). Mirrors PocketBase's `pb.collections`.
+ */
+declare class CollectionsService {
+    private http?;
+    private realtime?;
+    /** @internal */
+    constructor(http?: HttpClient, realtime?: RealtimeService);
+    /**
+     * Fetch a paginated list of collections (admin).
+     *
+     * @param params Optional query params (`page`, `perPage`, `filter`, `sort`).
+     * @param options Optional request options.
+     */
+    getList<T = ApiRecord>(params?: Record<string, unknown>, options?: RequestOptions): Promise<ListResult<T> | null>;
+    /**
+     * Fetch all collections at once (auto-paginates). Mirrors PocketBase's
+     * `pb.collections.getFullList()` — defaults to listing everything.
+     *
+     * @param options Query params (`sort`, `batch`, etc.) or request options.
+     */
+    getFullList<T = ApiRecord>(options?: Record<string, unknown> & RequestOptions): Promise<Array<T>>;
+    /**
+     * Get a single collection by ID or name (admin).
+     *
+     * @param id Collection ID or name.
+     * @param options Optional request options.
+     */
+    getOne<T = ApiRecord>(id: string, options?: RequestOptions): Promise<T | null>;
+    /**
+     * Create a new collection (admin).
+     *
+     * @param data Collection definition (name, type, fields, options, rules, etc.).
+     * @param options Optional request options.
+     */
+    create<T = ApiRecord>(data: Record<string, unknown>, options?: RequestOptions): Promise<T | null>;
+    /**
+     * Update an existing collection (admin).
+     *
+     * @param id Collection ID or name.
+     * @param data Updated collection fields.
+     * @param options Optional request options.
+     */
+    update<T = ApiRecord>(id: string, data: Record<string, unknown>, options?: RequestOptions): Promise<T | null>;
+    /**
+     * Delete a collection (admin).
+     *
+     * @param id Collection ID or name.
+     * @param options Optional request options.
+     */
+    delete(id: string, options?: RequestOptions): Promise<boolean>;
+    /**
+     * Subscribe to collection registry changes.
+     *
+     * @param callback Received on every collection create/update/delete.
+     * @returns A function that unsubscribes this callback.
+     */
+    subscribe(callback: (e: CollectionsMessage) => void): () => void;
+    /**
+     * Unsubscribe all callbacks from the registry channel.
+     */
+    unsubscribe(): void;
+}
+
 /** A single field definition as returned by `GET /collections`. */
 interface SchemaField {
     id?: string;
@@ -534,13 +626,14 @@ interface LazypockClientOptions {
  * ```ts
  * const client = new LazypockClient({ baseUrl: 'http://localhost:4000/api' });
  * await client.login('admin@example.com', 'password');
- * const posts = await client.collection('posts').list();
+ * const posts = await client.collection('posts').getList();
  * ```
  */
 declare class LazypockClient {
     readonly http: HttpClient;
     readonly authStore: AuthStore;
     readonly realtime: RealtimeService;
+    readonly collections: CollectionsService;
     readonly files: FilesService;
     private collectionCache;
     private schemaByName?;
@@ -635,79 +728,6 @@ declare class LazypockClient {
     logout(): void;
     /** Ping the API health endpoint. */
     health(options?: RequestOptions): Promise<Record<string, unknown> | null>;
-    /**
-     * List all collections (admin).
-     * @param q URL query string (e.g. `page=1&perPage=200`).
-     * @param options Optional request options.
-     */
-    listCollections(q?: string, options?: RequestOptions): Promise<ListResult<ApiRecord> | null>;
-    /**
-     * Get a single collection by ID or name.
-     * @param id Collection ID or name.
-     * @param options Optional request options.
-     */
-    getCollection(id: string, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Create a new collection (admin).
-     * @param data Collection definition (name, type, fields, options, rules, etc.).
-     * @param options Optional request options.
-     */
-    createCollection(data: Record<string, unknown>, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Update an existing collection (admin).
-     * @param id Collection ID or name.
-     * @param data Updated collection fields.
-     * @param options Optional request options.
-     */
-    updateCollection(id: string, data: Record<string, unknown>, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Delete a collection (admin).
-     * @param id Collection ID or name.
-     * @param options Optional request options.
-     */
-    deleteCollection(id: string, options?: RequestOptions): Promise<null>;
-    /**
-     * List records from a dynamic collection with optional filter/sort/pagination.
-     *
-     * @param coll Collection name.
-     * @param params Query parameters including:
-     *   - `filter` — PocketBase filter syntax (e.g. `title~'hello' && published=true`)
-     *   - `sort` — Comma-separated, `-` prefix for DESC (e.g. `-created,title`)
-     *   - `page` — Page number (default: 1)
-     *   - `perPage` — Items per page (default: 30, max: 200)
-     *   - `expand` — Comma-separated relation fields (e.g. `author,category`)
-     * @param options Optional request options.
-     */
-    listRecords(coll: string, params?: Record<string, string>, options?: RequestOptions): Promise<ListResult<ApiRecord> | null>;
-    /**
-     * Get a single record by ID.
-     * @param coll Collection name.
-     * @param id Record ID.
-     * @param options Optional request options.
-     */
-    getRecord(coll: string, id: string, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Create a record in a dynamic collection.
-     * @param coll Collection name.
-     * @param data Record fields.
-     * @param options Optional request options.
-     */
-    createRecord(coll: string, data: Record<string, unknown>, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Update a record in a dynamic collection.
-     * @param coll Collection name.
-     * @param id Record ID.
-     * @param data Updated record fields.
-     * @param options Optional request options.
-     */
-    updateRecord(coll: string, id: string, data: Record<string, unknown>, options?: RequestOptions): Promise<ApiRecord | null>;
-    /**
-     * Delete a record from a dynamic collection.
-     * @param coll Collection name.
-     * @param id Record ID.
-     * @param options Optional request options.
-     */
-    deleteRecord(coll: string, id: string, options?: RequestOptions): Promise<null>;
 }
 
 /**
@@ -738,4 +758,4 @@ declare class TypedClient<TCollections extends LazypockCollections = LazypockCol
  */
 declare function createClient<TCollections extends LazypockCollections = LazypockCollections>(options: LazypockClientOptions): TypedClient<TCollections>;
 
-export { ApiError, type ApiRecord, type AuthModel, AuthStore, type CollectionSchema, CollectionService, type CreateData, type FileRecord, FilesService, LazypockClient, type LazypockClientOptions, type LazypockCollections, type ListResult, type RealtimeCallback, type RealtimeMessage, RealtimeService, type RecordShape, type RequestOptions, type SchemaField, type StorageAdapter, type SystemFields, TypedClient, type UpdateData, collectionTypeName, createClient, fieldTypeKind, fieldTypeScriptType, generateTypes, getFileUrl, schemaFieldType, wsUrlFromBaseUrl };
+export { ApiError, type ApiRecord, type AuthModel, AuthStore, type CollectionSchema, CollectionService, type CollectionsMessage, CollectionsService, type CreateData, type FileRecord, FilesService, LazypockClient, type LazypockClientOptions, type LazypockCollections, type ListResult, type RealtimeCallback, type RealtimeMessage, RealtimeService, type RecordShape, type RequestOptions, type SchemaField, type StorageAdapter, type SystemFields, TypedClient, type UpdateData, collectionTypeName, createClient, fieldTypeKind, fieldTypeScriptType, generateTypes, getFileUrl, schemaFieldType, wsUrlFromBaseUrl };