Chore: Add JSR CI and improve JSR Ratings (#414)

* cleanup JSR score by automating publishing, adding docs, and fixing imports

* also bump the version

* actually format the code

* update funding based on discussions

.github/FUNDING.yml

@@ -1,14 +1 @@
-
-# These are supported funding model platforms
-
-github: [erfanium]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom:
-  - https://github.com/denodrivers/deno_mongo/discussions/358
+github: [lucsoft]

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
       # Lint & Format
       - name: Lint & Format TS
         run: |
-          deno lint --ignore=./bson/bson.d.ts
+          deno lint
           deno fmt --check
 
       # Start MongoDB

.github/workflows/jsr.yml

@@ -0,0 +1,36 @@
+name: jsr
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: ubuntu-latest
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Setup Environment
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+
+      - name: Clone repository
+        uses: actions/checkout@v2
+
+      - name: Install Deno
+        uses: denolib/setup-deno@master
+        with:
+          deno-version: 1.x.x
+
+      - name: Log versions
+        run: |
+          deno --version
+
+      - name: Publish to JSR
+        run: |
+          deno publish

deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@db/mongo",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "exports": {
     ".": "./mod.ts",
     "./client": "./src/client.ts",

deps.ts

@@ -16,6 +16,6 @@ export {
   Timestamp,
   UUID,
 } from "jsr:@lucsoft/web-bson@^0.3.1";
-export { crypto as stdCrypto } from "jsr:@std/crypto@^0.220.1/crypto";
-export { decodeBase64, encodeBase64 } from "jsr:@std/encoding@^0.220.1/base64";
-export { encodeHex } from "jsr:@std/encoding@^0.220.1/hex";
+export { crypto as stdCrypto } from "jsr:@std/crypto@^0.224.0/crypto";
+export { decodeBase64, encodeBase64 } from "jsr:@std/encoding@^0.224.0/base64";
+export { encodeHex } from "jsr:@std/encoding@^0.224.0/hex";

mod.ts

@@ -1,3 +1,34 @@
+/**
+ * @module
+ *
+ * # deno_mongo
+ *
+ * **deno_mongo** is a **MongoDB** driver for Deno which also supports Deno Deploy.
+ *
+ * ## ATTENTION
+ *
+ * Deno has support for npm modules now, so you can also use `npm:mongodb`.
+ * See [this](https://github.com/denodrivers/mongo/issues/380) for more details.
+ *
+ * ## Usage
+ *
+ * Replace `version` with the latest version of the driver.
+ *
+ * ```ts
+ * import { MongoClient } from 'jsr:@db/mongo@version';
+ * ```
+ *
+ * See [the README](https://github.com/denodrivers/mongo) for more examples.
+ *
+ * ## Other community resources and examples
+ *
+ * - [atlas_sdk](https://deno.land/x/atlas_sdk) - TypeSafe MongoDB Atlas SDK
+ * - [dangoDB](https://github.com/oslabs-beta/dangoDB) - MongoDB ORM for Deno
+ * - [deno-deploy-mongo](https://github.com/erfanium/deno-deploy-mongo) - A simple app with Deno, MongoDB, and Oak using MongoDB Atlas
+ * - [deno_rest](https://github.com/vicky-gonsalves/deno_rest) - An Oak-based template for RESTful APIs using this driver
+ * - [denomongo-unittest-utils](https://github.com/Gang-of-Fork/denomongo-unittest-utils) - Mock collection for unit tests
+ */
+
 export {
   Binary,
   BSONRegExp,

src/auth/base.ts

@@ -1,5 +1,5 @@
-import { WireProtocol } from "../protocol/mod.ts";
-import { ConnectOptions, Credential, Document } from "../types.ts";
+import type { WireProtocol } from "../protocol/mod.ts";
+import type { ConnectOptions, Credential, Document } from "../types.ts";
 
 export abstract class AuthPlugin {
   abstract auth(authContext: AuthContext): Document;

src/auth/scram.ts

@@ -6,11 +6,11 @@ import {
   stdCrypto,
 } from "../../deps.ts";
 import { MongoDriverError } from "../error.ts";
-import { HandshakeDocument } from "../protocol/handshake.ts";
+import type { HandshakeDocument } from "../protocol/handshake.ts";
 import { driverMetadata } from "../protocol/mod.ts";
-import { Credential, Document } from "../types.ts";
+import type { Credential, Document } from "../types.ts";
 import { saslprep } from "../utils/saslprep/mod.ts";
-import { AuthContext, AuthPlugin } from "./base.ts";
+import { type AuthContext, AuthPlugin } from "./base.ts";
 import { pbkdf2 } from "./pbkdf2.ts";
 
 type CryptoMethod = "sha1" | "sha256";

src/auth/x509.ts

@@ -1,7 +1,7 @@
-import { HandshakeDocument } from "../protocol/handshake.ts";
+import type { HandshakeDocument } from "../protocol/handshake.ts";
 import { driverMetadata } from "../protocol/mod.ts";
-import { Credential, Document } from "../types.ts";
-import { AuthContext, AuthPlugin } from "./base.ts";
+import type { Credential, Document } from "../types.ts";
+import { type AuthContext, AuthPlugin } from "./base.ts";
 
 export interface X509Command extends Document {
   authenticate: number;

src/client.ts

@@ -1,7 +1,7 @@
 import { Cluster } from "./cluster.ts";
 import { Database } from "./database.ts";
 import { MongoDriverError } from "./error.ts";
-import {
+import type {
   BuildInfo,
   ConnectOptions,
   Document,

src/cluster.ts

@@ -1,7 +1,7 @@
 import { AuthContext, ScramAuthPlugin, X509AuthPlugin } from "./auth/mod.ts";
 import { MongoDriverError } from "./error.ts";
 import { WireProtocol } from "./protocol/mod.ts";
-import { ConnectOptions, Server } from "./types.ts";
+import type { ConnectOptions, Server } from "./types.ts";
 
 export class Cluster {
   #options: ConnectOptions;

src/collection/collection.ts

@@ -4,8 +4,8 @@ import {
   MongoInvalidArgumentError,
   MongoServerError,
 } from "../error.ts";
-import { WireProtocol } from "../protocol/mod.ts";
-import {
+import type { WireProtocol } from "../protocol/mod.ts";
+import type {
   AggregateOptions,
   AggregatePipeline,
   CountOptions,

src/collection/commands/aggregate.ts

@@ -1,6 +1,6 @@
 import { CommandCursor } from "../../protocol/cursor.ts";
-import { WireProtocol } from "../../protocol/protocol.ts";
-import { AggregateOptions, Document } from "../../types.ts";
+import type { WireProtocol } from "../../protocol/protocol.ts";
+import type { AggregateOptions, Document } from "../../types.ts";
 
 interface AggregateCursorContext {
   dbName: string;

src/collection/commands/find.ts

@@ -1,5 +1,5 @@
-import { CommandCursor, WireProtocol } from "../../protocol/mod.ts";
-import { Document, FindOptions } from "../../types.ts";
+import { CommandCursor, type WireProtocol } from "../../protocol/mod.ts";
+import type { Document, FindOptions } from "../../types.ts";
 
 interface FindCursorContext {
   dbName: string;

src/collection/commands/list_indexes.ts

@@ -1,4 +1,4 @@
-import { CommandCursor, WireProtocol } from "../../protocol/mod.ts";
+import { CommandCursor, type WireProtocol } from "../../protocol/mod.ts";
 
 interface ListIndexesCursorContext {
   dbName: string;

src/collection/commands/update.ts

@@ -1,6 +1,6 @@
-import { ObjectId } from "../../../deps.ts";
-import { WireProtocol } from "../../protocol/mod.ts";
-import { Document, UpdateOptions } from "../../types.ts";
+import type { ObjectId } from "../../../deps.ts";
+import type { WireProtocol } from "../../protocol/mod.ts";
+import type { Document, UpdateOptions } from "../../types.ts";
 
 interface UpdateResponse {
   ok: number;

src/database.ts

@@ -1,12 +1,12 @@
-import { Cluster } from "./cluster.ts";
+import type { Cluster } from "./cluster.ts";
 import { Collection } from "./collection/mod.ts";
 import { CommandCursor } from "./protocol/mod.ts";
-import {
+import type {
   CreateCollectionOptions,
   CreateUserOptions,
   Document,
 } from "./types.ts";
-import { WriteConcern } from "./types/read_write_concern.ts";
+import type { WriteConcern } from "./types/read_write_concern.ts";
 
 interface ListCollectionsReponse {
   cursor: {

src/gridfs/bucket.ts

@@ -1,10 +1,10 @@
 import { ObjectId } from "../../deps.ts";
-import { Collection } from "../collection/collection.ts";
-import { FindCursor } from "../collection/commands/find.ts";
-import { Database } from "../database.ts";
+import type { Collection } from "../collection/collection.ts";
+import type { FindCursor } from "../collection/commands/find.ts";
+import type { Database } from "../database.ts";
 import { MongoRuntimeError } from "../error.ts";
-import { Filter } from "../types.ts";
-import {
+import type { Filter } from "../types.ts";
+import type {
   Chunk,
   File,
   FileId,

src/gridfs/indexes.ts

@@ -1,6 +1,6 @@
-import { Collection } from "../collection/collection.ts";
-import { Document, IndexOptions } from "../types.ts";
-import { Chunk, File } from "../types/gridfs.ts";
+import type { Collection } from "../collection/collection.ts";
+import type { Document, IndexOptions } from "../types.ts";
+import type { Chunk, File } from "../types/gridfs.ts";
 
 async function ensureIndex<T extends Document>(
   index: IndexOptions,

src/gridfs/upload.ts

@@ -1,6 +1,6 @@
-import { Binary, ObjectId } from "../../deps.ts";
-import { Collection } from "../collection/mod.ts";
-import { Chunk, File, GridFSUploadOptions } from "../types/gridfs.ts";
+import { Binary, type ObjectId } from "../../deps.ts";
+import type { Collection } from "../collection/mod.ts";
+import type { Chunk, File, GridFSUploadOptions } from "../types/gridfs.ts";
 
 export interface BucketInfo {
   filesCollection: Collection<File>;

src/protocol/cursor.ts

@@ -1,7 +1,7 @@
 import { Long } from "../../deps.ts";
-import { Document } from "../types.ts";
+import type { Document } from "../types.ts";
 import { parseNamespace } from "../utils/ns.ts";
-import { WireProtocol } from "./protocol.ts";
+import type { WireProtocol } from "./protocol.ts";
 
 export interface CommandCursorOptions<T> {
   id: bigint | number | string;

src/protocol/handshake.ts

@@ -1,5 +1,5 @@
-import { Document } from "../types.ts";
-import { WireProtocol } from "./protocol.ts";
+import type { Document } from "../types.ts";
+import type { WireProtocol } from "./protocol.ts";
 
 export const driverMetadata = {
   driver: {

src/protocol/message.ts

@@ -1,6 +1,6 @@
 import { deserialize, serialize } from "../../deps.ts";
-import { Document } from "../types.ts";
-import { MessageHeader, OpCode, setHeader } from "./header.ts";
+import type { Document } from "../types.ts";
+import { type MessageHeader, OpCode, setHeader } from "./header.ts";
 
 type MessageFlags = number;
 

src/protocol/protocol.ts

@@ -1,12 +1,16 @@
 import {
   MongoDriverError,
-  MongoErrorInfo,
+  type MongoErrorInfo,
   MongoServerError,
 } from "../error.ts";
-import { Document } from "../types.ts";
+import type { Document } from "../types.ts";
 import { handshake } from "./handshake.ts";
 import { parseHeader } from "./header.ts";
-import { deserializeMessage, Message, serializeMessage } from "./message.ts";
+import {
+  deserializeMessage,
+  type Message,
+  serializeMessage,
+} from "./message.ts";
 
 interface CommandTask {
   requestId: number;

src/types.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   Binary,
   BSONRegExp,
   Decimal128,
@@ -8,14 +8,14 @@ import {
   ObjectId,
   Timestamp,
 } from "../deps.ts";
-import {
+import type {
   $geoAny,
   $geoMultiPolygon,
   $geoPolygon,
   CenterSpecifier,
   ShapeOperator,
 } from "./types/geospatial.ts";
-import { WriteConcern } from "./types/read_write_concern.ts";
+import type { WriteConcern } from "./types/read_write_concern.ts";
 
 /**
  * The types used by the MongoDB driver.

src/types/geospatial.ts

@@ -1,5 +1,5 @@
-import { Document } from "../types.ts";
-import {
+import type { Document } from "../types.ts";
+import type {
   GeoJsonObject,
   GeometryCollection,
   GeometryObject,

src/types/gridfs.ts

@@ -1,6 +1,6 @@
-import { Binary, ObjectId } from "../../deps.ts";
-import { Document, ReadPreference } from "../types.ts";
-import { ReadConcern, WriteConcern } from "../types/read_write_concern.ts";
+import type { Binary, ObjectId } from "../../deps.ts";
+import type { Document, ReadPreference } from "../types.ts";
+import type { ReadConcern, WriteConcern } from "../types/read_write_concern.ts";
 
 export type FileId = ObjectId;
 

src/utils/saslprep/mod.ts

@@ -3,7 +3,7 @@
 //ORIGINAL PROJECT AND LICENSE IN: https://github.com/chiefbiiko/sparse-bitfield
 //ORIGINAL PROJECT AND LICENSE IN: https://github.com/chiefbiiko/memory-pager
 import { loadCodePoints } from "./load_code_points.ts";
-import { Bitfield } from "./sparse_bitfield.ts";
+import type { Bitfield } from "./sparse_bitfield.ts";
 
 const {
   unassigned_code_points,

src/utils/saslprep/sparse_bitfield.ts

@@ -1,4 +1,4 @@
-import { Page, Pager } from "./memory_pager.ts";
+import { type Page, Pager } from "./memory_pager.ts";
 
 /** Is the given number a power of two? */
 function powerOfTwo(x: number): boolean {

src/utils/srv.ts

@@ -1,4 +1,4 @@
-import { ConnectOptions } from "../types.ts";
+import type { ConnectOptions } from "../types.ts";
 import { parseSrvUrl } from "./uri.ts";
 
 enum AllowedOption {

src/utils/uri.ts

@@ -1,5 +1,5 @@
 // mongodb://username:[email protected]:27017,example2.com:27017,...,example.comN:27017/database?key=value&keyN=valueN
-import { ConnectOptions, Credential, Server } from "../types.ts";
+import type { ConnectOptions, Credential, Server } from "../types.ts";
 import { Srv } from "./srv.ts";
 
 interface Parts {

tests/cases/01_auth.ts

@@ -1,4 +1,4 @@
-import { Database } from "../../mod.ts";
+import type { Database } from "../../mod.ts";
 import {
   cleanUsername,
   clientFirstMessageBare,

tests/cases/03_crud.ts

@@ -1,9 +1,9 @@
-import { Database, MongoClient, ObjectId } from "../../mod.ts";
+import type { Database, MongoClient, ObjectId } from "../../mod.ts";
 import {
   MongoInvalidArgumentError,
   MongoServerError,
 } from "../../src/error.ts";
-import { CreateCollectionOptions } from "../../src/types.ts";
+import type { CreateCollectionOptions } from "../../src/types.ts";
 import { cleanTestDb, getTestDb } from "../common.ts";
 import {
   afterEach,