contentful-management 11.60.3 → 12.0.0-beta.10

package/dist/types/entities/team.d.ts

@@ -0,0 +1,71 @@
+import type { DefaultElements, MetaSysProps, MakeRequest, Link } from '../common-types.js';
+export type TeamProps = {
+    /**
+     * System metadata
+     */
+    sys: MetaSysProps & {
+        memberCount: number;
+        organization: Link<'Organization'>;
+    };
+    /**
+     * Name of the team
+     */
+    name: string;
+    /**
+     * Description of the team
+     */
+    description: string;
+};
+export type CreateTeamProps = Omit<TeamProps, 'sys'>;
+export interface Team extends TeamProps, DefaultElements<TeamProps> {
+    /**
+     * Deletes this object on the server.
+     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOrganization('organization_id')
+     * .then(org => org.getOrganizationMembership('organizationMembership_id'))
+     * .then((team) => {
+     *  team.delete();
+     * })
+     * .catch(console.error)
+     * ```
+     */
+    delete(): Promise<void>;
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @return Object returned from the server with updated changes.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOrganization('organization_id')
+     * .then(org => org.getTeam('team_id'))
+     * .then((team) => {
+     *  team.description = 'new description';
+     *  team.update();
+     * })
+     * .catch(console.error)
+     * ```
+     */
+    update(): Promise<Team>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw team data
+ * @return Wrapped team data
+ */
+export declare function wrapTeam(makeRequest: MakeRequest, data: TeamProps): Team;
+/**
+ * @private
+ */
+export declare const wrapTeamCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<TeamProps>) => import("../common-types.js").Collection<Team, TeamProps>;

package/dist/types/entities/team.js

@@ -0,0 +1,50 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ */
+function createTeamApi(makeRequest) {
+    const getParams = (data) => ({
+        teamId: data.sys.id,
+        organizationId: data.sys.organization.sys.id,
+    });
+    return {
+        update: function update() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Team',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+            }).then((data) => wrapTeam(makeRequest, data));
+        },
+        delete: function del() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Team',
+                action: 'delete',
+                params: getParams(raw),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw team data
+ * @return Wrapped team data
+ */
+function wrapTeam(makeRequest, data) {
+    const team = toPlainObject(copy(data));
+    const teamWithMethods = enhanceWithMethods(team, createTeamApi(makeRequest));
+    return freezeSys(teamWithMethods);
+}
+/**
+ * @private
+ */
+const wrapTeamCollection = wrapCollection(wrapTeam);
+
+export { wrapTeam, wrapTeamCollection };

package/dist/types/entities/ui-config.d.ts

@@ -0,0 +1,59 @@
+import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types.js';
+export type UIConfigProps = {
+    /**
+     * System metadata
+     */
+    sys: UIConfigSysProps;
+    assetListViews: ViewFolder[];
+    entryListViews: ViewFolder[];
+    homeViews: HomeView[];
+    livePreview?: {
+        previewMode: 'livePreview' | 'legacyPreview';
+    };
+    publish?: {
+        publishMode: 'entryPublishing' | 'localePublishing';
+    };
+};
+export interface UIConfigSysProps extends BasicMetaSysProps {
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
+}
+interface HomeView {
+    widgetId: string;
+    widgetNamespace: string;
+}
+interface ViewFolder {
+    id: string;
+    title: string;
+    views: View[];
+}
+interface View {
+    id: string;
+    title: string;
+    order?: {
+        fieldId: string;
+        direction: 'ascending' | 'descending';
+    };
+    displayedFieldIds?: string[];
+    contentTypeId?: string | null;
+    contentTypeIds?: string[];
+    searchText?: string;
+    searchFilters?: [string, string, string][];
+    roles?: string[];
+}
+export interface UIConfig extends UIConfigProps, DefaultElements<UIConfigProps> {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data
+ * @return Wrapped UIConfig
+ */
+export declare function wrapUIConfig(makeRequest: MakeRequest, data: UIConfigProps): {
+    update: () => Promise</*elided*/ any & UIConfigProps & {
+        toPlainObject(): UIConfigProps;
+    }>;
+} & UIConfigProps & {
+    toPlainObject(): UIConfigProps;
+};
+export {};

package/dist/types/entities/ui-config.js

@@ -0,0 +1,18 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import createUIConfigApi from '../create-ui-config-api.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data
+ * @return Wrapped UIConfig
+ */
+function wrapUIConfig(makeRequest, data) {
+    const user = toPlainObject(copy(data));
+    const userWithMethods = enhanceWithMethods(user, createUIConfigApi(makeRequest));
+    return freezeSys(userWithMethods);
+}
+
+export { wrapUIConfig };

package/dist/types/entities/upload-credential.d.ts

@@ -0,0 +1,43 @@
+import type { DefaultElements, Link, MakeRequest, MetaSysProps } from '../common-types.js';
+export type UploadCredentialProps = {
+    /**
+     * System metadata
+     */
+    sys: MetaSysProps & {
+        space: Link<'Space'>;
+        environment?: Link<'Environment'>;
+    };
+};
+export interface UploadCredential extends UploadCredentialProps, DefaultElements<UploadCredentialProps> {
+    /**
+     * creates the upload credentials.
+     * @return upload credentials for file uploads
+     * @example
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * try {
+     *   const space = await client.getSpace('<space_id>')
+     *   const environment = await space.getEnvironment('<environment_id>')
+     *
+     *   const upload = await client.uploadCredential.create({
+     *     spaceId: space.sys.id,
+     *     environmentId: environment.sys.id
+     *   })
+     * } catch (error) {
+     *  console.error(error)
+     * }
+     *
+     */
+    create(): Promise<UploadCredentialProps>;
+}
+/**
+ * @private
+ * @param {function} makeRequest - function to make requests via an adapter
+ * @param {object} data - Raw upload credential data
+ * @return {UploadCredential} Wrapped upload credential data
+ */
+export declare function wrapUploadCredential(makeRequest: MakeRequest, data: UploadCredentialProps): UploadCredential;

package/dist/types/entities/upload.d.ts

@@ -0,0 +1,41 @@
+import type { DefaultElements, Link, MakeRequest, MetaSysProps } from '../common-types.js';
+export type UploadProps = {
+    /**
+     * System metadata
+     */
+    sys: MetaSysProps & {
+        space: Link<'Space'>;
+        environment?: Link<'Environment'>;
+    };
+};
+export interface Upload extends UploadProps, DefaultElements<UploadProps> {
+    /**
+     * Deletes this object on the server.
+     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
+     * @example
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getUpload('<upload_id>'))
+     * .then((upload) => upload.delete())
+     * .then((upload) => console.log(`upload ${upload.sys.id} updated.`))
+     * .catch(console.error)
+     */
+    delete(): Promise<void>;
+}
+/**
+ * @private
+ * @param {function} makeRequest - function to make requests via an adapter
+ * @param {object} data - Raw upload data
+ * @return {Upload} Wrapped upload data
+ */
+export declare function wrapUpload(makeRequest: MakeRequest, data: UploadProps): {
+    delete: () => Promise<void>;
+} & UploadProps & {
+    toPlainObject(): UploadProps;
+};

package/dist/types/entities/upload.js

@@ -0,0 +1,36 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ */
+function createUploadApi(makeRequest) {
+    return {
+        delete: async function del() {
+            const raw = this.toPlainObject();
+            await makeRequest({
+                entityType: 'Upload',
+                action: 'delete',
+                params: {
+                    spaceId: raw.sys.space.sys.id,
+                    environmentId: raw.sys.id,
+                    uploadId: raw.sys.id,
+                },
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param {function} makeRequest - function to make requests via an adapter
+ * @param {object} data - Raw upload data
+ * @return {Upload} Wrapped upload data
+ */
+function wrapUpload(makeRequest, data) {
+    const upload = toPlainObject(copy(data));
+    const uploadWithMethods = enhanceWithMethods(upload, createUploadApi(makeRequest));
+    return freezeSys(uploadWithMethods);
+}
+
+export { wrapUpload };

package/dist/types/entities/usage.d.ts

@@ -0,0 +1,55 @@
+import type { DefaultElements, Link, MakeRequest, QueryOptions } from '../common-types.js';
+export type UsageMetricEnum = 'cda' | 'cma' | 'cpa' | 'gql';
+export interface UsageQuery extends QueryOptions {
+    'metric[in]'?: string;
+    'dateRange.startAt'?: string;
+    'dateRange.endAt'?: string;
+}
+export type UsageProps<TType extends 'SpacePeriodicUsage' | 'OrganizationPeriodicUsage' = 'SpacePeriodicUsage' | 'OrganizationPeriodicUsage'> = {
+    /**
+     * System metadata
+     */
+    sys: {
+        id: string;
+        type: TType;
+        organization?: Link<'Organization'>;
+    };
+    /**
+     * Type of usage
+     */
+    metric: UsageMetricEnum;
+    /**
+     * Unit of usage metric
+     */
+    unitOfMeasure: string;
+    /**
+     * Range of usage
+     */
+    dateRange: {
+        startAt: string;
+        endAt: string;
+    };
+    /**
+     * Value of the usage
+     */
+    usage: number;
+    /**
+     * Usage per day
+     */
+    usagePerDay: {
+        [key: string]: number;
+    };
+};
+export interface Usage extends UsageProps, DefaultElements<UsageProps> {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data
+ * @return Normalized usage
+ */
+export declare function wrapUsage(_makeRequest: MakeRequest, data: UsageProps): Usage;
+/**
+ * @private
+ */
+export declare const wrapUsageCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<UsageProps<"SpacePeriodicUsage" | "OrganizationPeriodicUsage">>) => import("../common-types.js").Collection<Usage, UsageProps<"SpacePeriodicUsage" | "OrganizationPeriodicUsage">>;

package/dist/types/entities/usage.js

@@ -0,0 +1,22 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data
+ * @return Normalized usage
+ */
+function wrapUsage(_makeRequest, data) {
+    const usage = toPlainObject(copy(data));
+    const usageWithMethods = enhanceWithMethods(usage, {});
+    return freezeSys(usageWithMethods);
+}
+/**
+ * @private
+ */
+const wrapUsageCollection = wrapCollection(wrapUsage);
+
+export { wrapUsage, wrapUsageCollection };

package/dist/types/entities/user-ui-config.d.ts

@@ -0,0 +1,46 @@
+import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types.js';
+export type UserUIConfigProps = {
+    /**
+     * System metadata
+     */
+    sys: UserUIConfigSysProps;
+    assetListViews: ViewFolder[];
+    entryListViews: ViewFolder[];
+};
+export interface UserUIConfigSysProps extends BasicMetaSysProps {
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
+}
+interface ViewFolder {
+    id: string;
+    title: string;
+    views: View[];
+}
+interface View {
+    id: string;
+    title: string;
+    order?: {
+        fieldId: string;
+        direction: 'ascending' | 'descending';
+    };
+    displayedFieldIds?: string[];
+    contentTypeId: string | null;
+    searchText?: string;
+    searchFilters?: [string, string, string][];
+}
+export interface UserUIConfig extends UserUIConfigProps, DefaultElements<UserUIConfigProps> {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data
+ * @return Wrapped UserUIConfig
+ */
+export declare function wrapUserUIConfig(makeRequest: MakeRequest, data: UserUIConfigProps): {
+    update: () => Promise</*elided*/ any & UserUIConfigProps & {
+        toPlainObject(): UserUIConfigProps;
+    }>;
+} & UserUIConfigProps & {
+    toPlainObject(): UserUIConfigProps;
+};
+export {};

package/dist/types/entities/user-ui-config.js

@@ -0,0 +1,18 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import createUserUIConfigApi from '../create-user-ui-config-api.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data
+ * @return Wrapped UserUIConfig
+ */
+function wrapUserUIConfig(makeRequest, data) {
+    const user = toPlainObject(copy(data));
+    const userWithMethods = enhanceWithMethods(user, createUserUIConfigApi(makeRequest));
+    return freezeSys(userWithMethods);
+}
+
+export { wrapUserUIConfig };

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

@@ -0,0 +1,57 @@
+import type { DefaultElements, BasicMetaSysProps, MakeRequest } from '../common-types.js';
+export type UserProps = {
+    /**
+     * System metadata
+     */
+    sys: BasicMetaSysProps;
+    /**
+     * First name of the user
+     */
+    firstName: string;
+    /**
+     * Last name of the user
+     */
+    lastName: string;
+    /**
+     * Url to the users avatar
+     */
+    avatarUrl: string;
+    /**
+     * Email address of the user
+     */
+    email: string;
+    /**
+     * Activation flag
+     */
+    activated: boolean;
+    /**
+     * Number of sign ins
+     */
+    signInCount: number;
+    /**
+     * User confirmation flag
+     */
+    confirmed: boolean;
+    '2faEnabled': boolean;
+    cookieConsentData: string;
+};
+export interface User extends UserProps, DefaultElements<UserProps> {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data
+ * @return Normalized user
+ */
+export declare function wrapUser<T = UserProps>(_makeRequest: MakeRequest, data: T): T & {
+    toPlainObject(): T;
+};
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data collection
+ * @return Normalized user collection
+ */
+export declare const wrapUserCollection: <T = UserProps>(makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<T>) => import("../common-types.js").Collection<T & {
+    toPlainObject(): T;
+}, T>;

package/dist/types/entities/user.js

@@ -0,0 +1,25 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data
+ * @return Normalized user
+ */
+function wrapUser(_makeRequest, data) {
+    const user = toPlainObject(copy(data));
+    const userWithMethods = enhanceWithMethods(user, {});
+    return freezeSys(userWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw data collection
+ * @return Normalized user collection
+ */
+const wrapUserCollection = wrapCollection(wrapUser);
+
+export { wrapUser, wrapUserCollection };