Fix Javascript type & other PHP types (mongodb#4)

Author: GromNaN

generator/config/expression/bsonSize.yaml

@@ -5,7 +5,7 @@ type:
     - resolvesToInt
 encode: single
 description: |
-    Returns the size in bytes of a given document (i.e. bsontype Object) when encoded as BSON.
+    Returns the size in bytes of a given document (i.e. BSON type Object) when encoded as BSON.
 arguments:
     -
         name: object

generator/config/expression/function.yaml

@@ -11,9 +11,10 @@ arguments:
     -
         name: body
         type:
-            - string
+            - javascript
         description: |
-            The function definition. You can specify the function definition as either BSON type Code or String.
+            The function definition. You can specify the function definition as either BSON\JavaScript or string.
+            function(arg1, arg2, ...) { ... }
     -
         name: args
         type:
@@ -24,3 +25,4 @@ arguments:
         name: lang
         type:
             - string
+        default: js

generator/config/query/natural.yaml

@@ -1,8 +1,8 @@
 # $schema: ../schema.json
 name: $natural
-link: 'https://www.mongodb.com/docs/v7.0/reference/operator/meta/natural/'
+link: 'https://www.mongodb.com/docs/manual/reference/operator/meta/natural/'
 type:
-    - expression
+    - projection # @todo: used in sort
 encode: object
 description: |
     A special hint that can be provided via the sort() or hint() methods that can be used to force either a forward or reverse collection scan.

generator/config/query/rand.yaml

@@ -2,7 +2,7 @@
 name: $rand
 link: 'https://www.mongodb.com/docs/manual/reference/operator/query/rand/'
 type:
-    - expression
+    - resolvesToDouble
 encode: object
 description: |
     Generates a random float between 0 and 1.

generator/config/query/where.yaml

@@ -10,4 +10,4 @@ arguments:
     -
         name: function
         type:
-            - string
+            - javascript

generator/config/schema.json

@@ -9,7 +9,7 @@
                 "name": {
                     "$comment": "The name of the operator. Must start with a $",
                     "type": "string",
-                    "pattern": "^\\$[a-z][a-zA-Z]+$"
+                    "pattern": "^\\$[a-z0-9][a-zA-Z0-9]*$"
                 },
                 "link": {
                     "$comment": "The link to the operator's documentation on MongoDB's website.",
@@ -28,6 +28,7 @@
                             "projection",
                             "stage",
                             "query",
+                            "fieldQuery",
                             "filter",
                             "window",
                             "geometry",
@@ -92,7 +93,7 @@
             "properties": {
                 "name": {
                     "type": "string",
-                    "pattern": "^([a-z][a-zA-Z0-9]*|N)$"
+                    "pattern": "^(_?[a-z][a-zA-Z0-9]*|N)$"
                 },
                 "type": {
                     "type": "array",
@@ -105,6 +106,8 @@
                             "window",
                             "expression",
                             "geometry",
+                            "projection",
+                            "fieldPath",
                             "any",
                             "resolvesToNumber", "numberFieldPath", "number",
                             "resolvesToDouble", "doubleFieldPath", "double",
@@ -120,7 +123,7 @@
                             "resolvesToJavascript", "javascriptFieldPath", "javascript",
                             "resolvesToInt", "intFieldPath", "int",
                             "resolvesToTimestamp", "timestampFieldPath", "timestamp",
-                            "resolvesTolong", "longFieldPath", "long",
+                            "resolvesToLong", "longFieldPath", "long",
                             "resolvesToDecimal", "decimalFieldPath", "decimal"
                         ]
                     }
@@ -153,6 +156,10 @@
                     "$comment": "The minimum number of arguments for a variadic parameter.",
                     "type": "integer",
                     "minimum": 0
+                },
+                "default": {
+                    "$comment": "The default value for the argument.",
+                    "type": ["string", "number", "boolean"]
                 }
             },
             "required": [

generator/config/stage/changeStream.yaml

@@ -17,14 +17,14 @@ arguments:
     -
         name: fullDocument
         type:
-            - FullDocument
+            - string # FullDocument
         optional: true
         description: |
             Specifies whether change notifications include a copy of the full document when modified by update operations.
     -
         name: fullDocumentBeforeChange
         type:
-            - FullDocumentBeforeChange
+            - string # FullDocumentBeforeChange
         optional: true
         description: |
             Valid values are "off", "whenAvailable", or "required". If set to "off", the "fullDocumentBeforeChange" field of the output document is always omitted. If set to "whenAvailable", the "fullDocumentBeforeChange" field will be populated with the pre-image of the document modified by the current change event if such a pre-image is available, and will be omitted otherwise. If set to "required", then the "fullDocumentBeforeChange" field is always populated and an exception is thrown if the pre-image is not              available.

generator/config/stage/lookup.yaml

@@ -44,7 +44,7 @@ arguments:
         optional: true
         description: |
             Specifies the pipeline to run on the joined collection. The pipeline determines the resulting documents from the joined collection. To return all documents, specify an empty pipeline [].
-            The pipeline cannot include the $out stage or the $mergestage. Starting in v6.0, the pipeline can contain the Atlas Search $search stage as the first stage inside the pipeline.
+            The pipeline cannot include the $out stage or the $merge stage. Starting in v6.0, the pipeline can contain the Atlas Search $search stage as the first stage inside the pipeline.
             The pipeline cannot directly access the joined document fields. Instead, define variables for the joined document fields using the let option and then reference the variables in the pipeline stages.
     -
         name: as

generator/config/stage/merge.yaml

@@ -40,7 +40,7 @@ arguments:
     -
         name: whenNotMatched
         type:
-            - WhenNotMatched
+            - string # WhenNotMatched
         optional: true
         description: |
             The behavior of $merge if a result document does not match an existing document in the out collection.

generator/config/stage/setWindowFields.yaml

@@ -17,7 +17,7 @@ arguments:
     -
         name: sortBy
         type:
-            - SortSpec
+            - object # SortSpec
         description: |
             Specifies the field(s) to sort the documents by in the partition. Uses the same syntax as the $sort stage. Default is no sorting.
     -
@@ -30,7 +30,7 @@ arguments:
     -
         name: window
         type:
-            - Window
+            - window
         optional: true
         description: |
             Specifies the window boundaries and parameters. Window boundaries are inclusive. Default is an unbounded window, which includes all documents in the partition.

generator/config/stage/sort.yaml

@@ -10,4 +10,4 @@ arguments:
     -
         name: sort
         type:
-            - SortSpec
+            - object # SortSpec

generator/src/Definition/ArgumentDefinition.php

@@ -18,13 +18,15 @@ final class ArgumentDefinition
 
     public function __construct(
         public string $name,
-        /** @psalm-assert list<string> $type */
+        /** @var list<string> */
         public array $type,
         public string|null $description = null,
         public bool $optional = false,
         string|null $variadic = null,
         int|null $variadicMin = null,
+        public mixed $default = null,
     ) {
+        assert($this->optional === false || $this->default === null, 'Optional arguments cannot have a default value');
         if (is_array($type)) {
             assert(array_is_list($type), 'Type must be a list or a single string');
             foreach ($type as $t) {

generator/src/Definition/OperatorDefinition.php

@@ -23,6 +23,7 @@ public function __construct(
         public string $name,
         public string $link,
         string $encode,
+        /** @var list<string> */
         public array $type,
         public string|null $description = null,
         array $arguments = [],

generator/src/ExpressionFactoryGenerator.php

@@ -13,7 +13,7 @@
 
 final class ExpressionFactoryGenerator extends AbstractGenerator
 {
-    /** @param array<class-string, ExpressionDefinition> $definitions */
+    /** @param array<string, ExpressionDefinition> $expressions */
     public function generate(array $expressions): void
     {
         $this->writeFile($this->createFactoryClass($expressions));

generator/src/OperatorClassGenerator.php

@@ -86,7 +86,7 @@ public function createClass(GeneratorDefinition $definition, OperatorDefinition
 
                 if ($argument->variadic === VariadicType::Array) {
                     $property->setType('array');
-                    $property->addComment('@var list<' . $type->doc . '> ...$' . $argument->name . rtrim(' ' . $argument->description));
+                    $property->addComment('@var list<' . $type->doc . '> $' . $argument->name . rtrim(' ' . $argument->description));
                     // Warn that named arguments are not supported
                     // @see https://psalm.dev/docs/running_psalm/issues/NamedArgumentNotAllowed/
                     $constuctor->addComment('@no-named-arguments');
@@ -100,7 +100,7 @@ public function createClass(GeneratorDefinition $definition, OperatorDefinition
                 } elseif ($argument->variadic === VariadicType::Object) {
                     $namespace->addUse(stdClass::class);
                     $property->setType(stdClass::class);
-                    $property->addComment('@var stdClass<' . $type->doc . '> ...$' . $argument->name . rtrim(' ' . $argument->description));
+                    $property->addComment('@var stdClass<' . $type->doc . '> $' . $argument->name . rtrim(' ' . $argument->description));
                     $namespace->addUseFunction('is_string');
                     $namespace->addUse(InvalidArgumentException::class);
                     $constuctor->addBody(<<<PHP
@@ -121,6 +121,8 @@ public function createClass(GeneratorDefinition $definition, OperatorDefinition
                 if ($argument->optional) {
                     // We use a special Optional::Undefined type to differentiate between null and undefined
                     $constuctorParam->setDefaultValue(new Literal('Optional::Undefined'));
+                } elseif ($argument->default !== null) {
+                    $constuctorParam->setDefaultValue($argument->default);
                 }
 
                 // List type must be validated with array_is_list()
@@ -162,6 +164,8 @@ public function createClass(GeneratorDefinition $definition, OperatorDefinition
 
     /**
      * Operator classes interfaces are defined by their return type as a MongoDB expression.
+     *
+     * @return list<class-string>
      */
     private function getInterfaces(OperatorDefinition $definition): array
     {

generator/src/OperatorGenerator.php

@@ -45,6 +45,7 @@ final public function __construct(
 
     abstract public function generate(GeneratorDefinition $definition): void;
 
+    /** @return list<array<string, mixed>> */
     final protected function getOperators(GeneratorDefinition $definition): array
     {
         // Remove unsupported operators

phpcs.xml.dist

@@ -24,6 +24,9 @@
     <!-- Import rules from doctrine/coding-standard -->
     <!-- ****************************************** -->
     <rule ref="Doctrine">
+        <exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming.SuperfluousSuffix"/>
+        <exclude name="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming.SuperfluousPrefix"/>
+
         <!-- **************************************** -->
         <!-- Exclude sniffs that force unwanted style -->
         <!-- **************************************** -->

psalm-baseline.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="5.15.0@5c774aca4746caf3d239d9c8cadb9f882ca29352">
+</files>

psalm.xml.dist

@@ -12,7 +12,6 @@
 >
     <projectFiles>
         <directory name="src" />
-        <directory name="examples" />
         <ignoreFiles>
             <directory name="vendor" />
         </ignoreFiles>

src/Builder/Accumulator.php

@@ -21,6 +21,12 @@ enum Accumulator
 {
     use Accumulator\FactoryTrait;
 
+    /**
+     * @param Document|Serializable|WindowInterface|array<string, mixed>|stdClass $operator  Window operator to use in the $setWindowFields stage.
+     * @param Optional|array{string|int,string|int}                               $documents A window where the lower and upper boundaries are specified relative to the position of the current document read from the collection.
+     * @param Optional|array{string|numeric,string|numeric}                       $range     Arguments passed to the init function.
+     * @param Optional|non-empty-string                                           $unit      Specifies the units for time range window boundaries. If omitted, default numeric range window boundaries are used.
+     */
     public static function outputWindow(
         Document|Serializable|WindowInterface|stdClass|array $operator,
         Optional|array $documents = Optional::Undefined,

src/Builder/Accumulator/MergeObjectsAccumulator.php

@@ -244,7 +244,7 @@ private function encodeOutputWindow(OutputWindow $outputWindow): stdClass
         // Transform the result into an stdClass if a document is provided
         if (! $outputWindow->operator instanceof WindowInterface && (is_array($result) || is_object($result))) {
             if (! is_first_key_operator($result)) {
-                throw new LogicException(sprintf('Expected OutputWindow::$operator to be an operator. Got "%s"', array_key_first($result)));
+                throw new LogicException(sprintf('Expected OutputWindow::$operator to be an operator. Got "%s"', array_key_first((array) $result)));
             }
 
             $result = (object) $result;