@mongosh/shell-api 3.16.0 → 3.16.2

package/lib/api-processed.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 
 import type { Agent } from 'https';
-import type { AutocompletionContext } from '@mongodb-js/mongodb-ts-autocomplete';
 import { Binary } from 'bson';
 import { BSONRegExp } from 'bson';
 import { BSONSymbol } from 'bson';
@@ -825,6 +824,16 @@ declare interface AutocompleteParameters {
   getCollectionCompletionsForCurrentDb: (collName: string) => Promise<string[]>;
   getDatabaseCompletions: (dbName: string) => Promise<string[]>;
 }
+declare interface AutocompletionContext {
+  currentDatabaseAndConnection(): {
+    connectionId: string;
+    databaseName: string;
+  } | undefined;
+  databasesForConnection(connectionId: string): Promise<string[]>;
+  collectionsForDatabase(connectionId: string, databaseName: string): Promise<string[]>;
+  schemaInformationForCollection(connectionId: string, databaseName: string, collectionName: string): Promise<JSONSchema>;
+  cacheOptions?: Partial<CacheOptions>;
+}
 
 /** @public */
 declare const AutoEncryptionLoggerLevel: Readonly<{
@@ -1371,6 +1380,11 @@ declare class BulkWriteResult_2 extends ShellApiValueClass {
     [index: number]: ObjectId;
   });
 }
+declare type CacheOptions = {
+  databaseCollectionsTTL: number;
+  collectionSchemaTTL: number;
+  aggregationSchemaTTL: number;
+};
 
 /** @public */
 declare class CancellationToken extends TypedEventEmitter<{
@@ -6412,6 +6426,214 @@ declare interface InterruptWatcher {
 
 /** @public */
 declare type IsAny<Type, ResultIfAny, ResultIfNotAny> = true extends false & Type ? ResultIfAny : ResultIfNotAny;
+declare type JSONSchema = Partial<JSONSchema4> & MongoDBJSONSchema;
+
+/**
+ * JSON Schema V4
+ * @see https://tools.ietf.org/html/draft-zyp-json-schema-04
+ */
+declare interface JSONSchema4 {
+  id?: string | undefined;
+  $ref?: string | undefined;
+  $schema?: JSONSchema4Version | undefined;
+
+  /**
+   * This attribute is a string that provides a short description of the
+   * instance property.
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21
+   */
+  title?: string | undefined;
+
+  /**
+   * This attribute is a string that provides a full description of the of
+   * purpose the instance property.
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22
+   */
+  description?: string | undefined;
+  default?: JSONSchema4Type | undefined;
+  multipleOf?: number | undefined;
+  maximum?: number | undefined;
+  exclusiveMaximum?: boolean | undefined;
+  minimum?: number | undefined;
+  exclusiveMinimum?: boolean | undefined;
+  maxLength?: number | undefined;
+  minLength?: number | undefined;
+  pattern?: string | undefined;
+
+  /**
+   * May only be defined when "items" is defined, and is a tuple of JSONSchemas.
+   *
+   * This provides a definition for additional items in an array instance
+   * when tuple definitions of the items is provided.  This can be false
+   * to indicate additional items in the array are not allowed, or it can
+   * be a schema that defines the schema of the additional items.
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6
+   */
+  additionalItems?: boolean | JSONSchema4 | undefined;
+
+  /**
+   * This attribute defines the allowed items in an instance array, and
+   * MUST be a schema or an array of schemas.  The default value is an
+   * empty schema which allows any value for items in the instance array.
+   *
+   * When this attribute value is a schema and the instance value is an
+   * array, then all the items in the array MUST be valid according to the
+   * schema.
+   *
+   * When this attribute value is an array of schemas and the instance
+   * value is an array, each position in the instance array MUST conform
+   * to the schema in the corresponding position for this array.  This
+   * called tuple typing.  When tuple typing is used, additional items are
+   * allowed, disallowed, or constrained by the "additionalItems"
+   * (Section 5.6) attribute using the same rules as
+   * "additionalProperties" (Section 5.4) for objects.
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5
+   */
+  items?: JSONSchema4 | JSONSchema4[] | undefined;
+  maxItems?: number | undefined;
+  minItems?: number | undefined;
+  uniqueItems?: boolean | undefined;
+  maxProperties?: number | undefined;
+  minProperties?: number | undefined;
+
+  /**
+   * This attribute indicates if the instance must have a value, and not
+   * be undefined. This is false by default, making the instance
+   * optional.
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7
+   */
+  required?: boolean | string[] | undefined;
+
+  /**
+   * This attribute defines a schema for all properties that are not
+   * explicitly defined in an object type definition. If specified, the
+   * value MUST be a schema or a boolean. If false is provided, no
+   * additional properties are allowed beyond the properties defined in
+   * the schema. The default value is an empty schema which allows any
+   * value for additional properties.
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4
+   */
+  additionalProperties?: boolean | JSONSchema4 | undefined;
+  definitions?: {
+    [k: string]: JSONSchema4;
+  } | undefined;
+
+  /**
+   * This attribute is an object with property definitions that define the
+   * valid values of instance object property values. When the instance
+   * value is an object, the property values of the instance object MUST
+   * conform to the property definitions in this object. In this object,
+   * each property definition's value MUST be a schema, and the property's
+   * name MUST be the name of the instance property that it defines.  The
+   * instance property value MUST be valid according to the schema from
+   * the property definition. Properties are considered unordered, the
+   * order of the instance properties MAY be in any order.
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2
+   */
+  properties?: {
+    [k: string]: JSONSchema4;
+  } | undefined;
+
+  /**
+   * This attribute is an object that defines the schema for a set of
+   * property names of an object instance. The name of each property of
+   * this attribute's object is a regular expression pattern in the ECMA
+   * 262/Perl 5 format, while the value is a schema. If the pattern
+   * matches the name of a property on the instance object, the value of
+   * the instance's property MUST be valid against the pattern name's
+   * schema value.
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3
+   */
+  patternProperties?: {
+    [k: string]: JSONSchema4;
+  } | undefined;
+  dependencies?: {
+    [k: string]: JSONSchema4 | string[];
+  } | undefined;
+
+  /**
+   * This provides an enumeration of all possible values that are valid
+   * for the instance property. This MUST be an array, and each item in
+   * the array represents a possible value for the instance value. If
+   * this attribute is defined, the instance value MUST be one of the
+   * values in the array in order for the schema to be valid.
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19
+   */
+  enum?: JSONSchema4Type[] | undefined;
+
+  /**
+   * A single type, or a union of simple types
+   */
+  type?: JSONSchema4TypeName | JSONSchema4TypeName[] | undefined;
+  allOf?: JSONSchema4[] | undefined;
+  anyOf?: JSONSchema4[] | undefined;
+  oneOf?: JSONSchema4[] | undefined;
+  not?: JSONSchema4 | undefined;
+
+  /**
+   * The value of this property MUST be another schema which will provide
+   * a base schema which the current schema will inherit from.  The
+   * inheritance rules are such that any instance that is valid according
+   * to the current schema MUST be valid according to the referenced
+   * schema.  This MAY also be an array, in which case, the instance MUST
+   * be valid for all the schemas in the array.  A schema that extends
+   * another schema MAY define additional attributes, constrain existing
+   * attributes, or add other constraints.
+   *
+   * Conceptually, the behavior of extends can be seen as validating an
+   * instance against all constraints in the extending schema as well as
+   * the extended schema(s).
+   *
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26
+   */
+  extends?: string | string[] | undefined;
+
+  /**
+   * @see https://tools.ietf.org/html/draft-zyp-json-schema-04#section-5.6
+   */
+  [k: string]: any;
+  format?: string | undefined;
+}
+declare interface JSONSchema4Array extends Array<JSONSchema4Type> {}
+declare interface JSONSchema4Object {
+  [key: string]: JSONSchema4Type;
+}
+
+/**
+ * @see https://tools.ietf.org/html/draft-zyp-json-schema-04#section-3.5
+ */
+declare type JSONSchema4Type = string //
+| number | boolean | JSONSchema4Object | JSONSchema4Array | null;
+
+/**
+ * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
+ */
+declare type JSONSchema4TypeName = "string" //
+| "number" | "integer" | "boolean" | "object" | "array" | "null" | "any";
+
+/**
+ * Meta schema
+ *
+ * Recommended values:
+ * - 'http://json-schema.org/schema#'
+ * - 'http://json-schema.org/hyper-schema#'
+ * - 'http://json-schema.org/draft-04/schema#'
+ * - 'http://json-schema.org/draft-04/hyper-schema#'
+ * - 'http://json-schema.org/draft-03/schema#'
+ * - 'http://json-schema.org/draft-03/hyper-schema#'
+ *
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
+ */
+declare type JSONSchema4Version = string;
 
 /** @public */
 declare type KeysOfAType<TSchema, Type> = { [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type ? key : never }[keyof TSchema];
@@ -7253,6 +7475,12 @@ declare class MongoDBCollectionNamespace extends MongoDBNamespace {
   constructor(db: string, collection: string);
   static fromString(namespace?: string): MongoDBCollectionNamespace;
 }
+declare type MongoDBJSONSchema = Pick<StandardJSONSchema, 'title' | 'required' | 'description'> & {
+  bsonType?: string | string[];
+  properties?: Record<string, MongoDBJSONSchema>;
+  items?: MongoDBJSONSchema | MongoDBJSONSchema[];
+  anyOf?: MongoDBJSONSchema[];
+};
 
 /**
  * @public
@@ -9539,6 +9767,7 @@ declare type Sort = string | Exclude<SortDirection, {
 declare type SortDirection = 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending' | {
   $meta: string;
 };
+declare type StandardJSONSchema = JSONSchema4;
 declare interface StartLoadingCliScriptsEvent {
   usesShellOption: boolean;
 }

package/lib/api-raw.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 
 import type { Agent } from 'https';
-import type { AutocompletionContext } from '@mongodb-js/mongodb-ts-autocomplete';
 import { Binary } from 'bson';
 import { BSONRegExp } from 'bson';
 import { BSONSymbol } from 'bson';
@@ -820,6 +819,17 @@ declare interface AutocompleteParameters {
     getDatabaseCompletions: (dbName: string) => Promise<string[]>;
 }
 
+declare interface AutocompletionContext {
+    currentDatabaseAndConnection(): {
+        connectionId: string;
+        databaseName: string;
+    } | undefined;
+    databasesForConnection(connectionId: string): Promise<string[]>;
+    collectionsForDatabase(connectionId: string, databaseName: string): Promise<string[]>;
+    schemaInformationForCollection(connectionId: string, databaseName: string, collectionName: string): Promise<JSONSchema>;
+    cacheOptions?: Partial<CacheOptions>;
+}
+
 /** @public */
 declare const AutoEncryptionLoggerLevel: Readonly<{
     readonly FatalError: 0;
@@ -1323,6 +1333,12 @@ declare class BulkWriteResult_2 extends ShellApiValueClass {
     });
 }
 
+declare type CacheOptions = {
+    databaseCollectionsTTL: number;
+    collectionSchemaTTL: number;
+    aggregationSchemaTTL: number;
+};
+
 /** @public */
 declare class CancellationToken extends TypedEventEmitter<{
     cancel(): void;
@@ -5841,6 +5857,234 @@ declare interface InterruptWatcher {
 /** @public */
 declare type IsAny<Type, ResultIfAny, ResultIfNotAny> = true extends false & Type ? ResultIfAny : ResultIfNotAny;
 
+declare type JSONSchema = Partial<JSONSchema4> & MongoDBJSONSchema;
+
+/**
+ * JSON Schema V4
+ * @see https://tools.ietf.org/html/draft-zyp-json-schema-04
+ */
+declare interface JSONSchema4 {
+    id?: string | undefined;
+    $ref?: string | undefined;
+    $schema?: JSONSchema4Version | undefined;
+
+    /**
+     * This attribute is a string that provides a short description of the
+     * instance property.
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21
+     */
+    title?: string | undefined;
+
+    /**
+     * This attribute is a string that provides a full description of the of
+     * purpose the instance property.
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22
+     */
+    description?: string | undefined;
+
+    default?: JSONSchema4Type | undefined;
+    multipleOf?: number | undefined;
+    maximum?: number | undefined;
+    exclusiveMaximum?: boolean | undefined;
+    minimum?: number | undefined;
+    exclusiveMinimum?: boolean | undefined;
+    maxLength?: number | undefined;
+    minLength?: number | undefined;
+    pattern?: string | undefined;
+
+    /**
+     * May only be defined when "items" is defined, and is a tuple of JSONSchemas.
+     *
+     * This provides a definition for additional items in an array instance
+     * when tuple definitions of the items is provided.  This can be false
+     * to indicate additional items in the array are not allowed, or it can
+     * be a schema that defines the schema of the additional items.
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6
+     */
+    additionalItems?: boolean | JSONSchema4 | undefined;
+
+    /**
+     * This attribute defines the allowed items in an instance array, and
+     * MUST be a schema or an array of schemas.  The default value is an
+     * empty schema which allows any value for items in the instance array.
+     *
+     * When this attribute value is a schema and the instance value is an
+     * array, then all the items in the array MUST be valid according to the
+     * schema.
+     *
+     * When this attribute value is an array of schemas and the instance
+     * value is an array, each position in the instance array MUST conform
+     * to the schema in the corresponding position for this array.  This
+     * called tuple typing.  When tuple typing is used, additional items are
+     * allowed, disallowed, or constrained by the "additionalItems"
+     * (Section 5.6) attribute using the same rules as
+     * "additionalProperties" (Section 5.4) for objects.
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5
+     */
+    items?: JSONSchema4 | JSONSchema4[] | undefined;
+
+    maxItems?: number | undefined;
+    minItems?: number | undefined;
+    uniqueItems?: boolean | undefined;
+    maxProperties?: number | undefined;
+    minProperties?: number | undefined;
+
+    /**
+     * This attribute indicates if the instance must have a value, and not
+     * be undefined. This is false by default, making the instance
+     * optional.
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7
+     */
+    required?: boolean | string[] | undefined;
+
+    /**
+     * This attribute defines a schema for all properties that are not
+     * explicitly defined in an object type definition. If specified, the
+     * value MUST be a schema or a boolean. If false is provided, no
+     * additional properties are allowed beyond the properties defined in
+     * the schema. The default value is an empty schema which allows any
+     * value for additional properties.
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4
+     */
+    additionalProperties?: boolean | JSONSchema4 | undefined;
+
+    definitions?: {
+        [k: string]: JSONSchema4;
+    } | undefined;
+
+    /**
+     * This attribute is an object with property definitions that define the
+     * valid values of instance object property values. When the instance
+     * value is an object, the property values of the instance object MUST
+     * conform to the property definitions in this object. In this object,
+     * each property definition's value MUST be a schema, and the property's
+     * name MUST be the name of the instance property that it defines.  The
+     * instance property value MUST be valid according to the schema from
+     * the property definition. Properties are considered unordered, the
+     * order of the instance properties MAY be in any order.
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2
+     */
+    properties?: {
+        [k: string]: JSONSchema4;
+    } | undefined;
+
+    /**
+     * This attribute is an object that defines the schema for a set of
+     * property names of an object instance. The name of each property of
+     * this attribute's object is a regular expression pattern in the ECMA
+     * 262/Perl 5 format, while the value is a schema. If the pattern
+     * matches the name of a property on the instance object, the value of
+     * the instance's property MUST be valid against the pattern name's
+     * schema value.
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3
+     */
+    patternProperties?: {
+        [k: string]: JSONSchema4;
+    } | undefined;
+    dependencies?: {
+        [k: string]: JSONSchema4 | string[];
+    } | undefined;
+
+    /**
+     * This provides an enumeration of all possible values that are valid
+     * for the instance property. This MUST be an array, and each item in
+     * the array represents a possible value for the instance value. If
+     * this attribute is defined, the instance value MUST be one of the
+     * values in the array in order for the schema to be valid.
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19
+     */
+    enum?: JSONSchema4Type[] | undefined;
+
+    /**
+     * A single type, or a union of simple types
+     */
+    type?: JSONSchema4TypeName | JSONSchema4TypeName[] | undefined;
+
+    allOf?: JSONSchema4[] | undefined;
+    anyOf?: JSONSchema4[] | undefined;
+    oneOf?: JSONSchema4[] | undefined;
+    not?: JSONSchema4 | undefined;
+
+    /**
+     * The value of this property MUST be another schema which will provide
+     * a base schema which the current schema will inherit from.  The
+     * inheritance rules are such that any instance that is valid according
+     * to the current schema MUST be valid according to the referenced
+     * schema.  This MAY also be an array, in which case, the instance MUST
+     * be valid for all the schemas in the array.  A schema that extends
+     * another schema MAY define additional attributes, constrain existing
+     * attributes, or add other constraints.
+     *
+     * Conceptually, the behavior of extends can be seen as validating an
+     * instance against all constraints in the extending schema as well as
+     * the extended schema(s).
+     *
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26
+     */
+    extends?: string | string[] | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-zyp-json-schema-04#section-5.6
+     */
+    [k: string]: any;
+
+    format?: string | undefined;
+}
+
+declare interface JSONSchema4Array extends Array<JSONSchema4Type> {}
+
+declare interface JSONSchema4Object {
+    [key: string]: JSONSchema4Type;
+}
+
+/**
+ * @see https://tools.ietf.org/html/draft-zyp-json-schema-04#section-3.5
+ */
+declare type JSONSchema4Type =
+| string //
+| number
+| boolean
+| JSONSchema4Object
+| JSONSchema4Array
+| null;
+
+/**
+ * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
+ */
+declare type JSONSchema4TypeName =
+| "string" //
+| "number"
+| "integer"
+| "boolean"
+| "object"
+| "array"
+| "null"
+| "any";
+
+/**
+ * Meta schema
+ *
+ * Recommended values:
+ * - 'http://json-schema.org/schema#'
+ * - 'http://json-schema.org/hyper-schema#'
+ * - 'http://json-schema.org/draft-04/schema#'
+ * - 'http://json-schema.org/draft-04/hyper-schema#'
+ * - 'http://json-schema.org/draft-03/schema#'
+ * - 'http://json-schema.org/draft-03/hyper-schema#'
+ *
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
+ */
+declare type JSONSchema4Version = string;
+
 /** @public */
 declare type KeysOfAType<TSchema, Type> = {
     [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type ? key : never;
@@ -6572,6 +6816,13 @@ declare class MongoDBCollectionNamespace extends MongoDBNamespace {
     static fromString(namespace?: string): MongoDBCollectionNamespace;
 }
 
+declare type MongoDBJSONSchema = Pick<StandardJSONSchema, 'title' | 'required' | 'description'> & {
+    bsonType?: string | string[];
+    properties?: Record<string, MongoDBJSONSchema>;
+    items?: MongoDBJSONSchema | MongoDBJSONSchema[];
+    anyOf?: MongoDBJSONSchema[];
+};
+
 /**
  * @public
  *
@@ -8604,6 +8855,8 @@ declare type SortDirection = 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending
     $meta: string;
 };
 
+declare type StandardJSONSchema = JSONSchema4;
+
 declare interface StartLoadingCliScriptsEvent {
     usesShellOption: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mongosh/shell-api",
-  "version": "3.16.0",
+  "version": "3.16.2",
   "description": "MongoDB Shell API Classes Package",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -75,5 +75,5 @@
     "prettier": "^2.8.8",
     "semver": "^7.5.3"
   },
-  "gitHead": "ac4db1326a3c7ad18fff9a6ac06d1ca4604b0467"
+  "gitHead": "d37041bae3d76c22a9a683c7231e51f5108cefd3"
 }