lazypock 0.8.3 → 0.9.0

package/dist/index.d.cts

@@ -340,6 +340,12 @@ type RealtimeConnectOpts = {
     /** Auth token to pass as query param */
     token?: string;
 };
+/**
+ * Provides the current auth token at connect/reconnect time.
+ * Wired by {@link LazypockClient} from its `authStore` so the socket is
+ * always authenticated with the latest token (PocketBase parity).
+ */
+type RealtimeTokenProvider = () => string | undefined;
 /**
  * Derive a WebSocket URL from an HTTP base URL.
  * http://localhost:4000/api → ws://localhost:4000/socket/websocket
@@ -370,6 +376,7 @@ declare class RealtimeService {
     onError?: (err: Event) => void;
     private url;
     private token;
+    private tokenProvider;
     /** Whether the WebSocket is currently open. */
     get isOpen(): boolean;
     /**
@@ -384,14 +391,35 @@ declare class RealtimeService {
      * auto-connect on the first {@link subscribe}.
      */
     setUrl(url: string): void;
+    /**
+     * Register a token provider consulted at every (re)connect.
+     * When set, it takes precedence over the token passed to {@link connect}.
+     */
+    setTokenProvider(provider: RealtimeTokenProvider): void;
+    /**
+     * Reconnect the socket immediately with the current token.
+     * Called by the SDK when auth changes (login/logout/token refresh) so
+     * private-channel joins are authorized with the new credentials. No-op
+     * when the socket has never been opened and nothing is subscribed.
+     */
+    refresh(): void;
     ensureConnected(): void;
     connect(opts: RealtimeConnectOpts): void;
     disconnect(): void;
     /**
-     * Subscribe to a topic (e.g. "collection:posts" or "collection:posts:*").
+     * Subscribe to a topic (e.g. "collection:posts" or "custom:chat-room").
      * The backend Channel authorizes via listRule on join.
+     *
+     * @param joinPayload Optional payload forwarded with the channel join
+     * (available to the server's join callback / hooks, e.g. `expand`).
+     */
+    subscribe(topic: string, callback: (e: RealtimeEvent) => void, joinPayload?: Record<string, unknown>): void;
+    /**
+     * Remove all subscriptions for topics under `prefix` (the topic itself or
+     * any topic starting with `prefix + ":"`). Used by collection-level
+     * `unsubscribe()` to drop every subscription of a collection.
      */
-    subscribe(topic: string, callback: (e: RealtimeEvent) => void): void;
+    unsubscribeByPrefix(prefix: string): void;
     /**
      * Unsubscribe a specific callback from a topic.
      */
@@ -452,6 +480,22 @@ interface RealtimeMessage {
 }
 /** Subscription callback for a collection's realtime events. */
 type RealtimeCallback = (e: RealtimeMessage) => void;
+/**
+ * Options for {@link CollectionService.subscribe} (PocketBase-compatible).
+ *
+ * `expand` and any extra keys are forwarded to the server channel join
+ * payload (available to `onRealtimeSubscribeRequest` hooks). `headers` is
+ * accepted for PocketBase signature compatibility but has no effect over
+ * WebSocket — it is not forwarded.
+ */
+interface RealtimeSubscribeOptions {
+    /** Fields to expand on the subscribed records (server join payload). */
+    expand?: string;
+    /** Accepted for PocketBase parity; not sent over the WebSocket. */
+    headers?: Record<string, string>;
+    /** Any extra keys are forwarded verbatim to the server join payload. */
+    [key: string]: unknown;
+}
 /**
  * Typed CRUD service for a single dynamic collection.
  * Get an instance via {@link LazypockClient.collection}.
@@ -606,20 +650,33 @@ declare class CollectionService<T = ApiRecord, TData = never> {
     withSchema(schema: CollectionSchema): CollectionService<T, TData>;
     /**
      * Subscribe to realtime changes for this collection.
-     * The event's `action` is one of `"create" | "update" | "delete"`.
+     * The event's `action` is one of `"create" | "update" | "delete"` and the
+     * callback always receives the **full record** (all fields, regardless of
+     * any `select()` projection on the service).
      *
      * Access is governed by the collection's `listRule` (PocketBase semantics):
      * public collections allow anonymous subscriptions; other collections
      * require a matching logged-in user or superuser.
      *
-     * @param callback Received on every record change.
-     * @param recordId Optional — subscribe to a single record instead of `*`.
+     * PocketBase-compatible argument forms:
+     *   - `subscribe(cb)` — all records of the collection
+     *   - `subscribe('*', cb)` — all records (explicit wildcard)
+     *   - `subscribe('RECORD_ID', cb)` — a single record
+     *   - `subscribe('*' | 'RECORD_ID', cb, options)` — with join options
+     *
+     * Legacy form (callback first) is still accepted: `subscribe(cb, recordId)`.
+     *
      * @returns A function that unsubscribes this callback.
      */
+    subscribe(callback: RealtimeCallback): () => void;
+    subscribe(recordId: string, callback: RealtimeCallback, options?: RealtimeSubscribeOptions): () => void;
+    /** @deprecated Use `subscribe(recordId, callback)` — PocketBase order. */
     subscribe(callback: RealtimeCallback, recordId?: string): () => void;
     /**
-     * Unsubscribe all callbacks from this collection (or a specific record).
-     * @param recordId Optional record id; omitting it unsubs everything.
+     * Unsubscribe from realtime changes (PocketBase-compatible):
+     *   - `unsubscribe()` — remove **all** subscriptions of this collection
+     *   - `unsubscribe('*')` — remove wildcard subscriptions
+     *   - `unsubscribe('RECORD_ID')` — remove that record's subscriptions
      */
     unsubscribe(recordId?: string): void;
     /**
@@ -1039,4 +1096,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 CollectionsMessage, CollectionsService, type CreateData, type ExpandString, type FieldKey, type FileRecord, FilesService, type FilterOp, type FilterString, HttpClient, LazypockClient, type LazypockClientOptions, type LazypockCollections, type ListOptions, type ListResult, type ReadOptions, type RealtimeCallback, type RealtimeMessage, RealtimeService, type RecordShape, type RequestOptions, type SchemaField, type SortString, type StorageAdapter, type SystemFields, TypedClient, type UpdateData, collectionTypeName, createClient, fieldTypeKind, fieldTypeScriptType, generateTypes, getFileUrl, getScaleUrl, getThumbUrl, schemaFieldType, wsUrlFromBaseUrl };
+export { ApiError, type ApiRecord, type AuthModel, AuthStore, type CollectionSchema, CollectionService, type CollectionsMessage, CollectionsService, type CreateData, type ExpandString, type FieldKey, type FileRecord, FilesService, type FilterOp, type FilterString, HttpClient, LazypockClient, type LazypockClientOptions, type LazypockCollections, type ListOptions, type ListResult, type ReadOptions, type RealtimeCallback, type RealtimeMessage, RealtimeService, type RealtimeSubscribeOptions, type RecordShape, type RequestOptions, type SchemaField, type SortString, type StorageAdapter, type SystemFields, TypedClient, type UpdateData, collectionTypeName, createClient, fieldTypeKind, fieldTypeScriptType, generateTypes, getFileUrl, getScaleUrl, getThumbUrl, schemaFieldType, wsUrlFromBaseUrl };

package/dist/index.d.ts

@@ -340,6 +340,12 @@ type RealtimeConnectOpts = {
     /** Auth token to pass as query param */
     token?: string;
 };
+/**
+ * Provides the current auth token at connect/reconnect time.
+ * Wired by {@link LazypockClient} from its `authStore` so the socket is
+ * always authenticated with the latest token (PocketBase parity).
+ */
+type RealtimeTokenProvider = () => string | undefined;
 /**
  * Derive a WebSocket URL from an HTTP base URL.
  * http://localhost:4000/api → ws://localhost:4000/socket/websocket
@@ -370,6 +376,7 @@ declare class RealtimeService {
     onError?: (err: Event) => void;
     private url;
     private token;
+    private tokenProvider;
     /** Whether the WebSocket is currently open. */
     get isOpen(): boolean;
     /**
@@ -384,14 +391,35 @@ declare class RealtimeService {
      * auto-connect on the first {@link subscribe}.
      */
     setUrl(url: string): void;
+    /**
+     * Register a token provider consulted at every (re)connect.
+     * When set, it takes precedence over the token passed to {@link connect}.
+     */
+    setTokenProvider(provider: RealtimeTokenProvider): void;
+    /**
+     * Reconnect the socket immediately with the current token.
+     * Called by the SDK when auth changes (login/logout/token refresh) so
+     * private-channel joins are authorized with the new credentials. No-op
+     * when the socket has never been opened and nothing is subscribed.
+     */
+    refresh(): void;
     ensureConnected(): void;
     connect(opts: RealtimeConnectOpts): void;
     disconnect(): void;
     /**
-     * Subscribe to a topic (e.g. "collection:posts" or "collection:posts:*").
+     * Subscribe to a topic (e.g. "collection:posts" or "custom:chat-room").
      * The backend Channel authorizes via listRule on join.
+     *
+     * @param joinPayload Optional payload forwarded with the channel join
+     * (available to the server's join callback / hooks, e.g. `expand`).
+     */
+    subscribe(topic: string, callback: (e: RealtimeEvent) => void, joinPayload?: Record<string, unknown>): void;
+    /**
+     * Remove all subscriptions for topics under `prefix` (the topic itself or
+     * any topic starting with `prefix + ":"`). Used by collection-level
+     * `unsubscribe()` to drop every subscription of a collection.
      */
-    subscribe(topic: string, callback: (e: RealtimeEvent) => void): void;
+    unsubscribeByPrefix(prefix: string): void;
     /**
      * Unsubscribe a specific callback from a topic.
      */
@@ -452,6 +480,22 @@ interface RealtimeMessage {
 }
 /** Subscription callback for a collection's realtime events. */
 type RealtimeCallback = (e: RealtimeMessage) => void;
+/**
+ * Options for {@link CollectionService.subscribe} (PocketBase-compatible).
+ *
+ * `expand` and any extra keys are forwarded to the server channel join
+ * payload (available to `onRealtimeSubscribeRequest` hooks). `headers` is
+ * accepted for PocketBase signature compatibility but has no effect over
+ * WebSocket — it is not forwarded.
+ */
+interface RealtimeSubscribeOptions {
+    /** Fields to expand on the subscribed records (server join payload). */
+    expand?: string;
+    /** Accepted for PocketBase parity; not sent over the WebSocket. */
+    headers?: Record<string, string>;
+    /** Any extra keys are forwarded verbatim to the server join payload. */
+    [key: string]: unknown;
+}
 /**
  * Typed CRUD service for a single dynamic collection.
  * Get an instance via {@link LazypockClient.collection}.
@@ -606,20 +650,33 @@ declare class CollectionService<T = ApiRecord, TData = never> {
     withSchema(schema: CollectionSchema): CollectionService<T, TData>;
     /**
      * Subscribe to realtime changes for this collection.
-     * The event's `action` is one of `"create" | "update" | "delete"`.
+     * The event's `action` is one of `"create" | "update" | "delete"` and the
+     * callback always receives the **full record** (all fields, regardless of
+     * any `select()` projection on the service).
      *
      * Access is governed by the collection's `listRule` (PocketBase semantics):
      * public collections allow anonymous subscriptions; other collections
      * require a matching logged-in user or superuser.
      *
-     * @param callback Received on every record change.
-     * @param recordId Optional — subscribe to a single record instead of `*`.
+     * PocketBase-compatible argument forms:
+     *   - `subscribe(cb)` — all records of the collection
+     *   - `subscribe('*', cb)` — all records (explicit wildcard)
+     *   - `subscribe('RECORD_ID', cb)` — a single record
+     *   - `subscribe('*' | 'RECORD_ID', cb, options)` — with join options
+     *
+     * Legacy form (callback first) is still accepted: `subscribe(cb, recordId)`.
+     *
      * @returns A function that unsubscribes this callback.
      */
+    subscribe(callback: RealtimeCallback): () => void;
+    subscribe(recordId: string, callback: RealtimeCallback, options?: RealtimeSubscribeOptions): () => void;
+    /** @deprecated Use `subscribe(recordId, callback)` — PocketBase order. */
     subscribe(callback: RealtimeCallback, recordId?: string): () => void;
     /**
-     * Unsubscribe all callbacks from this collection (or a specific record).
-     * @param recordId Optional record id; omitting it unsubs everything.
+     * Unsubscribe from realtime changes (PocketBase-compatible):
+     *   - `unsubscribe()` — remove **all** subscriptions of this collection
+     *   - `unsubscribe('*')` — remove wildcard subscriptions
+     *   - `unsubscribe('RECORD_ID')` — remove that record's subscriptions
      */
     unsubscribe(recordId?: string): void;
     /**
@@ -1039,4 +1096,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 CollectionsMessage, CollectionsService, type CreateData, type ExpandString, type FieldKey, type FileRecord, FilesService, type FilterOp, type FilterString, HttpClient, LazypockClient, type LazypockClientOptions, type LazypockCollections, type ListOptions, type ListResult, type ReadOptions, type RealtimeCallback, type RealtimeMessage, RealtimeService, type RecordShape, type RequestOptions, type SchemaField, type SortString, type StorageAdapter, type SystemFields, TypedClient, type UpdateData, collectionTypeName, createClient, fieldTypeKind, fieldTypeScriptType, generateTypes, getFileUrl, getScaleUrl, getThumbUrl, schemaFieldType, wsUrlFromBaseUrl };
+export { ApiError, type ApiRecord, type AuthModel, AuthStore, type CollectionSchema, CollectionService, type CollectionsMessage, CollectionsService, type CreateData, type ExpandString, type FieldKey, type FileRecord, FilesService, type FilterOp, type FilterString, HttpClient, LazypockClient, type LazypockClientOptions, type LazypockCollections, type ListOptions, type ListResult, type ReadOptions, type RealtimeCallback, type RealtimeMessage, RealtimeService, type RealtimeSubscribeOptions, type RecordShape, type RequestOptions, type SchemaField, type SortString, type StorageAdapter, type SystemFields, TypedClient, type UpdateData, collectionTypeName, createClient, fieldTypeKind, fieldTypeScriptType, generateTypes, getFileUrl, getScaleUrl, getThumbUrl, schemaFieldType, wsUrlFromBaseUrl };

package/dist/index.global.js

@@ -817,25 +817,24 @@ var Lazypock = (() => {
       derived.fieldsPreset = this.fieldsPreset;
       return derived;
     }
-    // ── Realtime Subscriptions (PocketBase-style) ──
-    /**
-     * Subscribe to realtime changes for this collection.
-     * The event's `action` is one of `"create" | "update" | "delete"`.
-     *
-     * Access is governed by the collection's `listRule` (PocketBase semantics):
-     * public collections allow anonymous subscriptions; other collections
-     * require a matching logged-in user or superuser.
-     *
-     * @param callback Received on every record change.
-     * @param recordId Optional — subscribe to a single record instead of `*`.
-     * @returns A function that unsubscribes this callback.
-     */
-    subscribe(callback, recordId) {
+    subscribe(topicOrCallback, maybeCallback, options) {
       if (!this.realtime) {
         console.warn("[lazypock] No realtime service configured.");
         return () => {
         };
       }
+      let recordId;
+      let callback;
+      let joinPayload;
+      if (typeof topicOrCallback === "function") {
+        callback = topicOrCallback;
+        if (typeof maybeCallback === "string") recordId = maybeCallback;
+      } else {
+        callback = maybeCallback;
+        recordId = topicOrCallback === "*" ? void 0 : topicOrCallback;
+        const { headers: _ignored, ...rest } = options ?? {};
+        if (Object.keys(rest).length > 0) joinPayload = rest;
+      }
       const topic = "collection:" + this.collectionName + (recordId ? ":" + recordId : "");
       const handler = (raw) => {
         const record = raw.payload?.["record"] ?? {};
@@ -846,15 +845,23 @@ var Lazypock = (() => {
         });
       };
       this.realtime.ensureConnected();
-      this.realtime.subscribe(topic, handler);
+      this.realtime.subscribe(topic, handler, joinPayload);
       return () => this.realtime?.unsubscribe(topic, handler);
     }
     /**
-     * Unsubscribe all callbacks from this collection (or a specific record).
-     * @param recordId Optional record id; omitting it unsubs everything.
+     * Unsubscribe from realtime changes (PocketBase-compatible):
+     *   - `unsubscribe()` — remove **all** subscriptions of this collection
+     *   - `unsubscribe('*')` — remove wildcard subscriptions
+     *   - `unsubscribe('RECORD_ID')` — remove that record's subscriptions
      */
     unsubscribe(recordId) {
-      const topic = "collection:" + this.collectionName + (recordId ? ":" + recordId : "");
+      if (recordId === void 0) {
+        this.realtime?.unsubscribeByPrefix(
+          "collection:" + this.collectionName
+        );
+        return;
+      }
+      const topic = "collection:" + this.collectionName + (recordId === "*" ? "" : ":" + recordId);
       this.realtime?.unsubscribe(topic);
     }
     // ── Auth Collection Methods ──
@@ -921,6 +928,7 @@ var Lazypock = (() => {
       this.reconnectAttempt = 0;
       this.maxReconnectDelay = 5e3;
       this.url = "";
+      this.tokenProvider = null;
       // ── Heartbeat ──
       this.heartbeatInterval = null;
     }
@@ -946,6 +954,32 @@ var Lazypock = (() => {
     setUrl(url) {
       this.url = url;
     }
+    /**
+     * Register a token provider consulted at every (re)connect.
+     * When set, it takes precedence over the token passed to {@link connect}.
+     */
+    setTokenProvider(provider) {
+      this.tokenProvider = provider;
+    }
+    /**
+     * Reconnect the socket immediately with the current token.
+     * Called by the SDK when auth changes (login/logout/token refresh) so
+     * private-channel joins are authorized with the new credentials. No-op
+     * when the socket has never been opened and nothing is subscribed.
+     */
+    refresh() {
+      if (typeof WebSocket === "undefined") return;
+      if (!this.ws && this.subscriptions.size === 0) return;
+      this.clearReconnectTimer();
+      const ws = this.ws;
+      this.ws = null;
+      if (ws) {
+        ws.onclose = null;
+        ws.close();
+      }
+      this.reconnectAttempt = 0;
+      this.doConnect();
+    }
     /*
      * Ensure the socket is connected, then subscribe.
      * Used by collection-level convenience wrappers so a connection is opened
@@ -969,15 +1003,30 @@ var Lazypock = (() => {
       this.ws = null;
     }
     /**
-     * Subscribe to a topic (e.g. "collection:posts" or "collection:posts:*").
+     * Subscribe to a topic (e.g. "collection:posts" or "custom:chat-room").
      * The backend Channel authorizes via listRule on join.
+     *
+     * @param joinPayload Optional payload forwarded with the channel join
+     * (available to the server's join callback / hooks, e.g. `expand`).
      */
-    subscribe(topic, callback) {
+    subscribe(topic, callback, joinPayload) {
       const subs = this.subscriptions.get(topic) || [];
-      subs.push({ topic, callback });
+      subs.push({ topic, callback, joinPayload });
       this.subscriptions.set(topic, subs);
       if (this.ws?.readyState === WebSocket.OPEN) {
-        this.joinTopic(topic);
+        this.joinTopic(topic, joinPayload);
+      }
+    }
+    /**
+     * Remove all subscriptions for topics under `prefix` (the topic itself or
+     * any topic starting with `prefix + ":"`). Used by collection-level
+     * `unsubscribe()` to drop every subscription of a collection.
+     */
+    unsubscribeByPrefix(prefix) {
+      for (const topic of [...this.subscriptions.keys()]) {
+        if (topic === prefix || topic.startsWith(prefix + ":")) {
+          this.subscriptions.delete(topic);
+        }
       }
     }
     /**
@@ -996,9 +1045,14 @@ var Lazypock = (() => {
       }
     }
     resubscribeAll() {
-      for (const topic of this.subscriptions.keys()) {
-        if (this.ws?.readyState === WebSocket.OPEN) {
-          this.joinTopic(topic);
+      const seen = /* @__PURE__ */ new Set();
+      for (const entries of this.subscriptions.values()) {
+        for (const entry of entries) {
+          if (seen.has(entry.topic)) continue;
+          seen.add(entry.topic);
+          if (this.ws?.readyState === WebSocket.OPEN) {
+            this.joinTopic(entry.topic, entry.joinPayload);
+          }
         }
       }
     }
@@ -1010,8 +1064,9 @@ var Lazypock = (() => {
         return;
       }
       let url = this.url;
-      if (this.token) {
-        url += (url.includes("?") ? "&" : "?") + "token=" + encodeURIComponent(this.token);
+      const token = this.tokenProvider ? this.tokenProvider() : this.token;
+      if (token) {
+        url += (url.includes("?") ? "&" : "?") + "token=" + encodeURIComponent(token);
       }
       this.ws = new WebSocket(url);
       this.ws.onopen = () => {
@@ -1058,12 +1113,12 @@ var Lazypock = (() => {
         }
       }
     }
-    joinTopic(topic) {
+    joinTopic(topic, joinPayload) {
       const ref = this.nextRef();
       const msg = JSON.stringify({
         topic,
         event: "phx_join",
-        payload: {},
+        payload: joinPayload ?? {},
         ref
       });
       this.ws?.send(msg);
@@ -1490,7 +1545,15 @@ var Lazypock = (() => {
           body
         })}`
       );
-      const createLines = fields.map((f) => createDataMemberLine(f)).filter((l) => l !== "");
+      const createLines = [];
+      const seenKeys = /* @__PURE__ */ new Set();
+      for (const f of fields) {
+        for (const { key, line } of createDataMemberLines(f)) {
+          if (seenKeys.has(key)) continue;
+          seenKeys.add(key);
+          createLines.push(line);
+        }
+      }
       sections.push(
         `export interface ${typeName}CreateData${renderInterface({
           body: createLines.join("\n")
@@ -1592,14 +1655,23 @@ ${opts.body}
     if (type === "never") return "";
     return `  ${JSON.stringify(key)}${req}: ${type};`;
   }
-  function createDataMemberLine(f) {
-    if (f.type === "autodate") return "";
-    const key = fieldKey(f.name);
+  function createDataMemberLines(f) {
+    if (f.type === "autodate") return [];
+    const rawName = fieldKey(f.name);
     const serverDefaulted = f.options?.defaultValue !== void 0 || f.system && (f.name === "verified" || f.name === "emailVisibility");
     const req = f.required && !serverDefaulted ? "" : "?";
     const type = f.type === "password" ? "string" : fieldTypeScriptType(f);
-    if (type === "never") return "";
-    return `  ${JSON.stringify(key)}${req}: ${type};`;
+    if (type === "never") return [];
+    const members = [
+      { key: rawName, line: `  ${JSON.stringify(rawName)}${req}: ${type};` }
+    ];
+    if (f.type === "password" && rawName !== "password") {
+      members.unshift({
+        key: "password",
+        line: `  ${JSON.stringify("password")}${req}: ${type};`
+      });
+    }
+    return members;
   }
 
   // src/lazypock.ts
@@ -1618,6 +1690,9 @@ ${opts.body}
       if (!options.realtime) {
         this.realtime.setUrl(wsUrlFromBaseUrl(baseUrl));
       }
+      this.realtime.setTokenProvider(() => this.authStore.token);
+      this.authStore.onChange(() => this.realtime.refresh());
+      this.authReady.then(() => this.realtime.refresh());
       this.files = new FilesService(this.http);
       this.collections = new CollectionsService(this.http, this.realtime);
       if (options.types?.schemas) {