@grdn.site/jetstream 0.2.2

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,43 @@
+<p align="center">
+	<img src="https://github.com/skyware-js/.github/blob/main/assets/logo-dark.png?raw=true" height="72">
+</p>
+<h1 align="center">@skyware/jetstream</h1>
+
+A fully typed client for the Bluesky [Jetstream](https://github.com/bluesky-social/jetstream) service.
+
+[Documentation](https://skyware.js.org/docs/jetstream)
+
+## Installation
+
+```sh
+npm install @skyware/jetstream
+```
+
+## Example Usage
+
+```js
+import { Jetstream } from "@skyware/jetstream";
+
+const jetstream = new Jetstream({
+	wantedCollections: ["app.bsky.feed.post", "app.bsky.feed.like"], // omit to receive all collections
+	wantedDids: ["did:web:example.com"], // omit to receive events from all dids
+});
+
+jetstream.onCreate("app.bsky.feed.post", (event) => {
+    console.log(`New post: ${event.commit.record.text}`)
+});
+
+jetstream.onDelete("app.bsky.feed.post", (event) => {
+    console.log(`Deleted post: ${event.commit.rkey}`)
+});
+
+// Other events: 
+// - "commit" (to receive all commits regardless of collection)
+// - "identity" (identity update events)
+// - `${collection}` (to receive all commits related to a specific collection)
+jetstream.on("account", (event) => {
+    console.log(`Account updated: ${event.did}`)
+});
+
+jetstream.start()
+```

package/dist/index.d.ts

@@ -0,0 +1,237 @@
+import type { At, ComAtprotoSyncSubscribeRepos, Records as _Records } from "@atcute/client/lexicons";
+import "@atcute/bluesky/lexicons";
+import { EventEmitter } from "eventemitter3";
+import { WebSocket } from "partysocket";
+/** Record mappings. */
+export interface Records extends _Records {
+}
+/**
+ * Options for the {@link Jetstream} class.
+ */
+export interface JetstreamOptions<WantedCollections extends Collection = Collection> {
+    /**
+     * The full subscription endpoint to connect to.
+     * @default "wss://jetstream1.us-east.bsky.network/subscribe"
+     */
+    endpoint?: string;
+    /**
+     * The record collections that you want to receive updates for.
+     * Leave this empty to receive updates for all record collections.
+     */
+    wantedCollections?: Array<WantedCollections>;
+    /**
+     * The DIDs that you want to receive updates for.
+     * Leave this empty to receive updates for all DIDs.
+     */
+    wantedDids?: Array<string>;
+    /**
+     * The maximum size of a payload that this client would like to receive.
+     * Zero means no limit, negative values are treated as zero.
+     * @default 0
+     */
+    maxMessageSizeBytes?: number;
+    /**
+     * The Unix timestamp in microseconds that you want to receive updates from.
+     */
+    cursor?: number;
+    /**
+     * The WebSocket implementation to use (e.g. `import ws from "ws"`).
+     * Not required if you are on Node 21.0.0 or newer, or another environment that provides a WebSocket implementation.
+     */
+    ws?: unknown;
+}
+/**
+ * The events that are emitted by the {@link Jetstream} class.
+ * @see {@link Jetstream#on}
+ */
+export type JetstreamEvents<WantedCollections extends Collection = Collection> = {
+    open: [];
+    close: [];
+    commit: [event: CommitEvent<WantedCollections>];
+    account: [event: AccountEvent];
+    identity: [event: IdentityEvent];
+    error: [error: Error, cursor?: number];
+};
+/**
+ * The Jetstream client.
+ */
+export declare class Jetstream<WantedCollections extends CollectionOrWildcard = CollectionOrWildcard, ResolvedCollections extends Collection = ResolveLexiconWildcard<WantedCollections>> extends EventEmitter<JetstreamEvents<ResolvedCollections>> {
+    /** WebSocket connection to the server. */
+    ws?: WebSocket;
+    /** The full connection URL. */
+    url: URL;
+    /** The current cursor. */
+    cursor?: number;
+    /** The WebSocket implementation to use. */
+    private wsImpl?;
+    constructor(options?: JetstreamOptions<WantedCollections>);
+    /**
+     * Opens a WebSocket connection to the server.
+     */
+    start(): void;
+    /**
+     * Closes the WebSocket connection.
+     */
+    close(): void;
+    /**
+     * Listen for records created in a specific collection.
+     * @param collection The name of the collection to listen for.
+     * @param listener A callback function that receives the commit event.
+     */
+    onCreate<T extends ResolvedCollections>(collection: T, listener: (event: CommitCreateEvent<T>) => void): void;
+    /**
+     * Listen for records updated in a specific collection.
+     * @param collection The name of the collection to listen for.
+     * @param listener A callback function that receives the commit event.
+     */
+    onUpdate<T extends ResolvedCollections>(collection: T, listener: (event: CommitUpdateEvent<T>) => void): void;
+    /**
+     * Listen for records deleted in a specific collection.
+     * @param collection The name of the collection to listen for.
+     * @param listener A callback function that receives the commit event.
+     */
+    onDelete<T extends ResolvedCollections>(collection: T, listener: (event: CommitDeleteEvent<T>) => void): void;
+    /**
+     * Send a message to update options for the duration of this connection.
+     */
+    updateOptions(payload: Pick<JetstreamOptions, "wantedDids" | "wantedCollections" | "maxMessageSizeBytes">): void;
+    private createUrl;
+    /** Emitted when the connection is opened. */
+    on(event: "open", listener: () => void): this;
+    /** Emitted when the connection is closed. */
+    on(event: "close", listener: () => void): this;
+    /** Emitted when any commit is received. */
+    on(event: "commit", listener: (event: CommitEvent<ResolvedCollections>) => void): this;
+    /** Emitted when an account is updated. */
+    on(event: "account", listener: (event: AccountEvent) => void): this;
+    /** Emitted when an identity event is received. */
+    on(event: "identity", listener: (event: IdentityEvent) => void): this;
+    /**
+     * Emitted when a network error occurs.
+     * @param listener A callback function that receives the error and the last known cursor.
+     */
+    on(event: "error", listener: (error: Error, cursor?: number) => void): this;
+    /**
+     * Listen for all commits related to a specific collection.
+     * @param collection The name of the collection.
+     * @param listener  A callback function that receives the commit event.
+     */
+    on<T extends ResolvedCollections>(collection: T, listener: (event: CommitEvent<T>) => void): this;
+}
+/** Resolves a lexicon name to its record operation. */
+export type ResolveLexicon<T extends string> = T extends keyof Records ? Records[T] : {
+    $type: T;
+};
+/** Checks if any member of a union is assignable to a given operation. */
+type UnionMemberIsAssignableTo<Union, AssignableTo> = Union extends Union ? Union extends AssignableTo ? true : never : never;
+/** Resolves a wildcard string to the record types it matches. */
+export type ResolveLexiconWildcard<T extends string> = T extends `${infer Prefix}*` ? true extends UnionMemberIsAssignableTo<keyof Records, `${Prefix}${string}`> ? keyof Records & `${Prefix}${string}` extends infer Lexicon extends string ? Lexicon : never : `${Prefix}${string}` : T;
+/** The name of a collection. */
+export type Collection = (keyof Records) | (string & {});
+/** Generates all possible wildcard strings that match a given collection name. */
+type PossibleCollectionWildcards<CollectionName extends string> = CollectionName extends `${infer Prefix}.${infer Suffix}` ? `${Prefix}.*` | `${Prefix}.${PossibleCollectionWildcards<Suffix>}` : never;
+/** The name of a collection or a wildcard string matching multiple collections. */
+export type CollectionOrWildcard = PossibleCollectionWildcards<keyof Records> | Collection;
+/**
+ * The types of events that are emitted by {@link Jetstream}.
+ * @enum
+ */
+export declare const EventType: {
+    /** A new commit. */
+    readonly Commit: "commit";
+    /** An account's status was updated. */
+    readonly Account: "account";
+    /** An account's identity was updated. */
+    readonly Identity: "identity";
+};
+export type EventType = typeof EventType[keyof typeof EventType];
+/**
+ * The types of commits that can be received.
+ * @enum
+ */
+export declare const CommitType: {
+    /** A record was created. */
+    readonly Create: "create";
+    /** A record was updated. */
+    readonly Update: "update";
+    /** A record was deleted. */
+    readonly Delete: "delete";
+};
+export type CommitType = typeof CommitType[keyof typeof CommitType];
+/**
+ * The base operation for events emitted by the {@link Jetstream} class.
+ */
+export interface EventBase {
+    did: At.DID;
+    time_us: number;
+    kind: EventType;
+}
+/**
+ * A commit event. Represents a commit to a user repository.
+ */
+export interface CommitEvent<RecordType extends string> extends EventBase {
+    kind: typeof EventType.Commit;
+    commit: Commit<RecordType>;
+}
+/** A commit event where a record was created. */
+export interface CommitCreateEvent<RecordType extends string> extends CommitEvent<RecordType> {
+    commit: CommitCreate<RecordType>;
+}
+/** A commit event where a record was updated. */
+export interface CommitUpdateEvent<RecordType extends string> extends CommitEvent<RecordType> {
+    commit: CommitUpdate<RecordType>;
+}
+/** A commit event where a record was deleted. */
+export interface CommitDeleteEvent<RecordType extends string> extends CommitEvent<RecordType> {
+    commit: CommitDelete<RecordType>;
+}
+/**
+ * An account event. Represents a change to an account's status on a host (e.g. PDS or Relay).
+ */
+export interface AccountEvent extends EventBase {
+    kind: typeof EventType.Account;
+    account: ComAtprotoSyncSubscribeRepos.Account;
+}
+/**
+ * An identity event. Represents a change to an account's identity.
+ */
+export interface IdentityEvent extends EventBase {
+    kind: typeof EventType.Identity;
+    identity: ComAtprotoSyncSubscribeRepos.Identity;
+}
+/**
+ * The base operation for commit events.
+ */
+export interface CommitBase<RecordType extends string> {
+    operation: CommitType;
+    rev: string;
+    collection: RecordType;
+    rkey: string;
+}
+/**
+ * A commit event representing a new record.
+ */
+export interface CommitCreate<RecordType extends string> extends CommitBase<RecordType> {
+    operation: typeof CommitType.Create;
+    record: ResolveLexicon<RecordType>;
+    cid: At.CID;
+}
+/**
+ * A commit event representing an update to an existing record.
+ */
+export interface CommitUpdate<RecordType extends string> extends CommitBase<RecordType> {
+    operation: typeof CommitType.Update;
+    record: ResolveLexicon<RecordType>;
+    cid: At.CID;
+}
+/**
+ * A commit event representing a deletion of an existing record.
+ */
+export interface CommitDelete<RecordType extends string> extends CommitBase<RecordType> {
+    operation: typeof CommitType.Delete;
+}
+/**
+ * A commit event.
+ */
+export type Commit<RecordType extends string> = CommitCreate<RecordType> | CommitUpdate<RecordType> | CommitDelete<RecordType>;
+export {};

package/dist/index.js

@@ -0,0 +1,186 @@
+import "@atcute/bluesky/lexicons";
+import { EventEmitter } from "eventemitter3";
+import { WebSocket } from "partysocket";
+/**
+ * The Jetstream client.
+ */
+export class Jetstream extends EventEmitter {
+    /** WebSocket connection to the server. */
+    ws;
+    /** The full connection URL. */
+    url;
+    /** The current cursor. */
+    cursor;
+    /** The WebSocket implementation to use. */
+    wsImpl;
+    constructor(options) {
+        super();
+        options ??= {};
+        if (options.ws)
+            this.wsImpl = options.ws;
+        if (typeof globalThis.WebSocket === "undefined" && !this.wsImpl) {
+            throw new Error(`No WebSocket implementation was found in your environment. You must provide an implementation as the \`ws\` option.
+
+For example, in a Node.js environment, \`npm install ws\` and then:
+import { Jetstream } from "@skyware/jetstream";
+import WebSocket from "ws";
+
+const jetstream = new Jetstream({
+	ws: WebSocket,
+});`);
+        }
+        this.url = new URL(options.endpoint ?? "wss://jetstream1.us-east.bsky.network/subscribe");
+        options.wantedCollections?.forEach((collection) => {
+            this.url.searchParams.append("wantedCollections", collection);
+        });
+        options.wantedDids?.forEach((did) => {
+            this.url.searchParams.append("wantedDids", did);
+        });
+        if (options.maxMessageSizeBytes) {
+            this.url.searchParams.append("maxMessageSizeBytes", `${options.maxMessageSizeBytes}`);
+        }
+        if (options.cursor)
+            this.cursor = options.cursor;
+    }
+    /**
+     * Opens a WebSocket connection to the server.
+     */
+    start() {
+        this.ws = new WebSocket(() => this.createUrl(), null, { WebSocket: this.wsImpl });
+        this.ws.onopen = () => this.emit("open");
+        this.ws.onclose = () => this.emit("close");
+        this.ws.onerror = ({ error }) => this.emit("error", error, this.cursor);
+        this.ws.onmessage = (data) => {
+            try {
+                const event = JSON.parse(data.data);
+                if (event.time_us > (this.cursor ?? 0))
+                    this.cursor = event.time_us;
+                switch (event.kind) {
+                    case EventType.Commit:
+                        if (!event.commit?.collection || !event.commit.rkey || !event.commit.rev) {
+                            return;
+                        }
+                        if (event.commit.operation === CommitType.Create && !event.commit.record) {
+                            return;
+                        }
+                        this.emit("commit", event);
+                        // @ts-expect-error – We know we can use collection name as an event.
+                        this.emit(event.commit.collection, event);
+                        break;
+                    case EventType.Account:
+                        if (!event.account?.did)
+                            return;
+                        this.emit("account", event);
+                        break;
+                    case EventType.Identity:
+                        if (!event.identity?.did)
+                            return;
+                        this.emit("identity", event);
+                        break;
+                }
+            }
+            catch (e) {
+                this.emit("error", e instanceof Error ? e : new Error(e), this.cursor);
+            }
+        };
+    }
+    /**
+     * Closes the WebSocket connection.
+     */
+    close() {
+        this.ws?.close();
+    }
+    /**
+     * Listen for records created in a specific collection.
+     * @param collection The name of the collection to listen for.
+     * @param listener A callback function that receives the commit event.
+     */
+    onCreate(collection, listener) {
+        this.on(collection, ({ commit, ...event }) => {
+            if (commit.operation === CommitType.Create)
+                listener({ commit, ...event });
+        });
+    }
+    /**
+     * Listen for records updated in a specific collection.
+     * @param collection The name of the collection to listen for.
+     * @param listener A callback function that receives the commit event.
+     */
+    onUpdate(collection, listener) {
+        this.on(collection, ({ commit, ...event }) => {
+            if (commit.operation === CommitType.Update)
+                listener({ commit, ...event });
+        });
+    }
+    /**
+     * Listen for records deleted in a specific collection.
+     * @param collection The name of the collection to listen for.
+     * @param listener A callback function that receives the commit event.
+     */
+    onDelete(collection, listener) {
+        this.on(collection, ({ commit, ...event }) => {
+            if (commit.operation === CommitType.Delete)
+                listener({ commit, ...event });
+        });
+    }
+    /**
+     * Send a message to update options for the duration of this connection.
+     */
+    updateOptions(payload) {
+        if (!this.ws)
+            throw new Error("Not connected.");
+        if (payload.wantedDids) {
+            this.url.searchParams.delete("wantedDids");
+            payload.wantedDids.forEach((did) => {
+                this.url.searchParams.append("wantedDids", did);
+            });
+        }
+        if (payload.wantedCollections) {
+            this.url.searchParams.delete("wantedCollections");
+            payload.wantedCollections.forEach((collection) => {
+                this.url.searchParams.append("wantedCollections", collection);
+            });
+        }
+        if (payload.maxMessageSizeBytes) {
+            this.url.searchParams.set("maxMessageSizeBytes", payload.maxMessageSizeBytes.toString());
+        }
+        this.ws.send(JSON.stringify({ type: "options_update", payload }));
+    }
+    createUrl() {
+        if (this.cursor)
+            this.url.searchParams.set("cursor", this.cursor.toString());
+        return this.url.toString();
+    }
+    /**
+     * @param event The event to listen for.
+     * @param listener The callback function, called when the event is emitted.
+     */
+    on(event, listener) {
+        // @ts-ignore
+        return super.on(event, listener);
+    }
+}
+/**
+ * The types of events that are emitted by {@link Jetstream}.
+ * @enum
+ */
+export const EventType = {
+    /** A new commit. */
+    Commit: "commit",
+    /** An account's status was updated. */
+    Account: "account",
+    /** An account's identity was updated. */
+    Identity: "identity",
+};
+/**
+ * The types of commits that can be received.
+ * @enum
+ */
+export const CommitType = {
+    /** A record was created. */
+    Create: "create",
+    /** A record was updated. */
+    Update: "update",
+    /** A record was deleted. */
+    Delete: "delete",
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+	"name": "@grdn.site/jetstream",
+	"type": "module",
+	"description": "A fully typed client for the Bluesky Jetstream (https://github.com/bluesky-social/jetstream) service.",
+	"version": "0.2.2",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"license": "MPL-2.0",
+	"repository": "https://github.com/skyware-js/jetstream",
+	"homepage": "https://skyware.js.org/docs/jetstream",
+	"keywords": [
+		"bluesky",
+		"jetstream",
+		"atproto",
+		"skyware"
+	],
+	"scripts": {
+		"build": "tsc",
+		"lint": "eslint . --ext .ts",
+		"fmt": "dprint fmt",
+		"prepublish": "pnpm lint && pnpm fmt && pnpm build"
+	},
+	"devDependencies": {
+		"@atcute/client": "^2.0.0",
+		"@types/node": "^22.5.4",
+		"@typescript-eslint/eslint-plugin": "^6.7.4",
+		"@typescript-eslint/parser": "^6.7.4",
+		"dprint": "^0.41.0",
+		"eslint": "^8.50.0",
+		"typescript": "^5.5.4"
+	},
+	"files": [
+		"dist"
+	],
+	"dependencies": {
+		"@atcute/bluesky": "^1.0.6",
+		"eventemitter3": "^5.0.1",
+		"partysocket": "^1.0.2"
+	}
+}