@sfxcode/nuxt-mongocamp-server 1.6.3 → 1.7.0

package/dist/runtime/api/docs/DocumentApi.md

@@ -5,12 +5,14 @@ All URIs are relative to *http://localhost*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**_delete**](DocumentApi.md#_delete) | **DELETE** /mongodb/collections/{collectionName}/documents/{documentId} | Delete Document from Collection |
+| [**countDocuments**](DocumentApi.md#countdocuments) | **GET** /mongodb/collections/{collectionName}/documents/count | Count Documents in Collection |
 | [**deleteMany**](DocumentApi.md#deletemany) | **DELETE** /mongodb/collections/{collectionName}/documents/many/delete | Delete Many in Collection |
 | [**find**](DocumentApi.md#find) | **POST** /mongodb/collections/{collectionName}/documents | Documents in Collection |
 | [**getDocument**](DocumentApi.md#getdocument) | **GET** /mongodb/collections/{collectionName}/documents/{documentId} | Document from Collection |
 | [**insert**](DocumentApi.md#insert) | **PUT** /mongodb/collections/{collectionName}/documents | Insert Document |
 | [**insertMany**](DocumentApi.md#insertmany) | **PUT** /mongodb/collections/{collectionName}/documents/many/insert | Insert many Documents |
 | [**listDocuments**](DocumentApi.md#listdocuments) | **GET** /mongodb/collections/{collectionName}/documents | Documents in Collection |
+| [**searchDocuments**](DocumentApi.md#searchdocuments) | **POST** /mongodb/collections/{collectionName}/documents/search | Search Documents in Collection |
 | [**update**](DocumentApi.md#update) | **PATCH** /mongodb/collections/{collectionName}/documents/{documentId} | Update Document in Collection |
 | [**updateDocumentPartial**](DocumentApi.md#updatedocumentpartial) | **PATCH** /mongodb/collections/{collectionName}/documents/{documentId}/partial | Update Document Parts in Collection |
 | [**updateMany**](DocumentApi.md#updatemany) | **PATCH** /mongodb/collections/{collectionName}/documents/many/update | Update many in Collection |
@@ -97,9 +99,89 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## countDocuments
+
+> CountResponse countDocuments(collectionName, filter)
+
+Count Documents in Collection
+
+Count the Documents of the given Collection that match the filter without loading them
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentApi,
+} from '';
+import type { CountDocumentsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: httpAuth1
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // Configure HTTP bearer authorization: httpAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: apiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new DocumentApi(config);
+
+  const body = {
+    // string | The name of your MongoDb Collection
+    collectionName: collectionName_example,
+    // string | Filter Query like on the list of documents, by default all documents are counted (optional)
+    filter: filter_example,
+  } satisfies CountDocumentsRequest;
+
+  try {
+    const data = await api.countDocuments(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
+| **filter** | `string` | Filter Query like on the list of documents, by default all documents are counted | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**CountResponse**](CountResponse.md)
+
+### Authorization
+
+[httpAuth1](../README.md#httpAuth1), [httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+| **0** |  |  * x-error-code - Error Code <br>  * x-error-message - Message of the MongoCampException <br>  * x-error-additional-info - Additional information for the MongoCampException <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## deleteMany
 
-> DeleteResponse deleteMany(collectionName, requestBody, matchAll)
+> DeleteResponse deleteMany(collectionName, requestBody, matchAll, filter)
 
 Delete Many in Collection
 
@@ -134,6 +216,8 @@ async function example() {
     requestBody: Object,
     // boolean | Allow an empty filter, that matches all documents of the collection (optional)
     matchAll: true,
+    // string | Filter Query like on the list of documents, as an alternative to the filter of the request body. Use only one of both. (optional)
+    filter: filter_example,
   } satisfies DeleteManyRequest;
 
   try {
@@ -156,6 +240,7 @@ example().catch(console.error);
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
 | **requestBody** | `{ [key: string]: any; }` |  | |
 | **matchAll** | `boolean` | Allow an empty filter, that matches all documents of the collection | [Optional] [Defaults to `false`] |
+| **filter** | `string` | Filter Query like on the list of documents, as an alternative to the filter of the request body. Use only one of both. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -382,7 +467,7 @@ async function example() {
     // string | The name of your MongoDb Collection
     collectionName: collectionName_example,
     // { [key: string]: any; } | JSON Representation for your Document.
-    requestBody: {"key1":"value","key2":true,"key3":{"creationDate":"2026-11-02T05:03:40.430Z"}},
+    requestBody: {"key1":"value","key2":true,"key3":{"creationDate":"2026-11-06T06:04:09.291Z"}},
   } satisfies InsertRequest;
 
   try {
@@ -431,7 +516,7 @@ example().catch(console.error);
 
 ## insertMany
 
-> InsertResponse insertMany(collectionName, requestBody)
+> InsertResponse insertMany(collectionName, ordered, requestBody)
 
 Insert many Documents
 
@@ -462,6 +547,8 @@ async function example() {
   const body = {
     // string | The name of your MongoDb Collection
     collectionName: collectionName_example,
+    // boolean | true (default): the insert stops at the first document that fails (answer 409 for a duplicate key). false: all documents that can be stored are stored, the others are listed in `errors` of the answer. (optional)
+    ordered: true,
     // Array<{ [key: string]: any; }> (optional)
     requestBody: ...,
   } satisfies InsertManyRequest;
@@ -484,6 +571,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
+| **ordered** | `boolean` | true (default): the insert stops at the first document that fails (answer 409 for a duplicate key). false: all documents that can be stored are stored, the others are listed in &#x60;errors&#x60; of the answer. | [Optional] [Defaults to `true`] |
 | **requestBody** | `Array<{ [key: string]: any; }>` |  | [Optional] |
 
 ### Return type
@@ -504,7 +592,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** |  |  -  |
-| **400** | Invalid value for: body |  -  |
+| **400** | Invalid value for: body, Invalid value for: query parameter ordered |  -  |
 | **0** |  |  * x-error-code - Error Code <br>  * x-error-message - Message of the MongoCampException <br>  * x-error-additional-info - Additional information for the MongoCampException <br>  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -603,6 +691,93 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## searchDocuments
+
+> Array&lt;{ [key: string]: any; }&gt; searchDocuments(collectionName, searchRequest, rowsPerPage, page)
+
+Search Documents in Collection
+
+The list of documents with the parameters in the request body: for filters that are too long for the URL (a URL of more than 2048 characters is refused by the server before the request is handled, without CORS headers). The filter is a Lucene query like in the list, the answer and the pagination headers are the same.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentApi,
+} from '';
+import type { SearchDocumentsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: httpAuth1
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // Configure HTTP bearer authorization: httpAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: apiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new DocumentApi(config);
+
+  const body = {
+    // string | The name of your MongoDb Collection
+    collectionName: collectionName_example,
+    // SearchRequest
+    searchRequest: {"filter":"name:John AND age:[18 TO 65]","sort":["-age"],"projection":["name","age"]},
+    // number | Count elements per page (optional)
+    rowsPerPage: 100,
+    // number | Requested page of the ResultSets (optional)
+    page: 1,
+  } satisfies SearchDocumentsRequest;
+
+  try {
+    const data = await api.searchDocuments(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
+| **searchRequest** | [SearchRequest](SearchRequest.md) |  | |
+| **rowsPerPage** | `number` | Count elements per page | [Optional] [Defaults to `undefined`] |
+| **page** | `number` | Requested page of the ResultSets | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+**Array<{ [key: string]: any; }>**
+
+### Authorization
+
+[httpAuth1](../README.md#httpAuth1), [httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  * x-pagination-count-rows - count all elements <br>  * x-pagination-rows-per-page - Count elements per page <br>  * x-pagination-current-page - Current page <br>  * x-pagination-count-pages - Count pages <br>  |
+| **400** | Invalid value for: body, Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page |  -  |
+| **0** |  |  * x-error-code - Error Code <br>  * x-error-message - Message of the MongoCampException <br>  * x-error-additional-info - Additional information for the MongoCampException <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## update
 
 > UpdateResponse update(collectionName, documentId, requestBody)
@@ -773,7 +948,7 @@ example().catch(console.error);
 
 ## updateMany
 
-> UpdateResponse updateMany(collectionName, updateRequest, matchAll)
+> UpdateResponse updateMany(collectionName, updateRequest, matchAll, filter)
 
 Update many in Collection
 
@@ -808,6 +983,8 @@ async function example() {
     updateRequest: ...,
     // boolean | Allow an empty filter, that matches all documents of the collection (optional)
     matchAll: true,
+    // string | Filter Query like on the list of documents, as an alternative to the filter of the request body. Use only one of both. (optional)
+    filter: filter_example,
   } satisfies UpdateManyRequest;
 
   try {
@@ -830,6 +1007,7 @@ example().catch(console.error);
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
 | **updateRequest** | [UpdateRequest](UpdateRequest.md) |  | |
 | **matchAll** | `boolean` | Allow an empty filter, that matches all documents of the collection | [Optional] [Defaults to `false`] |
+| **filter** | `string` | Filter Query like on the list of documents, as an alternative to the filter of the request body. Use only one of both. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 

package/dist/runtime/api/docs/IndexApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost*
 | [**createUniqueIndex**](IndexApi.md#createuniqueindex) | **PUT** /mongodb/collections/{collectionName}/index/field/{fieldName}/unique | Create Unique Index |
 | [**deleteIndex**](IndexApi.md#deleteindex) | **DELETE** /mongodb/collections/{collectionName}/index/{indexName} | Delete Index |
 | [**index**](IndexApi.md#index) | **GET** /mongodb/collections/{collectionName}/index/{indexName} | Index for Collection |
+| [**indexStats**](IndexApi.md#indexstats) | **GET** /mongodb/collections/{collectionName}/index/stats | Index usage for Collection |
 | [**listIndices**](IndexApi.md#listindices) | **GET** /mongodb/collections/{collectionName}/index | List Indices for Collection |
 
 
@@ -604,6 +605,83 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## indexStats
+
+> Array<IndexUsage> indexStats(collectionName)
+
+Index usage for Collection
+
+How often every Index of the given Collection was used since the counting started. Replaces the aggregation stage $indexStats, which is denied by default because its result contains the address of the database server.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IndexApi,
+} from '';
+import type { IndexStatsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: httpAuth1
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // Configure HTTP bearer authorization: httpAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: apiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new IndexApi(config);
+
+  const body = {
+    // string | The name of your MongoDb Collection
+    collectionName: collectionName_example,
+  } satisfies IndexStatsRequest;
+
+  try {
+    const data = await api.indexStats(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<IndexUsage>**](IndexUsage.md)
+
+### Authorization
+
+[httpAuth1](../README.md#httpAuth1), [httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+| **0** |  |  * x-error-code - Error Code <br>  * x-error-message - Message of the MongoCampException <br>  * x-error-additional-info - Additional information for the MongoCampException <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## listIndices
 
 > Array&lt;MongoIndex&gt; listIndices(collectionName)

package/dist/runtime/api/docs/IndexUsage.md

@@ -0,0 +1,40 @@
+
+# IndexUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`key` | { [key: string]: any; }
+`ops` | number
+`since` | Date
+
+## Example
+
+```typescript
+import type { IndexUsage } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "key": null,
+  "ops": null,
+  "since": null,
+} satisfies IndexUsage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as IndexUsage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/dist/runtime/api/docs/InsertError.md

@@ -0,0 +1,38 @@
+
+# InsertError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`index` | number
+`code` | number
+`message` | string
+
+## Example
+
+```typescript
+import type { InsertError } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "index": null,
+  "code": null,
+  "message": null,
+} satisfies InsertError
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as InsertError
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/dist/runtime/api/docs/InsertResponse.md

@@ -8,6 +8,8 @@ Name | Type
 ------------ | -------------
 `wasAcknowledged` | boolean
 `insertedIds` | Array<string>
+`insertedCount` | number
+`errors` | [Array<InsertError>](InsertError.md)
 
 ## Example
 
@@ -18,6 +20,8 @@ import type { InsertResponse } from ''
 const example = {
   "wasAcknowledged": null,
   "insertedIds": null,
+  "insertedCount": null,
+  "errors": null,
 } satisfies InsertResponse
 
 console.log(example)

package/dist/runtime/api/docs/SearchRequest.md

@@ -0,0 +1,38 @@
+
+# SearchRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filter` | string
+`sort` | Array<string>
+`projection` | Array<string>
+
+## Example
+
+```typescript
+import type { SearchRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "filter": null,
+  "sort": null,
+  "projection": null,
+} satisfies SearchRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/dist/runtime/api/models/BucketInformation.d.ts

@@ -2,7 +2,7 @@
  * mongocamp-library
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.6.3
+ * The version of the OpenAPI document: 1.7.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/models/ClusterInformation.d.ts

@@ -2,7 +2,7 @@
  * mongocamp-library
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.6.3
+ * The version of the OpenAPI document: 1.7.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/models/ClusterMemberInformation.d.ts

@@ -2,7 +2,7 @@
  * mongocamp-library
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.6.3
+ * The version of the OpenAPI document: 1.7.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/models/CollectionPermission.d.ts

@@ -0,0 +1,50 @@
+/**
+ * mongocamp-library
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.7.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CollectionPermission
+ */
+export interface CollectionPermission {
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionPermission
+     */
+    name: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CollectionPermission
+     */
+    read: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CollectionPermission
+     */
+    write: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CollectionPermission
+     */
+    administrate: boolean;
+}
+/**
+ * Check if a given object implements the CollectionPermission interface.
+ */
+export declare function instanceOfCollectionPermission(value: object): value is CollectionPermission;
+export declare function CollectionPermissionFromJSON(json: any): CollectionPermission;
+export declare function CollectionPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CollectionPermission;
+export declare function CollectionPermissionToJSON(json: any): CollectionPermission;
+export declare function CollectionPermissionToJSONTyped(value?: CollectionPermission | null, ignoreDiscriminator?: boolean): any;

package/dist/runtime/api/models/CollectionPermission.js

@@ -0,0 +1,35 @@
+export function instanceOfCollectionPermission(value) {
+  if (!("name" in value) || value["name"] === void 0) return false;
+  if (!("read" in value) || value["read"] === void 0) return false;
+  if (!("write" in value) || value["write"] === void 0) return false;
+  if (!("administrate" in value) || value["administrate"] === void 0) return false;
+  return true;
+}
+export function CollectionPermissionFromJSON(json) {
+  return CollectionPermissionFromJSONTyped(json, false);
+}
+export function CollectionPermissionFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "name": json["name"],
+    "read": json["read"],
+    "write": json["write"],
+    "administrate": json["administrate"]
+  };
+}
+export function CollectionPermissionToJSON(json) {
+  return CollectionPermissionToJSONTyped(json, false);
+}
+export function CollectionPermissionToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "name": value["name"],
+    "read": value["read"],
+    "write": value["write"],
+    "administrate": value["administrate"]
+  };
+}

package/dist/runtime/api/models/CollectionStatus.d.ts

@@ -2,7 +2,7 @@
  * mongocamp-library
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.6.3
+ * The version of the OpenAPI document: 1.7.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).