@mrdoge/node 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Mr. Doge
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,280 @@
+# Mr. Doge SDK — Node / TypeScript
+
+Realtime sports data. One connection, typed everything, no polling.
+
+```bash
+npm install @mrdoge/node
+```
+
+## Quick start
+
+```ts
+import { MrDoge } from "@mrdoge/node"
+
+const mrdoge = new MrDoge({ apiKey: process.env.MRDOGE_API_KEY })
+
+const today = await mrdoge.matches.list({ date: "2026-05-12" })
+console.log(`${today.data.length} matches today`)
+```
+
+That's it. The connection opens lazily on the first call and stays open. No `connect()`, no `await ready`, no event-loop dance.
+
+---
+
+## What it does
+
+- **Live sports state** — matches, odds, stats, scores, AI picks
+- **One persistent WebSocket** under the hood, multiplexed across every call
+- **Typed everywhere** — TS types ship with the package, generated from the same schema the server validates against
+- **Subscriptions just work** — subscribe to a match, get a callback when anything changes
+- **Reconnects silently** — drop your wifi, walk back into range, your subscriptions resume with fresh snapshots
+
+If you want the wire-level details, see [PROTOCOL.md](../protocol/PROTOCOL.md). You don't need to.
+
+---
+
+## Examples
+
+### 1. List today's matches
+
+```ts
+const today = await mrdoge.matches.list({ date: "2026-05-12" })
+for (const m of today.data) {
+  console.log(`${m.homeTeam.name} vs ${m.awayTeam.name} @ ${m.startTime}`)
+}
+```
+
+### 2. Filter by competition and status
+
+```ts
+const liveSerieA = await mrdoge.matches.list({
+  competitionId: "serie-a",
+  status: ["live"],
+})
+```
+
+### 3. Get one match's full detail
+
+```ts
+const match = await mrdoge.matches.get({ id: "12345" })
+
+console.log(match.score)                  // { home: 2, away: 1 }
+console.log(match.markets.length)         // 28 betting markets
+console.log(match.stats.possession)       // { home: 0.55, away: 0.45 }
+```
+
+### 4. Subscribe to one match — get updates as they happen
+
+```ts
+const sub = await mrdoge.matches.subscribe({ matchId: "12345" })
+
+// Initial state arrives with the subscription
+console.log(sub.snapshot.score)
+
+// Listen for whatever you care about
+sub.on("stats", (stats) => console.log("stats updated:", stats))
+sub.on("odds",  (odds)  => console.log("odds updated:", odds.markets.length, "markets"))
+sub.on("status", (status) => console.log("status:", status))
+
+// When you're done
+await sub.cancel()
+```
+
+Updates carry the **full latest state**, not a diff. You replace your local copy and you're current. No merge logic, no sequence numbers, no reconciliation.
+
+### 5. Subscribe to every live match globally
+
+```ts
+const live = await mrdoge.matches.subscribeLive({ sportName: "soccer" })
+
+console.log(`${live.snapshot.length} matches live right now`)
+
+live.on("match", (match) => {
+  // a match was updated (could be score, status, anything)
+  updateUI(match)
+})
+
+live.on("removed", ({ id }) => {
+  // match dropped off the live list (ended)
+  removeFromUI(id)
+})
+```
+
+### 6. Paginate through a busy day
+
+```ts
+let cursor: string | undefined
+do {
+  const page = await mrdoge.matches.list({ date: "2026-05-12", cursor, limit: 100 })
+  for (const m of page.data) process(m)
+  cursor = page.pagination.nextCursor ?? undefined
+} while (cursor)
+```
+
+Cursors are opaque base64 — don't parse them, just pass them back.
+
+### 7. Search
+
+```ts
+const results = await mrdoge.matches.search({ query: "Real Madrid" })
+```
+
+### 8. Get AI-driven picks
+
+```ts
+const picks = await mrdoge.ai.picks.list({
+  date: "2026-05-12",
+  status: ["upcoming"],
+  limit: 10,
+})
+
+for (const pick of picks.data) {
+  console.log(`${pick.match.homeTeam.name} vs ${pick.match.awayTeam.name}`)
+  console.log(`Mr. Doge says: ${pick.outcome} — confidence ${pick.confidence}`)
+}
+```
+
+### 9. Get betting recommendations for a specific match
+
+```ts
+const recs = await mrdoge.ai.recommendations.list({
+  matchId: "12345",
+  confidence: "High",
+  minEdge: 0.05,
+})
+```
+
+### 10. Configure the client
+
+```ts
+const mrdoge = new MrDoge({
+  apiKey: process.env.MRDOGE_API_KEY,
+
+  // These become defaults for every call; override per-call if needed
+  locale: "pt-BR",
+  timezone: "America/Sao_Paulo",
+
+  // Connection knobs (optional, sensible defaults)
+  requestTimeoutMs: 10_000,
+  maxReconnectAttempts: Infinity,
+  reconnectBackoff: { minMs: 1000, maxMs: 30_000, jitter: 0.2 },
+
+  // Disable WS compression (rare; useful for CPU-constrained environments)
+  compression: true,
+})
+```
+
+Per-call override when you need it:
+
+```ts
+await mrdoge.matches.list({ date: "2026-05-12", locale: "en" })  // English just this once
+```
+
+---
+
+## Errors
+
+Every error is a typed class. Use `instanceof` to discriminate.
+
+```ts
+import {
+  MrDogeError,
+  UnauthorizedError,
+  RateLimitError,
+  NotFoundError,
+  ValidationError,
+  ForbiddenError,
+  ConnectionError,
+} from "@mrdoge/node"
+
+try {
+  const match = await mrdoge.matches.get({ id: "12345" })
+} catch (err) {
+  if (err instanceof RateLimitError) {
+    console.log(`Slow down — retry in ${err.retryAfterMs}ms`)
+    await sleep(err.retryAfterMs)
+    // retry
+  } else if (err instanceof NotFoundError) {
+    console.log("Match doesn't exist")
+  } else if (err instanceof UnauthorizedError) {
+    console.log("API key is bad")
+  } else {
+    throw err
+  }
+}
+```
+
+All error classes inherit from `MrDogeError`. Every one carries `.code` (stable string), `.message`, and `.data` (structured details, varies by error type).
+
+---
+
+## Connection lifecycle
+
+The SDK manages its own connection. Most code never touches it. For the rare case you need to observe:
+
+```ts
+mrdoge.on("connected",     ()                => console.log("up"))
+mrdoge.on("disconnected",  (reason)          => console.log("down:", reason))
+mrdoge.on("reconnecting",  ({ attempt, ms }) => console.log(`retrying in ${ms}ms`))
+
+// Force-close everything (rare; SDK does this on process exit anyway)
+await mrdoge.close()
+```
+
+On reconnect, every active subscription is automatically resubscribed and replays a fresh snapshot. You'll see one `snap` event per subscription with current state — **replace, don't merge**.
+
+---
+
+## TypeScript
+
+Everything is typed. Hover any param to see what it accepts, hover any return value to see its shape.
+
+```ts
+const m = await mrdoge.matches.get({ id: "12345" })
+//    ^? MatchDetail
+
+m.markets.forEach(market => {
+//        ^? Market[]
+  market.betItems
+//        ^? BetItem[]
+})
+```
+
+Types are generated from the same Zod schemas the server validates against. If a server response shape changes, the SDK types change in lockstep.
+
+---
+
+## What we deliberately don't do
+
+- **No REST mode.** Everything is WebSocket. You get one connection, you reuse it. If you want one-shot REST, `await` a single method call — the connection opens, services it, stays warm for the next call.
+- **No polling helpers.** If you find yourself polling, you want `subscribe`. That's the whole point.
+- **No callback hell.** Every method returns a Promise. Subscriptions return a handle with named `on(event, fn)` listeners — not a god-callback that switches on event types.
+- **No event reconciliation.** Updates are full-state. Replace and you're current.
+
+---
+
+## API reference
+
+| Method | What it does |
+|---|---|
+| `regions.list` | List regions |
+| `competitions.list` | List competitions, filterable by region/sport |
+| `teams.list` | List teams, filterable |
+| `matches.list` | Paginated matches with filters |
+| `matches.get` | Full match detail |
+| `matches.trending` | Trending matches |
+| `matches.search` | Text search |
+| `matches.subscribeLive` | Stream live updates across all matches |
+| `matches.subscribe` | Stream updates for one match |
+| `ai.picks.list` | Mr. Doge's AI picks |
+| `ai.recommendations.list` | Betting recommendations with edge & confidence |
+
+Full param/result types in [PROTOCOL.md §6](../protocol/PROTOCOL.md#6-methods).
+
+---
+
+## Support
+
+- API issues, account, billing: support@mrdoge.co
+- SDK bugs and feature requests: file an issue
+- Wire-level protocol: [PROTOCOL.md](../protocol/PROTOCOL.md)