@sfxcode/nuxt-mongocamp-server 1.6.3 → 1.8.0

package/README.md

@@ -2,6 +2,14 @@
 
 Nuxt module wrapping a generated OpenAPI client for [MongoCamp](https://mongocamp.io), with composables for browser-session auth and server-side API-key/bearer auth.
 
+## MongoCamp Server
+
+This module is a client for [MongoCamp Server](https://github.com/MongoCamp/mongocamp-server), a REST API server for MongoDB that provides authentication, user/role management, and collection, document and index APIs. The OpenAPI client in this module is generated from the server's OpenAPI spec, so the module version should match a compatible server version. See the [server repository](https://github.com/MongoCamp/mongocamp-server) for installation, configuration and API documentation.
+
+## Nuxt UI MongoCamp
+
+[nuxt-ui-mongocamp](https://github.com/sfxcode/nuxt-ui-mongocamp) is a companion project built on [Nuxt UI](https://ui.nuxt.com) that provides a user interface for MongoCamp. See its repository for setup and usage.
+
 ## Setup
 
 ```bash

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@sfxcode/nuxt-mongocamp-server",
-  "version": "1.6.3",
+  "version": "1.8.0",
   "configKey": "mongocamp",
   "compatibility": {
     "nuxt": ">=3.16.0"

package/dist/module.mjs

@@ -4,7 +4,7 @@ import { consola } from 'consola';
 export * from '../dist/runtime/api/index.js';
 
 const name = "@sfxcode/nuxt-mongocamp-server";
-const version = "1.6.3";
+const version = "1.8.0";
 
 const module$1 = defineNuxtModule({
   meta: {

package/dist/runtime/api/.openapi-generator/FILES

@@ -18,20 +18,32 @@ docs/BucketInformation.md
 docs/ClusterInformation.md
 docs/ClusterMemberInformation.md
 docs/CollectionApi.md
+docs/CollectionPermission.md
 docs/CollectionStatus.md
+docs/CollectionSummary.md
+docs/CopyRequest.md
+docs/CopyResponse.md
+docs/CountResponse.md
 docs/DatabaseApi.md
 docs/DatabaseInfo.md
 docs/DeleteResponse.md
 docs/DocumentApi.md
 docs/ErrorDescription.md
+docs/FieldInfo.md
+docs/FieldTypeCount.md
 docs/FileApi.md
 docs/FileInformation.md
 docs/Grant.md
+docs/ImportResponse.md
 docs/IndexApi.md
 docs/IndexCreateRequest.md
 docs/IndexCreateResponse.md
 docs/IndexDropResponse.md
+docs/IndexInfo.md
+docs/IndexKey.md
 docs/IndexOptionsRequest.md
+docs/IndexUsage.md
+docs/InsertError.md
 docs/InsertResponse.md
 docs/JobConfig.md
 docs/JobInformation.md
@@ -49,10 +61,13 @@ docs/MongoFindRequest.md
 docs/MongoIndex.md
 docs/PasswordUpdateRequest.md
 docs/PipelineStage.md
+docs/RenameRequest.md
+docs/RenameResponse.md
 docs/Role.md
 docs/SchemaAnalysis.md
 docs/SchemaAnalysisField.md
 docs/SchemaAnalysisFieldType.md
+docs/SearchRequest.md
 docs/SettingsResponse.md
 docs/SystemApi.md
 docs/UpdateFileInformationRequest.md
@@ -66,16 +81,28 @@ index.ts
 models/BucketInformation.ts
 models/ClusterInformation.ts
 models/ClusterMemberInformation.ts
+models/CollectionPermission.ts
 models/CollectionStatus.ts
+models/CollectionSummary.ts
+models/CopyRequest.ts
+models/CopyResponse.ts
+models/CountResponse.ts
 models/DatabaseInfo.ts
 models/DeleteResponse.ts
 models/ErrorDescription.ts
+models/FieldInfo.ts
+models/FieldTypeCount.ts
 models/FileInformation.ts
 models/Grant.ts
+models/ImportResponse.ts
 models/IndexCreateRequest.ts
 models/IndexCreateResponse.ts
 models/IndexDropResponse.ts
+models/IndexInfo.ts
+models/IndexKey.ts
 models/IndexOptionsRequest.ts
+models/IndexUsage.ts
+models/InsertError.ts
 models/InsertResponse.ts
 models/JobConfig.ts
 models/JobInformation.ts
@@ -92,10 +119,13 @@ models/MongoFindRequest.ts
 models/MongoIndex.ts
 models/PasswordUpdateRequest.ts
 models/PipelineStage.ts
+models/RenameRequest.ts
+models/RenameResponse.ts
 models/Role.ts
 models/SchemaAnalysis.ts
 models/SchemaAnalysisField.ts
 models/SchemaAnalysisFieldType.ts
+models/SearchRequest.ts
 models/SettingsResponse.ts
 models/UpdateFileInformationRequest.ts
 models/UpdateRequest.ts

package/dist/runtime/api/apis/AdminApi.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.8.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/apis/ApplicationApi.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.8.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/apis/AuthApi.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.8.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,13 +10,16 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import type { JsonValueBoolean, JsonValueString, Login, LoginResult, PasswordUpdateRequest, UserProfile } from '../models/index.js';
+import type { CollectionPermission, JsonValueBoolean, JsonValueString, Login, LoginResult, PasswordUpdateRequest, UserProfile } from '../models/index.js';
 export interface LoginRequest {
     login: Login;
 }
 export interface UpdatePasswordRequest {
     passwordUpdateRequest: PasswordUpdateRequest;
 }
+export interface UserPermissionsRequest {
+    collection?: string;
+}
 /**
  *
  */
@@ -119,6 +122,20 @@ export declare class AuthApi extends runtime.BaseAPI {
      * Update Password
      */
     updatePassword(requestParameters: UpdatePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonValueBoolean>;
+    /**
+     * Creates request options for userPermissions without sending the request
+     */
+    userPermissionsRequestOpts(requestParameters: UserPermissionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Return the resolved rights (read, write, administrate) of the loggedin user for the collections of the default database
+     * Collection permissions
+     */
+    userPermissionsRaw(requestParameters: UserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CollectionPermission>>>;
+    /**
+     * Return the resolved rights (read, write, administrate) of the loggedin user for the collections of the default database
+     * Collection permissions
+     */
+    userPermissions(requestParameters?: UserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CollectionPermission>>;
     /**
      * Creates request options for userProfile without sending the request
      */

package/dist/runtime/api/apis/AuthApi.js

@@ -1,5 +1,6 @@
 import * as runtime from "../runtime.js";
 import {
+  CollectionPermissionFromJSON,
   JsonValueBooleanFromJSON,
   JsonValueStringFromJSON,
   LoginToJSON,
@@ -319,6 +320,53 @@ export class AuthApi extends runtime.BaseAPI {
     const response = await this.updatePasswordRaw(requestParameters, initOverrides);
     return await response.value();
   }
+  /**
+   * Creates request options for userPermissions without sending the request
+   */
+  async userPermissionsRequestOpts(requestParameters) {
+    const queryParameters = {};
+    if (requestParameters["collection"] != null) {
+      queryParameters["collection"] = requestParameters["collection"];
+    }
+    const headerParameters = {};
+    if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
+      headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+    }
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token("httpAuth", []);
+      if (tokenString) {
+        headerParameters["Authorization"] = `Bearer ${tokenString}`;
+      }
+    }
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-AUTH-APIKEY"] = await this.configuration.apiKey("X-AUTH-APIKEY");
+    }
+    let urlPath = `/auth/permissions`;
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Return the resolved rights (read, write, administrate) of the loggedin user for the collections of the default database
+   * Collection permissions
+   */
+  async userPermissionsRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.userPermissionsRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CollectionPermissionFromJSON));
+  }
+  /**
+   * Return the resolved rights (read, write, administrate) of the loggedin user for the collections of the default database
+   * Collection permissions
+   */
+  async userPermissions(requestParameters = {}, initOverrides) {
+    const response = await this.userPermissionsRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
   /**
    * Creates request options for userProfile without sending the request
    */

package/dist/runtime/api/apis/BucketApi.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.8.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/apis/CollectionApi.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.8.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,16 +10,22 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import type { CollectionStatus, JsonSchema, JsonValueBoolean, MongoAggregateRequest, SchemaAnalysis } from '../models/index.js';
+import type { CollectionStatus, CollectionSummary, CopyRequest, CopyResponse, FieldInfo, JsonSchema, JsonValueBoolean, MongoAggregateRequest, RenameRequest, RenameResponse, SchemaAnalysis } from '../models/index.js';
 export interface AggregateRequest {
     collectionName: string;
     mongoAggregateRequest: MongoAggregateRequest;
     rowsPerPage?: number;
     page?: number;
+    filter?: string;
+    extendedJson?: string;
 }
 export interface ClearCollectionRequest {
     collectionName: string;
 }
+export interface CopyCollectionRequest {
+    collectionName: string;
+    copyRequest: CopyRequest;
+}
 export interface DeleteCollectionRequest {
     collectionName: string;
 }
@@ -37,6 +43,11 @@ export interface GetCollectionInformationRequest {
     collectionName: string;
     includeDetails?: boolean;
 }
+export interface GetFieldDetailsRequest {
+    collectionName: string;
+    sampleSize?: number;
+    depth?: number;
+}
 export interface GetJsonSchemaRequest {
     collectionName: string;
     sampleSize?: number;
@@ -47,9 +58,16 @@ export interface GetSchemaAnalysisRequest {
     sampleSize?: number;
     deepth?: number;
 }
+export interface ListCollectionInformationRequest {
+    name?: Array<string>;
+}
 export interface ListCollectionsByDatabaseRequest {
     databaseName: string;
 }
+export interface RenameCollectionRequest {
+    collectionName: string;
+    renameRequest: RenameRequest;
+}
 /**
  *
  */
@@ -59,14 +77,14 @@ export declare class CollectionApi extends runtime.BaseAPI {
      */
     aggregateRequestOpts(requestParameters: AggregateRequest): Promise<runtime.RequestOpts>;
     /**
-     * Aggregate in a given Collection. The value of a stage is any JSON value. Operators that run JavaScript on the database server or write to collections (`$function`, `$accumulator`, `$where`, `$out`, `$merge`, `$currentOp`, `$listSessions` by default, configured with AGGREGATION_STAGES_DENIED) are refused with 403.
+     * Aggregate in a given Collection. The value of a stage is any JSON value. Operators that run JavaScript on the database server or write to collections (`$function`, `$accumulator`, `$where`, `$out`, `$merge`, `$currentOp`, `$listSessions`, `$collStats`, `$indexStats` by default, configured with AGGREGATION_STAGES_DENIED) are refused with 403.
      * Aggregate in Collection
      */
     aggregateRaw(requestParameters: AggregateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
         [key: string]: any;
     }>>>;
     /**
-     * Aggregate in a given Collection. The value of a stage is any JSON value. Operators that run JavaScript on the database server or write to collections (`$function`, `$accumulator`, `$where`, `$out`, `$merge`, `$currentOp`, `$listSessions` by default, configured with AGGREGATION_STAGES_DENIED) are refused with 403.
+     * Aggregate in a given Collection. The value of a stage is any JSON value. Operators that run JavaScript on the database server or write to collections (`$function`, `$accumulator`, `$where`, `$out`, `$merge`, `$currentOp`, `$listSessions`, `$collStats`, `$indexStats` by default, configured with AGGREGATION_STAGES_DENIED) are refused with 403.
      * Aggregate in Collection
      */
     aggregate(requestParameters: AggregateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
@@ -86,6 +104,20 @@ export declare class CollectionApi extends runtime.BaseAPI {
      * Clear Collection
      */
     clearCollection(requestParameters: ClearCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JsonValueBoolean>;
+    /**
+     * Creates request options for copyCollection without sending the request
+     */
+    copyCollectionRequestOpts(requestParameters: CopyCollectionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Copy a Collection in the database, optionally only the documents that match a Lucene filter, with its indices (withIndexes, true by default). The target is a name in the database of the Collection. The read grant for the Collection and the write grant for the target are needed. An existing target is a conflict (409), unless dropTarget is true and the user has the administrate grant for it: it is replaced when the copy is complete. The copy is made in one request, a big collection takes its time.
+     * Copy Collection
+     */
+    copyCollectionRaw(requestParameters: CopyCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CopyResponse>>;
+    /**
+     * Copy a Collection in the database, optionally only the documents that match a Lucene filter, with its indices (withIndexes, true by default). The target is a name in the database of the Collection. The read grant for the Collection and the write grant for the target are needed. An existing target is a conflict (409), unless dropTarget is true and the user has the administrate grant for it: it is replaced when the copy is complete. The copy is made in one request, a big collection takes its time.
+     * Copy Collection
+     */
+    copyCollection(requestParameters: CopyCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CopyResponse>;
     /**
      * Creates request options for deleteCollection without sending the request
      */
@@ -142,6 +174,20 @@ export declare class CollectionApi extends runtime.BaseAPI {
      * Collection Information
      */
     getCollectionInformation(requestParameters: GetCollectionInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CollectionStatus>;
+    /**
+     * Creates request options for getFieldDetails without sending the request
+     */
+    getFieldDetailsRequestOpts(requestParameters: GetFieldDetailsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * All fields of a collection as a flat list, one entry per path (`address.city`, `tags[]` for the elements of an array) with the types of the values and how often every type was found in the analysed documents.
+     * Fields of a Collection with types
+     */
+    getFieldDetailsRaw(requestParameters: GetFieldDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<FieldInfo>>>;
+    /**
+     * All fields of a collection as a flat list, one entry per path (`address.city`, `tags[]` for the elements of an array) with the types of the values and how often every type was found in the analysed documents.
+     * Fields of a Collection with types
+     */
+    getFieldDetails(requestParameters: GetFieldDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FieldInfo>>;
     /**
      * Creates request options for getJsonSchema without sending the request
      */
@@ -170,6 +216,20 @@ export declare class CollectionApi extends runtime.BaseAPI {
      * Collection Fields
      */
     getSchemaAnalysis(requestParameters: GetSchemaAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SchemaAnalysis>;
+    /**
+     * Creates request options for listCollectionInformation without sending the request
+     */
+    listCollectionInformationRequestOpts(requestParameters: ListCollectionInformationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The numbers of all Collections of the default database that the user may read in one request (count, size, storage size, average size of a document, number and size of the indices). A Collection without statistics, for example a view, is listed with available false.
+     * Information of all Collections
+     */
+    listCollectionInformationRaw(requestParameters: ListCollectionInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CollectionSummary>>>;
+    /**
+     * The numbers of all Collections of the default database that the user may read in one request (count, size, storage size, average size of a document, number and size of the indices). A Collection without statistics, for example a view, is listed with available false.
+     * Information of all Collections
+     */
+    listCollectionInformation(requestParameters?: ListCollectionInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CollectionSummary>>;
     /**
      * Creates request options for listCollections without sending the request
      */
@@ -198,4 +258,18 @@ export declare class CollectionApi extends runtime.BaseAPI {
      * List of Collections
      */
     listCollectionsByDatabase(requestParameters: ListCollectionsByDatabaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Creates request options for renameCollection without sending the request
+     */
+    renameCollectionRequestOpts(requestParameters: RenameCollectionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Rename a Collection in the database, with its Documents and Indices. The target is a name in the database of the Collection. The administrate grant for the Collection and the write grant for the target are needed. An existing target is a conflict (409), unless dropTarget is true and the user has the administrate grant for it: it is replaced then.
+     * Rename Collection
+     */
+    renameCollectionRaw(requestParameters: RenameCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenameResponse>>;
+    /**
+     * Rename a Collection in the database, with its Documents and Indices. The target is a name in the database of the Collection. The administrate grant for the Collection and the write grant for the target are needed. An existing target is a conflict (409), unless dropTarget is true and the user has the administrate grant for it: it is replaced then.
+     * Rename Collection
+     */
+    renameCollection(requestParameters: RenameCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenameResponse>;
 }