contentful-management 7.5.2 → 7.7.0

package/dist/es-modules/create-cma-http-client.js

@@ -23,7 +23,7 @@ export function createCMAHttpClient(params) {
   var plainClient = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
   var sdkMain = plainClient ? 'contentful-management-plain.js' : 'contentful-management.js';
   var userAgentHeader = getUserAgentHeader( // @ts-expect-error
-  "".concat(sdkMain, "/").concat("7.5.2"), params.application, params.integration, params.feature);
+  "".concat(sdkMain, "/").concat("7.7.0"), params.application, params.integration, params.feature);
   var requiredHeaders = {
     'Content-Type': 'application/vnd.contentful.management.v1+json',
     'X-Contentful-User-Agent': userAgentHeader

package/dist/es-modules/create-contentful-api.js

@@ -153,8 +153,8 @@ export default function createClientApi(_ref) {
      * .catch(console.error)
      * ```
      */
-    getCurrentUser: function getCurrentUser() {
-      return endpoints.user.getCurrent(http).then(function (data) {
+    getCurrentUser: function getCurrentUser(params) {
+      return endpoints.user.getCurrent(http, params).then(function (data) {
         return wrapUser(http, data);
       });
     },

package/dist/es-modules/plain/endpoints/user.js

@@ -2,8 +2,10 @@ import * as raw from './raw';
 export var getForSpace = function getForSpace(http, params) {
   return raw.get(http, "/spaces/".concat(params.spaceId, "/users/").concat(params.userId));
 };
-export var getCurrent = function getCurrent(http) {
-  return raw.get(http, "/users/me");
+export var getCurrent = function getCurrent(http, params) {
+  return raw.get(http, "/users/me", {
+    params: params === null || params === void 0 ? void 0 : params.query
+  });
 };
 export var getManyForSpace = function getManyForSpace(http, params) {
   return raw.get(http, "/spaces/".concat(params.spaceId, "/users"), {

package/dist/es-modules/plain/plain-client.js

@@ -128,7 +128,25 @@ export var createPlainClient = function createPlainClient(params, defaults) {
     user: {
       getManyForSpace: wrap(wrapParams, endpoints.user.getManyForSpace),
       getForSpace: wrap(wrapParams, endpoints.user.getForSpace),
-      getCurrent: wrapHttp(_http, endpoints.user.getCurrent),
+      getCurrent: function (_getCurrent) {
+        function getCurrent() {
+          return _getCurrent.apply(this, arguments);
+        }
+
+        getCurrent.toString = function () {
+          return _getCurrent.toString();
+        };
+
+        return getCurrent;
+      }(function () {
+        var _endpoints$user;
+
+        for (var _len6 = arguments.length, args = new Array(_len6), _key6 = 0; _key6 < _len6; _key6++) {
+          args[_key6] = arguments[_key6];
+        }
+
+        return (_endpoints$user = endpoints.user).getCurrent.apply(_endpoints$user, [_http].concat(args));
+      }),
       getForOrganization: wrap(wrapParams, endpoints.user.getForOrganization),
       getManyForOrganization: wrap(wrapParams, endpoints.user.getManyForOrganization)
     },
@@ -187,8 +205,8 @@ export var createPlainClient = function createPlainClient(params, defaults) {
       }(function () {
         var _endpoints$personalAc;
 
-        for (var _len6 = arguments.length, args = new Array(_len6), _key6 = 0; _key6 < _len6; _key6++) {
-          args[_key6] = arguments[_key6];
+        for (var _len7 = arguments.length, args = new Array(_len7), _key7 = 0; _key7 < _len7; _key7++) {
+          args[_key7] = arguments[_key7];
         }
 
         return (_endpoints$personalAc = endpoints.personalAccessToken).create.apply(_endpoints$personalAc, [_http].concat(args));

package/dist/typings/create-contentful-api.d.ts

@@ -4,7 +4,9 @@ import { Collection, QueryOptions } from './common-types';
 import { OrganizationProp, Organization } from './entities/organization';
 import { SpaceProps, Space } from './entities/space';
 import { CreatePersonalAccessTokenProps } from './entities/personal-access-token';
+import { QueryParams } from './plain/endpoints/common-types';
 import { UsageQuery } from './entities/usage';
+import { UserProps } from './entities/user';
 export declare type ClientAPI = ReturnType<typeof createClientApi>;
 export default function createClientApi({ http }: {
     http: AxiosInstance;
@@ -110,7 +112,9 @@ export default function createClientApi({ http }: {
      * .catch(console.error)
      * ```
      */
-    getCurrentUser: () => Promise<import("./export-types").User>;
+    getCurrentUser: <T = UserProps>(params?: QueryParams | undefined) => Promise<T & {
+        toPlainObject(): T;
+    }>;
     /**
      * Creates a personal access token
      * @param data - personal access token config

package/dist/typings/create-organization-api.d.ts

@@ -26,7 +26,9 @@ export default function createOrganizationApi({ http }: {
      * .catch(console.error)
      * ```
      */
-    getUser(id: string): Promise<import("./export-types").User>;
+    getUser(id: string): Promise<import("./export-types").UserProps & {
+        toPlainObject(): import("./export-types").UserProps;
+    }>;
     /**
      * Gets a collection of Users in organization
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -43,7 +45,9 @@ export default function createOrganizationApi({ http }: {
      * .catch(console.error)
      * ```
      */
-    getUsers(query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").User, import("./export-types").UserProps>>;
+    getUsers(query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").UserProps & {
+        toPlainObject(): import("./export-types").UserProps;
+    }, import("./export-types").UserProps>>;
     /**
      * Gets an Organization Membership
      * @param id - Organization Membership ID

package/dist/typings/create-space-api.d.ts

@@ -364,7 +364,9 @@ export default function createSpaceApi({ http }: {
      * .catch(console.error)
      * ```
      */
-    getSpaceUser(userId: string): Promise<import("./export-types").User>;
+    getSpaceUser(userId: string): Promise<import("./export-types").UserProps & {
+        toPlainObject(): import("./export-types").UserProps;
+    }>;
     /**
      * Gets a collection of Users in a space
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -378,7 +380,9 @@ export default function createSpaceApi({ http }: {
      * .catch(console.error)
      * ```
      */
-    getSpaceUsers(query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").User, import("./export-types").UserProps>>;
+    getSpaceUsers(query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").UserProps & {
+        toPlainObject(): import("./export-types").UserProps;
+    }, import("./export-types").UserProps>>;
     /**
      * Gets a Space Member
      * @param id Get Space Member by user_id

package/dist/typings/entities/user.d.ts

@@ -44,11 +44,15 @@ export interface User extends UserProps, DefaultElements<UserProps> {
  * @param data - Raw data
  * @return Normalized user
  */
-export declare function wrapUser(http: AxiosInstance, data: UserProps): User;
+export declare function wrapUser<T = UserProps>(http: AxiosInstance, data: T): T & {
+    toPlainObject(): T;
+};
 /**
  * @private
  * @param http - HTTP client instance
  * @param data - Raw data collection
  * @return Normalized user collection
  */
-export declare const wrapUserCollection: (http: AxiosInstance, data: import("../common-types").CollectionProp<UserProps>) => import("../common-types").Collection<User, UserProps>;
+export declare const wrapUserCollection: <T = UserProps>(http: AxiosInstance, data: import("../common-types").CollectionProp<T>) => import("../common-types").Collection<T & {
+    toPlainObject(): T;
+}, T>;

package/dist/typings/plain/endpoints/raw.d.ts

@@ -3,4 +3,4 @@ export declare function get<T = any>(http: AxiosInstance, url: string, config?:
 export declare function post<T = any>(http: AxiosInstance, url: string, payload?: any, config?: AxiosRequestConfig): Promise<T>;
 export declare function put<T = any>(http: AxiosInstance, url: string, payload?: any, config?: AxiosRequestConfig): Promise<T>;
 export declare function del<T = any>(http: AxiosInstance, url: string, config?: AxiosRequestConfig): Promise<T>;
-export declare function http<T = any>(http: AxiosInstance, url: string, config?: AxiosRequestConfig): Promise<any>;
+export declare function http<T = any>(http: AxiosInstance, url: string, config?: AxiosRequestConfig): Promise<T>;

package/dist/typings/plain/endpoints/user.d.ts

@@ -4,7 +4,7 @@ import { UserProps } from '../../entities/user';
 export declare const getForSpace: (http: AxiosInstance, params: GetSpaceParams & {
     userId: string;
 }) => Promise<UserProps>;
-export declare const getCurrent: (http: AxiosInstance) => Promise<UserProps>;
+export declare const getCurrent: <T = UserProps>(http: AxiosInstance, params?: QueryParams | undefined) => Promise<T>;
 export declare const getManyForSpace: (http: AxiosInstance, params: GetSpaceParams & QueryParams) => Promise<CollectionProp<UserProps>>;
 export declare const getForOrganization: (http: AxiosInstance, params: GetOrganizationParams & {
     userId: string;

package/dist/typings/plain/plain-client.d.ts

@@ -6,11 +6,11 @@ export declare type PlainClientAPI = ReturnType<typeof createPlainClient>;
 export declare const createPlainClient: (params: ClientParams, defaults?: DefaultParams | undefined) => {
     raw: {
         getDefaultParams: () => DefaultParams | undefined;
-        get: (url: string, config?: import("axios").AxiosRequestConfig | undefined) => Promise<any>;
-        post: (url: string, payload?: any, config?: import("axios").AxiosRequestConfig | undefined) => Promise<any>;
-        put: (url: string, payload?: any, config?: import("axios").AxiosRequestConfig | undefined) => Promise<any>;
-        delete: (url: string, config?: import("axios").AxiosRequestConfig | undefined) => Promise<any>;
-        http: (url: string, config?: import("axios").AxiosRequestConfig | undefined) => Promise<any>;
+        get: <T = unknown>(url: string, config?: import("axios").AxiosRequestConfig | undefined) => Promise<T>;
+        post: <T_1 = unknown>(url: string, payload?: any, config?: import("axios").AxiosRequestConfig | undefined) => Promise<T_1>;
+        put: <T_2 = unknown>(url: string, payload?: any, config?: import("axios").AxiosRequestConfig | undefined) => Promise<T_2>;
+        delete: <T_3 = unknown>(url: string, config?: import("axios").AxiosRequestConfig | undefined) => Promise<T_3>;
+        http: <T_4 = unknown>(url: string, config?: import("axios").AxiosRequestConfig | undefined) => Promise<T_4>;
     };
     editorInterface: {
         get: (params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
@@ -111,7 +111,7 @@ export declare const createPlainClient: (params: ClientParams, defaults?: Defaul
         }, "userId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceParams & {
             userId: string;
         }, "spaceId">>) => Promise<import("../export-types").UserProps>;
-        getCurrent: () => Promise<import("../export-types").UserProps>;
+        getCurrent: (params?: import("./endpoints/common-types").QueryParams | undefined) => Promise<import("../export-types").UserProps>;
         getForOrganization: (params: Pick<import("./endpoints/common-types").GetOrganizationParams & {
             userId: string;
         }, "userId"> & Partial<Pick<import("./endpoints/common-types").GetOrganizationParams & {
@@ -120,54 +120,54 @@ export declare const createPlainClient: (params: ClientParams, defaults?: Defaul
         getManyForOrganization: (params: Pick<import("./endpoints/common-types").GetOrganizationParams & import("./endpoints/common-types").QueryParams, "query"> & Partial<Pick<import("./endpoints/common-types").GetOrganizationParams & import("./endpoints/common-types").QueryParams, "organizationId">>) => Promise<import("../common-types").CollectionProp<import("../export-types").UserProps>>;
     };
     entry: {
-        getMany: <T extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & import("./endpoints/common-types").QueryParams, "query"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & import("./endpoints/common-types").QueryParams, "spaceId" | "environmentId">>) => Promise<import("../common-types").CollectionProp<import("../export-types").EntryProps<T>>>;
-        get: <T_1 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        getMany: <T_5 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & import("./endpoints/common-types").QueryParams, "query"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & import("./endpoints/common-types").QueryParams, "spaceId" | "environmentId">>) => Promise<import("../common-types").CollectionProp<import("../export-types").EntryProps<T_5>>>;
+        get: <T_6 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         } & import("./endpoints/common-types").QueryParams, "query" | "entryId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
-        } & import("./endpoints/common-types").QueryParams, "spaceId" | "environmentId">>) => Promise<import("../export-types").EntryProps<T_1>>;
-        update: <T_2 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        } & import("./endpoints/common-types").QueryParams, "spaceId" | "environmentId">>) => Promise<import("../export-types").EntryProps<T_6>>;
+        update: <T_7 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         }, "entryId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
-        }, "spaceId" | "environmentId">>, rawData: import("../export-types").EntryProps<T_2>, headers?: Record<string, unknown> | undefined) => Promise<import("../export-types").EntryProps<T_2>>;
+        }, "spaceId" | "environmentId">>, rawData: import("../export-types").EntryProps<T_7>, headers?: Record<string, unknown> | undefined) => Promise<import("../export-types").EntryProps<T_7>>;
         delete: (params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         }, "entryId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         }, "spaceId" | "environmentId">>) => Promise<any>;
-        publish: <T_3 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        publish: <T_8 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         }, "entryId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
-        }, "spaceId" | "environmentId">>, rawData: import("../export-types").EntryProps<T_3>) => Promise<import("../export-types").EntryProps<T_3>>;
-        unpublish: <T_4 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        }, "spaceId" | "environmentId">>, rawData: import("../export-types").EntryProps<T_8>) => Promise<import("../export-types").EntryProps<T_8>>;
+        unpublish: <T_9 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         }, "entryId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
-        }, "spaceId" | "environmentId">>) => Promise<import("../export-types").EntryProps<T_4>>;
-        archive: <T_5 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        }, "spaceId" | "environmentId">>) => Promise<import("../export-types").EntryProps<T_9>>;
+        archive: <T_10 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         }, "entryId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
-        }, "spaceId" | "environmentId">>) => Promise<import("../export-types").EntryProps<T_5>>;
-        unarchive: <T_6 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        }, "spaceId" | "environmentId">>) => Promise<import("../export-types").EntryProps<T_10>>;
+        unarchive: <T_11 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         }, "entryId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
-        }, "spaceId" | "environmentId">>) => Promise<import("../export-types").EntryProps<T_6>>;
-        create: <T_7 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        }, "spaceId" | "environmentId">>) => Promise<import("../export-types").EntryProps<T_11>>;
+        create: <T_12 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             contentTypeId: string;
         }, "contentTypeId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             contentTypeId: string;
-        }, "spaceId" | "environmentId">>, rawData: Pick<import("../export-types").EntryProps<T_7>, "metadata" | "fields">) => Promise<import("../export-types").EntryProps<T_7>>;
-        createWithId: <T_8 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        }, "spaceId" | "environmentId">>, rawData: Pick<import("../export-types").EntryProps<T_12>, "metadata" | "fields">) => Promise<import("../export-types").EntryProps<T_12>>;
+        createWithId: <T_13 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
             contentTypeId: string;
         }, "contentTypeId" | "entryId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
             contentTypeId: string;
-        }, "spaceId" | "environmentId">>, rawData: Pick<import("../export-types").EntryProps<T_8>, "metadata" | "fields">) => Promise<import("../export-types").EntryProps<T_8>>;
+        }, "spaceId" | "environmentId">>, rawData: Pick<import("../export-types").EntryProps<T_13>, "metadata" | "fields">) => Promise<import("../export-types").EntryProps<T_13>>;
     };
     asset: {
         getMany: (params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & import("./endpoints/common-types").QueryParams, "query"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & import("./endpoints/common-types").QueryParams, "spaceId" | "environmentId">>) => Promise<import("../common-types").CollectionProp<import("../export-types").AssetProps>>;
@@ -486,12 +486,12 @@ export declare const createPlainClient: (params: ClientParams, defaults?: Defaul
         }, "spaceId">>) => Promise<any>;
     };
     snapshot: {
-        getManyForEntry: <T_9 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        getManyForEntry: <T_14 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         } & import("./endpoints/common-types").QueryParams, "query" | "entryId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
-        } & import("./endpoints/common-types").QueryParams, "spaceId" | "environmentId">>) => Promise<import("../common-types").CollectionProp<import("../export-types").SnapshotProps<import("../export-types").EntryProps<T_9>>>>;
-        getForEntry: <T_10 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
+        } & import("./endpoints/common-types").QueryParams, "spaceId" | "environmentId">>) => Promise<import("../common-types").CollectionProp<import("../export-types").SnapshotProps<import("../export-types").EntryProps<T_14>>>>;
+        getForEntry: <T_15 extends Record<string, any> = Record<string, any>>(params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             entryId: string;
         } & {
             snapshotId: string;
@@ -499,7 +499,7 @@ export declare const createPlainClient: (params: ClientParams, defaults?: Defaul
             entryId: string;
         } & {
             snapshotId: string;
-        }, "spaceId" | "environmentId">>) => Promise<import("../export-types").SnapshotProps<import("../export-types").EntryProps<T_10>>>;
+        }, "spaceId" | "environmentId">>) => Promise<import("../export-types").SnapshotProps<import("../export-types").EntryProps<T_15>>>;
         getManyForContentType: (params: Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {
             contentTypeId: string;
         } & import("./endpoints/common-types").QueryParams, "query" | "contentTypeId"> & Partial<Pick<import("./endpoints/common-types").GetSpaceEnvironmentParams & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "7.5.2",
+  "version": "7.7.0",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "main": "./dist/contentful-management.node.js",
@@ -120,7 +120,7 @@
     "rimraf": "^3.0.2",
     "semantic-release": "^17.0.4",
     "sinon": "^9.0.1",
-    "typedoc": "^0.18.0",
+    "typedoc": "0.19.2",
     "typescript": "^3.9.3",
     "webpack": "^4.23.1",
     "webpack-bundle-analyzer": "^4.2.0",