feat: rename ejson-shell-parser to @mongodb-js/shell-bson-parser (#…

…396)
mongodb-js · Jul 9, 2024 · 37f3bf9 · 37f3bf9
1 parent 58a36ff
commit 37f3bf9
Show file tree

Hide file tree

Showing 22 changed files with 122 additions and 93 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/query-parser/MIGRATION.md b/packages/query-parser/MIGRATION.md
@@ -29,7 +29,7 @@ Please refer to [the list of BSON changes](https://github.com/mongodb/js-bson/bl
 
 MongoDB Query Parser was making use of [`safer-eval`](https://www.npmjs.com/package/safer-eval) to parse difficult queries, which has been removed as this dependency is insecure.
 
-We've replaced this dependency with [`ejson-shell-parser`](https://github.com/mongodb-js/ejson-shell-parser), which instead walks the AST of the query, and only attempts to evaluate the query if it considered safe and well-formed.
+We've replaced this dependency with [`@mongodb-js/shell-bson-parser`](https://github.com/mongodb-js/devtools-shared/tree/main/packages/shell-bson-parser), which instead walks the AST of the query, and only attempts to evaluate the query if it considered safe and well-formed.
 
 Because of this change, some queries that would validate are no longer valid.
 

diff --git a/packages/query-parser/package.json b/packages/query-parser/package.json
@@ -47,7 +47,7 @@
   },
   "dependencies": {
     "debug": "^4.3.4",
-    "ejson-shell-parser": "^2.0.2",
+    "@mongodb-js/shell-bson-parser": "^1.0.0",
     "javascript-stringify": "^2.1.0",
     "lodash": "^4.17.21"
   },

diff --git a/packages/query-parser/src/index.ts b/packages/query-parser/src/index.ts
@@ -1,4 +1,6 @@
-import parseShellStringToEJSON, { ParseMode } from 'ejson-shell-parser';
+import parseShellStringToEJSON, {
+  ParseMode,
+} from '@mongodb-js/shell-bson-parser';
 
 import _ from 'lodash';
 import _debug from 'debug';

diff --git a/packages/ejson-shell-parser/.depcheckrc → packages/shell-bson-parser/.depcheckrc b/packages/ejson-shell-parser/.depcheckrc → packages/shell-bson-parser/.depcheckrc
diff --git a/packages/ejson-shell-parser/.eslintignore → packages/shell-bson-parser/.eslintignore b/packages/ejson-shell-parser/.eslintignore → packages/shell-bson-parser/.eslintignore
diff --git a/packages/ejson-shell-parser/.eslintrc.js → packages/shell-bson-parser/.eslintrc.js b/packages/ejson-shell-parser/.eslintrc.js → packages/shell-bson-parser/.eslintrc.js
diff --git a/packages/ejson-shell-parser/.mocharc.js → packages/shell-bson-parser/.mocharc.js b/packages/ejson-shell-parser/.mocharc.js → packages/shell-bson-parser/.mocharc.js
diff --git a/packages/ejson-shell-parser/.prettierignore → packages/shell-bson-parser/.prettierignore b/packages/ejson-shell-parser/.prettierignore → packages/shell-bson-parser/.prettierignore
diff --git a/packages/ejson-shell-parser/.prettierrc.json → packages/shell-bson-parser/.prettierrc.json b/packages/ejson-shell-parser/.prettierrc.json → packages/shell-bson-parser/.prettierrc.json
diff --git a/packages/ejson-shell-parser/LICENSE → packages/shell-bson-parser/LICENSE b/packages/ejson-shell-parser/LICENSE → packages/shell-bson-parser/LICENSE
diff --git a/packages/ejson-shell-parser/README.md → packages/shell-bson-parser/README.md b/packages/ejson-shell-parser/README.md → packages/shell-bson-parser/README.md
@@ -1,8 +1,4 @@
-# ejson-shell-parser
-
-> [!CAUTION]
-> Despite its name, this package does _not_ handle MongoDB Extended JSON (EJSON). It only parses shell syntax representations of BSON.
-> For example, it parses `ObjectId("668d112bafd4c98000a17f44")` but not `{ "$oid": "668d112bafd4c98000a17f44" }`.
+# @mongodb-js/shell-bson-parser
 
 Parses valid MongoDB Shell queries.
 This library does not validate that these queries are correct. It's focus is on parsing untrusted input. You may wish to use something like https://github.com/mongodb-js/mongodb-language-model to achieve this.
@@ -14,7 +10,7 @@ This library currently supports three different modes for parsing queries:
 **strict**: [default] Disallows comments and calling methods
 
 ```javascript
-import parse from 'ejson-shell-parser';
+import parse from '@mongodb-js/shell-bson-parser';
 
 const query = parse(
   `{
@@ -33,7 +29,7 @@ const query = parse(
 **weak**: Disallows comments, allows calling methods
 
 ```javascript
-import parse from 'ejson-shell-parser';
+import parse from '@mongodb-js/shell-bson-parser';
 
 const query = parse(
   `{
@@ -51,7 +47,7 @@ const query = parse(
 **loose**: Supports calling methods on Math, Date and ISODate, allows comments
 
 ```javascript
-import parse from 'ejson-shell-parser';
+import parse from '@mongodb-js/shell-bson-parser';
 
 const query = parse(
   `{

diff --git a/...son-shell-parser/benchmark/performance.js → ...hell-bson-parser/benchmark/performance.js b/...son-shell-parser/benchmark/performance.js → ...hell-bson-parser/benchmark/performance.js
diff --git a/packages/ejson-shell-parser/package.json → packages/shell-bson-parser/package.json b/packages/ejson-shell-parser/package.json → packages/shell-bson-parser/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "ejson-shell-parser",
+  "name": "@mongodb-js/shell-bson-parser",
   "description": "Parse valid MongoDB shell syntax queries",
   "author": {
     "name": "MongoDB Inc",
@@ -13,7 +13,7 @@
     "email": "[email protected]"
   },
   "homepage": "https://github.com/mongodb-js/devtools-shared",
-  "version": "2.0.2",
+  "version": "1.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/mongodb-js/devtools-shared.git"

diff --git a/packages/ejson-shell-parser/src/check.ts → packages/shell-bson-parser/src/check.ts b/packages/ejson-shell-parser/src/check.ts → packages/shell-bson-parser/src/check.ts
diff --git a/packages/ejson-shell-parser/src/eval.ts → packages/shell-bson-parser/src/eval.ts b/packages/ejson-shell-parser/src/eval.ts → packages/shell-bson-parser/src/eval.ts
diff --git a/...ages/ejson-shell-parser/src/index.spec.ts → packages/shell-bson-parser/src/index.spec.ts b/...ages/ejson-shell-parser/src/index.spec.ts → packages/shell-bson-parser/src/index.spec.ts
@@ -6,7 +6,7 @@ import { expect } from 'chai';
 import type { SinonSandbox } from 'sinon';
 import { createSandbox } from 'sinon';
 
-describe('ejson-shell-parser', function () {
+describe('@mongodb-js/shell-bson-parser', function () {
   it('should correctly parse a valid object', function () {
     expect(parse('{_id:"hello"}')).to.deep.equal({ _id: 'hello' });
   });

diff --git a/packages/ejson-shell-parser/src/index.ts → packages/shell-bson-parser/src/index.ts b/packages/ejson-shell-parser/src/index.ts → packages/shell-bson-parser/src/index.ts
diff --git a/packages/ejson-shell-parser/src/options.ts → packages/shell-bson-parser/src/options.ts b/packages/ejson-shell-parser/src/options.ts → packages/shell-bson-parser/src/options.ts
diff --git a/packages/ejson-shell-parser/src/scope.ts → packages/shell-bson-parser/src/scope.ts b/packages/ejson-shell-parser/src/scope.ts → packages/shell-bson-parser/src/scope.ts
diff --git a/...ges/ejson-shell-parser/tsconfig-lint.json → ...ages/shell-bson-parser/tsconfig-lint.json b/...ges/ejson-shell-parser/tsconfig-lint.json → ...ages/shell-bson-parser/tsconfig-lint.json
diff --git a/packages/ejson-shell-parser/tsconfig.json → packages/shell-bson-parser/tsconfig.json b/packages/ejson-shell-parser/tsconfig.json → packages/shell-bson-parser/tsconfig.json