gopadjs 2.4.1 → 2.5.0

package/.github/RELEASE

@@ -1 +1 @@
-Mon Feb 10 08:12:15 UTC 2025
+Mon Feb 17 08:13:09 UTC 2025

package/.github/renovate.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-      "github>gopad/.github//renovate/preset"
+    "github>gopad/.github//renovate/preset"
   ]
 }

package/.openapi-generator/FILES

@@ -2,29 +2,37 @@
 README.md
 api.ts
 api/auth-api.ts
+api/group-api.ts
 api/profile-api.ts
-api/team-api.ts
 api/user-api.ts
 base.ts
 common.ts
 configuration.ts
 index.ts
-model/auth-login.ts
 model/auth-token.ts
 model/auth-verify.ts
+model/create-group-request.ts
+model/create-user-request.ts
+model/delete-group-from-user-request.ts
+model/delete-user-from-group-request.ts
+model/group.ts
 model/index.ts
+model/list-group-users200-response.ts
+model/list-groups200-response.ts
+model/list-providers200-response.ts
+model/list-user-groups200-response.ts
+model/list-users200-response.ts
+model/login-auth-request.ts
 model/notification.ts
+model/permit-group-user-request.ts
+model/permit-user-group-request.ts
 model/profile.ts
-model/team-user-params.ts
-model/team-users.ts
-model/team.ts
-model/teams.ts
+model/provider.ts
+model/update-profile-request.ts
+model/update-user-request.ts
 model/user-auth.ts
-model/user-team-params.ts
-model/user-team.ts
-model/user-teams.ts
+model/user-group.ts
 model/user.ts
-model/users.ts
 model/validation.ts
 tsconfig.esm.json
 tsconfig.json

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.5.0](https://github.com/gopad/gopad-js/compare/v2.4.1...v2.5.0) (2025-02-24)
+
+
+### Features
+
+* automated openapi client update ([5827687](https://github.com/gopad/gopad-js/commit/5827687912b62aa5fa5a6eb0a38c062c05f77e18))
+* automated openapi client update ([5dfa623](https://github.com/gopad/gopad-js/commit/5dfa623c10e47f190959950455cbc4d46e840be0))
+* entirely regenerate client locally ([9f7bb87](https://github.com/gopad/gopad-js/commit/9f7bb87b7187331d9a102ca059b626ad26837f83))
+
+
+### Bugfixes
+
+* **deps:** update dependency prettier to v3.5.2 ([#173](https://github.com/gopad/gopad-js/issues/173)) ([74893f7](https://github.com/gopad/gopad-js/commit/74893f7be8c579fe0046ac44b2df57412d778a98))
+
 ## [2.4.1](https://github.com/gopad/gopad-js/compare/v2.4.0...v2.4.1) (2025-02-17)
 
 

package/README.md

@@ -6,7 +6,7 @@ This repository provides a client SDK for Typescript/Javascript. This SDK is
 automatically generated by the [OpenAPI Generator][generator] project:
 
 -   API version: 1.0.0-alpha1
--   Package version: 2.4.1
+-   Package version: 2.5.0
 -   Build package: org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen
 
 For more information, please visit [https://gopad.eu](https://gopad.eu)
@@ -39,7 +39,7 @@ the following command within your project directory, after that you can import
 it as other libraries:
 
 ```console
-npm install --save gopadjs@2.4.1
+npm install --save gopadjs@2.5.0
 ```
 
 ### Installation with Git

package/api/auth-api.ts

@@ -42,12 +42,14 @@ import {
   operationServerMap,
 } from "../base";
 // @ts-ignore
-import type { AuthLogin } from "../model";
-// @ts-ignore
 import type { AuthToken } from "../model";
 // @ts-ignore
 import type { AuthVerify } from "../model";
 // @ts-ignore
+import type { ListProviders200Response } from "../model";
+// @ts-ignore
+import type { LoginAuthRequest } from "../model";
+// @ts-ignore
 import type { Notification } from "../model";
 /**
  * AuthApi - axios parameter creator
@@ -59,21 +61,21 @@ export const AuthApiAxiosParamCreator = function (
   return {
     /**
      *
-     * @summary Callback for external authentication
+     * @summary Callback to parse the defined provider
      * @param {string} provider An identifier for the auth provider
      * @param {string} [state] Auth state
      * @param {string} [code] Auth code
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    externalCallback: async (
+    callbackProvider: async (
       provider: string,
       state?: string,
       code?: string,
       options: RawAxiosRequestConfig = {},
     ): Promise<RequestArgs> => {
       // verify required parameter 'provider' is not null or undefined
-      assertParamExists("externalCallback", "provider", provider);
+      assertParamExists("callbackProvider", "provider", provider);
       const localVarPath = `/auth/{provider}/callback`.replace(
         `{${"provider"}}`,
         encodeURIComponent(String(provider)),
@@ -117,23 +119,14 @@ export const AuthApiAxiosParamCreator = function (
     },
     /**
      *
-     * @summary Initialize the external authentication
-     * @param {string} provider An identifier for the auth provider
-     * @param {string} [state] Auth state
+     * @summary Fetch the available auth providers
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    externalInitialize: async (
-      provider: string,
-      state?: string,
+    listProviders: async (
       options: RawAxiosRequestConfig = {},
     ): Promise<RequestArgs> => {
-      // verify required parameter 'provider' is not null or undefined
-      assertParamExists("externalInitialize", "provider", provider);
-      const localVarPath = `/auth/{provider}/initialize`.replace(
-        `{${"provider"}}`,
-        encodeURIComponent(String(provider)),
-      );
+      const localVarPath = `/auth/providers`;
       // use dummy base URL string because the URL constructor only accepts absolute URLs.
       const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
       let baseOptions;
@@ -149,10 +142,6 @@ export const AuthApiAxiosParamCreator = function (
       const localVarHeaderParameter = {} as any;
       const localVarQueryParameter = {} as any;
 
-      if (state !== undefined) {
-        localVarQueryParameter["state"] = state;
-      }
-
       setSearchParams(localVarUrlObj, localVarQueryParameter);
       let headersFromBaseOptions =
         baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -170,16 +159,16 @@ export const AuthApiAxiosParamCreator = function (
     /**
      *
      * @summary Authenticate an user by credentials
-     * @param {AuthLogin} authLogin The credentials to authenticate
+     * @param {LoginAuthRequest} loginAuthRequest The credentials to authenticate
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     loginAuth: async (
-      authLogin: AuthLogin,
+      loginAuthRequest: LoginAuthRequest,
       options: RawAxiosRequestConfig = {},
     ): Promise<RequestArgs> => {
-      // verify required parameter 'authLogin' is not null or undefined
-      assertParamExists("loginAuth", "authLogin", authLogin);
+      // verify required parameter 'loginAuthRequest' is not null or undefined
+      assertParamExists("loginAuth", "loginAuthRequest", loginAuthRequest);
       const localVarPath = `/auth/login`;
       // use dummy base URL string because the URL constructor only accepts absolute URLs.
       const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -207,7 +196,7 @@ export const AuthApiAxiosParamCreator = function (
         ...options.headers,
       };
       localVarRequestOptions.data = serializeDataIfNeeded(
-        authLogin,
+        loginAuthRequest,
         localVarRequestOptions,
         configuration,
       );
@@ -242,9 +231,6 @@ export const AuthApiAxiosParamCreator = function (
       const localVarHeaderParameter = {} as any;
       const localVarQueryParameter = {} as any;
 
-      // authentication Cookie required
-      await setApiKeyToObject(localVarHeaderParameter, "Cookie", configuration);
-
       // authentication Basic required
       // http basic authentication required
       setBasicAuthToObject(localVarRequestOptions, configuration);
@@ -274,6 +260,52 @@ export const AuthApiAxiosParamCreator = function (
         options: localVarRequestOptions,
       };
     },
+    /**
+     *
+     * @summary Request the redirect to defined provider
+     * @param {string} provider An identifier for the auth provider
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestProvider: async (
+      provider: string,
+      options: RawAxiosRequestConfig = {},
+    ): Promise<RequestArgs> => {
+      // verify required parameter 'provider' is not null or undefined
+      assertParamExists("requestProvider", "provider", provider);
+      const localVarPath = `/auth/{provider}/request`.replace(
+        `{${"provider"}}`,
+        encodeURIComponent(String(provider)),
+      );
+      // use dummy base URL string because the URL constructor only accepts absolute URLs.
+      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+      let baseOptions;
+      if (configuration) {
+        baseOptions = configuration.baseOptions;
+      }
+
+      const localVarRequestOptions = {
+        method: "GET",
+        ...baseOptions,
+        ...options,
+      };
+      const localVarHeaderParameter = {} as any;
+      const localVarQueryParameter = {} as any;
+
+      setSearchParams(localVarUrlObj, localVarQueryParameter);
+      let headersFromBaseOptions =
+        baseOptions && baseOptions.headers ? baseOptions.headers : {};
+      localVarRequestOptions.headers = {
+        ...localVarHeaderParameter,
+        ...headersFromBaseOptions,
+        ...options.headers,
+      };
+
+      return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions,
+      };
+    },
     /**
      *
      * @summary Verify validity for an authentication token
@@ -299,9 +331,6 @@ export const AuthApiAxiosParamCreator = function (
       const localVarHeaderParameter = {} as any;
       const localVarQueryParameter = {} as any;
 
-      // authentication Cookie required
-      await setApiKeyToObject(localVarHeaderParameter, "Cookie", configuration);
-
       // authentication Basic required
       // http basic authentication required
       setBasicAuthToObject(localVarRequestOptions, configuration);
@@ -343,23 +372,23 @@ export const AuthApiFp = function (configuration?: Configuration) {
   return {
     /**
      *
-     * @summary Callback for external authentication
+     * @summary Callback to parse the defined provider
      * @param {string} provider An identifier for the auth provider
      * @param {string} [state] Auth state
      * @param {string} [code] Auth code
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    async externalCallback(
+    async callbackProvider(
       provider: string,
       state?: string,
       code?: string,
       options?: RawAxiosRequestConfig,
     ): Promise<
-      (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>
+      (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>
     > {
       const localVarAxiosArgs =
-        await localVarAxiosParamCreator.externalCallback(
+        await localVarAxiosParamCreator.callbackProvider(
           provider,
           state,
           code,
@@ -367,7 +396,7 @@ export const AuthApiFp = function (configuration?: Configuration) {
         );
       const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
       const localVarOperationServerBasePath =
-        operationServerMap["AuthApi.externalCallback"]?.[
+        operationServerMap["AuthApi.callbackProvider"]?.[
           localVarOperationServerIndex
         ]?.url;
       return (axios, basePath) =>
@@ -380,28 +409,23 @@ export const AuthApiFp = function (configuration?: Configuration) {
     },
     /**
      *
-     * @summary Initialize the external authentication
-     * @param {string} provider An identifier for the auth provider
-     * @param {string} [state] Auth state
+     * @summary Fetch the available auth providers
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    async externalInitialize(
-      provider: string,
-      state?: string,
+    async listProviders(
       options?: RawAxiosRequestConfig,
     ): Promise<
-      (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>
+      (
+        axios?: AxiosInstance,
+        basePath?: string,
+      ) => AxiosPromise<ListProviders200Response>
     > {
       const localVarAxiosArgs =
-        await localVarAxiosParamCreator.externalInitialize(
-          provider,
-          state,
-          options,
-        );
+        await localVarAxiosParamCreator.listProviders(options);
       const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
       const localVarOperationServerBasePath =
-        operationServerMap["AuthApi.externalInitialize"]?.[
+        operationServerMap["AuthApi.listProviders"]?.[
           localVarOperationServerIndex
         ]?.url;
       return (axios, basePath) =>
@@ -415,18 +439,18 @@ export const AuthApiFp = function (configuration?: Configuration) {
     /**
      *
      * @summary Authenticate an user by credentials
-     * @param {AuthLogin} authLogin The credentials to authenticate
+     * @param {LoginAuthRequest} loginAuthRequest The credentials to authenticate
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     async loginAuth(
-      authLogin: AuthLogin,
+      loginAuthRequest: LoginAuthRequest,
       options?: RawAxiosRequestConfig,
     ): Promise<
       (axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthToken>
     > {
       const localVarAxiosArgs = await localVarAxiosParamCreator.loginAuth(
-        authLogin,
+        loginAuthRequest,
         options,
       );
       const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
@@ -467,6 +491,36 @@ export const AuthApiFp = function (configuration?: Configuration) {
           configuration,
         )(axios, localVarOperationServerBasePath || basePath);
     },
+    /**
+     *
+     * @summary Request the redirect to defined provider
+     * @param {string} provider An identifier for the auth provider
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    async requestProvider(
+      provider: string,
+      options?: RawAxiosRequestConfig,
+    ): Promise<
+      (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>
+    > {
+      const localVarAxiosArgs = await localVarAxiosParamCreator.requestProvider(
+        provider,
+        options,
+      );
+      const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+      const localVarOperationServerBasePath =
+        operationServerMap["AuthApi.requestProvider"]?.[
+          localVarOperationServerIndex
+        ]?.url;
+      return (axios, basePath) =>
+        createRequestFunction(
+          localVarAxiosArgs,
+          globalAxios,
+          BASE_PATH,
+          configuration,
+        )(axios, localVarOperationServerBasePath || basePath);
+    },
     /**
      *
      * @summary Verify validity for an authentication token
@@ -508,17 +562,17 @@ export const AuthApiFactory = function (
   return {
     /**
      *
-     * @summary Callback for external authentication
-     * @param {AuthApiExternalCallbackRequest} requestParameters Request parameters.
+     * @summary Callback to parse the defined provider
+     * @param {AuthApiCallbackProviderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    externalCallback(
-      requestParameters: AuthApiExternalCallbackRequest,
+    callbackProvider(
+      requestParameters: AuthApiCallbackProviderRequest,
       options?: RawAxiosRequestConfig,
-    ): AxiosPromise<Notification> {
+    ): AxiosPromise<void> {
       return localVarFp
-        .externalCallback(
+        .callbackProvider(
           requestParameters.provider,
           requestParameters.state,
           requestParameters.code,
@@ -528,21 +582,15 @@ export const AuthApiFactory = function (
     },
     /**
      *
-     * @summary Initialize the external authentication
-     * @param {AuthApiExternalInitializeRequest} requestParameters Request parameters.
+     * @summary Fetch the available auth providers
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    externalInitialize(
-      requestParameters: AuthApiExternalInitializeRequest,
+    listProviders(
       options?: RawAxiosRequestConfig,
-    ): AxiosPromise<Notification> {
+    ): AxiosPromise<ListProviders200Response> {
       return localVarFp
-        .externalInitialize(
-          requestParameters.provider,
-          requestParameters.state,
-          options,
-        )
+        .listProviders(options)
         .then((request) => request(axios, basePath));
     },
     /**
@@ -557,7 +605,7 @@ export const AuthApiFactory = function (
       options?: RawAxiosRequestConfig,
     ): AxiosPromise<AuthToken> {
       return localVarFp
-        .loginAuth(requestParameters.authLogin, options)
+        .loginAuth(requestParameters.loginAuthRequest, options)
         .then((request) => request(axios, basePath));
     },
     /**
@@ -571,6 +619,21 @@ export const AuthApiFactory = function (
         .refreshAuth(options)
         .then((request) => request(axios, basePath));
     },
+    /**
+     *
+     * @summary Request the redirect to defined provider
+     * @param {AuthApiRequestProviderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestProvider(
+      requestParameters: AuthApiRequestProviderRequest,
+      options?: RawAxiosRequestConfig,
+    ): AxiosPromise<void> {
+      return localVarFp
+        .requestProvider(requestParameters.provider, options)
+        .then((request) => request(axios, basePath));
+    },
     /**
      *
      * @summary Verify validity for an authentication token
@@ -586,66 +649,59 @@ export const AuthApiFactory = function (
 };
 
 /**
- * Request parameters for externalCallback operation in AuthApi.
+ * Request parameters for callbackProvider operation in AuthApi.
  * @export
- * @interface AuthApiExternalCallbackRequest
+ * @interface AuthApiCallbackProviderRequest
  */
-export interface AuthApiExternalCallbackRequest {
+export interface AuthApiCallbackProviderRequest {
   /**
    * An identifier for the auth provider
    * @type {string}
-   * @memberof AuthApiExternalCallback
+   * @memberof AuthApiCallbackProvider
    */
   readonly provider: string;
 
   /**
    * Auth state
    * @type {string}
-   * @memberof AuthApiExternalCallback
+   * @memberof AuthApiCallbackProvider
    */
   readonly state?: string;
 
   /**
    * Auth code
    * @type {string}
-   * @memberof AuthApiExternalCallback
+   * @memberof AuthApiCallbackProvider
    */
   readonly code?: string;
 }
 
 /**
- * Request parameters for externalInitialize operation in AuthApi.
+ * Request parameters for loginAuth operation in AuthApi.
  * @export
- * @interface AuthApiExternalInitializeRequest
+ * @interface AuthApiLoginAuthRequest
  */
-export interface AuthApiExternalInitializeRequest {
-  /**
-   * An identifier for the auth provider
-   * @type {string}
-   * @memberof AuthApiExternalInitialize
-   */
-  readonly provider: string;
-
+export interface AuthApiLoginAuthRequest {
   /**
-   * Auth state
-   * @type {string}
-   * @memberof AuthApiExternalInitialize
+   * The credentials to authenticate
+   * @type {LoginAuthRequest}
+   * @memberof AuthApiLoginAuth
    */
-  readonly state?: string;
+  readonly loginAuthRequest: LoginAuthRequest;
 }
 
 /**
- * Request parameters for loginAuth operation in AuthApi.
+ * Request parameters for requestProvider operation in AuthApi.
  * @export
- * @interface AuthApiLoginAuthRequest
+ * @interface AuthApiRequestProviderRequest
  */
-export interface AuthApiLoginAuthRequest {
+export interface AuthApiRequestProviderRequest {
   /**
-   * The credentials to authenticate
-   * @type {AuthLogin}
-   * @memberof AuthApiLoginAuth
+   * An identifier for the auth provider
+   * @type {string}
+   * @memberof AuthApiRequestProvider
    */
-  readonly authLogin: AuthLogin;
+  readonly provider: string;
 }
 
 /**
@@ -657,18 +713,18 @@ export interface AuthApiLoginAuthRequest {
 export class AuthApi extends BaseAPI {
   /**
    *
-   * @summary Callback for external authentication
-   * @param {AuthApiExternalCallbackRequest} requestParameters Request parameters.
+   * @summary Callback to parse the defined provider
+   * @param {AuthApiCallbackProviderRequest} requestParameters Request parameters.
    * @param {*} [options] Override http request option.
    * @throws {RequiredError}
    * @memberof AuthApi
    */
-  public externalCallback(
-    requestParameters: AuthApiExternalCallbackRequest,
+  public callbackProvider(
+    requestParameters: AuthApiCallbackProviderRequest,
     options?: RawAxiosRequestConfig,
   ) {
     return AuthApiFp(this.configuration)
-      .externalCallback(
+      .callbackProvider(
         requestParameters.provider,
         requestParameters.state,
         requestParameters.code,
@@ -679,22 +735,14 @@ export class AuthApi extends BaseAPI {
 
   /**
    *
-   * @summary Initialize the external authentication
-   * @param {AuthApiExternalInitializeRequest} requestParameters Request parameters.
+   * @summary Fetch the available auth providers
    * @param {*} [options] Override http request option.
    * @throws {RequiredError}
    * @memberof AuthApi
    */
-  public externalInitialize(
-    requestParameters: AuthApiExternalInitializeRequest,
-    options?: RawAxiosRequestConfig,
-  ) {
+  public listProviders(options?: RawAxiosRequestConfig) {
     return AuthApiFp(this.configuration)
-      .externalInitialize(
-        requestParameters.provider,
-        requestParameters.state,
-        options,
-      )
+      .listProviders(options)
       .then((request) => request(this.axios, this.basePath));
   }
 
@@ -711,7 +759,7 @@ export class AuthApi extends BaseAPI {
     options?: RawAxiosRequestConfig,
   ) {
     return AuthApiFp(this.configuration)
-      .loginAuth(requestParameters.authLogin, options)
+      .loginAuth(requestParameters.loginAuthRequest, options)
       .then((request) => request(this.axios, this.basePath));
   }
 
@@ -728,6 +776,23 @@ export class AuthApi extends BaseAPI {
       .then((request) => request(this.axios, this.basePath));
   }
 
+  /**
+   *
+   * @summary Request the redirect to defined provider
+   * @param {AuthApiRequestProviderRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof AuthApi
+   */
+  public requestProvider(
+    requestParameters: AuthApiRequestProviderRequest,
+    options?: RawAxiosRequestConfig,
+  ) {
+    return AuthApiFp(this.configuration)
+      .requestProvider(requestParameters.provider, options)
+      .then((request) => request(this.axios, this.basePath));
+  }
+
   /**
    *
    * @summary Verify validity for an authentication token