contentful-management 12.0.0-new-beta.3 → 12.0.0-new-beta.5

package/dist/types/entities/app-bundle.js

@@ -0,0 +1,46 @@
+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
+ */
+function createAppBundleApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+        appBundleId: data.sys.id,
+    });
+    return {
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppBundle',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Bundle data
+ * @return Wrapped App Bundle data
+ */
+function wrapAppBundle(makeRequest, data) {
+    const appBundle = toPlainObject(copy(data));
+    const appBundleWithMethods = enhanceWithMethods(appBundle, createAppBundleApi(makeRequest));
+    return freezeSys(appBundleWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Bundle collection data
+ * @return Wrapped App Bundle collection data
+ */
+const wrapAppBundleCollection = wrapCollection(wrapAppBundle);
+
+export { wrapAppBundle, wrapAppBundleCollection };
+//# sourceMappingURL=app-bundle.js.map

package/dist/types/entities/app-bundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-bundle.js","sources":["../../../lib/entities/app-bundle.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAmFA;;AAEG;AACH,SAAS,kBAAkB,CAAC,WAAwB,EAAA;AAClD,IAAA,MAAM,SAAS,GAAG,CAAC,IAAoB,MAAM;QAC3C,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QAC5C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC9C,QAAA,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE;AACzB,KAAA,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,SAAS,GAAG,GAAA;AAClB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAoB;AACnD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,WAAW;AACvB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA;;;;;AAKG;AACG,SAAU,aAAa,CAAC,WAAwB,EAAE,IAAoB,EAAA;IAC1E,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE3C,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,SAAS,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;AAE3F,IAAA,OAAO,SAAS,CAAC,oBAAoB,CAAC;AACxC;AAEA;;;;;AAKG;MACU,uBAAuB,GAAG,cAAc,CAAC,aAAa;;;;"}

package/dist/types/entities/app-definition.d.ts

@@ -0,0 +1,88 @@
+import type { DefaultElements, BasicMetaSysProps, SysLink, MakeRequest, Link } from '../common-types';
+import type { ContentfulAppDefinitionAPI } from '../create-app-definition-api';
+import type { SetOptional, Except } from 'type-fest';
+import type { FieldType } from './field-type';
+import type { InstallationParameterType, ParameterDefinition } from './widget-parameters';
+import type { AppInstallationProps } from './app-installation';
+import type { EnvironmentProps } from './environment';
+export interface NavigationItem {
+    name: string;
+    path: string;
+}
+/**
+ * These locations are currently restricted to internal Contentful apps only.
+ * If you are interested in using these locations for your app,
+ * please reach out to Contentful Support (https://www.contentful.com/support/).
+ */
+type InternalLocationType = 'agent';
+type LocationType = 'app-config' | 'entry-sidebar' | 'entry-editor' | 'dialog' | 'page' | 'home' | InternalLocationType;
+export interface SimpleLocation {
+    location: LocationType;
+}
+export interface EntryFieldLocation {
+    location: 'entry-field';
+    fieldTypes: FieldType[];
+}
+export interface PageLocation {
+    location: 'page';
+    navigationItem?: NavigationItem;
+}
+export type AppLocation = SimpleLocation | EntryFieldLocation | PageLocation;
+export type AppDefinitionProps = {
+    /**
+     * System metadata
+     */
+    sys: BasicMetaSysProps & {
+        organization: SysLink;
+        shared: boolean;
+    };
+    /**
+     * App name
+     */
+    name: string;
+    /**
+     * URL where the root HTML document of the app can be found
+     */
+    src?: string;
+    /**
+     * Link to an AppBundle
+     */
+    bundle?: Link<'AppBundle'>;
+    /**
+     * Locations where the app can be installed
+     */
+    locations?: AppLocation[];
+    /**
+     * Instance parameter definitions
+     */
+    parameters?: {
+        instance?: ParameterDefinition[];
+        installation?: ParameterDefinition<InstallationParameterType>[];
+    };
+};
+export type CreateAppDefinitionProps = SetOptional<Except<AppDefinitionProps, 'sys' | 'bundle'>, 'src' | 'locations'>;
+export type AppDefinition = ContentfulAppDefinitionAPI & AppDefinitionProps & DefaultElements<AppDefinitionProps>;
+export type AppInstallationsForOrganizationProps = {
+    sys: {
+        type: 'Array';
+    };
+    items: AppInstallationProps[];
+    includes: {
+        Environment: EnvironmentProps[];
+    };
+};
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Definition data
+ * @return Wrapped App Definition data
+ */
+export declare function wrapAppDefinition(makeRequest: MakeRequest, data: AppDefinitionProps): AppDefinition;
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Definition collection data
+ * @return Wrapped App Definition collection data
+ */
+export declare const wrapAppDefinitionCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<AppDefinitionProps>) => import("..").Collection<AppDefinition, AppDefinitionProps>;
+export {};

package/dist/types/entities/app-definition.js

@@ -0,0 +1,27 @@
+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';
+import createAppDefinitionApi from '../create-app-definition-api.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Definition data
+ * @return Wrapped App Definition data
+ */
+function wrapAppDefinition(makeRequest, data) {
+    const appDefinition = toPlainObject(copy(data));
+    const appDefinitionWithMethods = enhanceWithMethods(appDefinition, createAppDefinitionApi(makeRequest));
+    return freezeSys(appDefinitionWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Definition collection data
+ * @return Wrapped App Definition collection data
+ */
+const wrapAppDefinitionCollection = wrapCollection(wrapAppDefinition);
+
+export { wrapAppDefinition, wrapAppDefinitionCollection };
+//# sourceMappingURL=app-definition.js.map

package/dist/types/entities/app-definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-definition.js","sources":["../../../lib/entities/app-definition.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AA4GA;;;;;AAKG;AACG,SAAU,iBAAiB,CAC/B,WAAwB,EACxB,IAAwB,EAAA;IAExB,MAAM,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,wBAAwB,GAAG,kBAAkB,CACjD,aAAa,EACb,sBAAsB,CAAC,WAAW,CAAC,CACpC;AACD,IAAA,OAAO,SAAS,CAAC,wBAAwB,CAAC;AAC5C;AAEA;;;;;AAKG;MACU,2BAA2B,GAAG,cAAc,CAAC,iBAAiB;;;;"}

package/dist/types/entities/app-details.d.ts

@@ -0,0 +1,54 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
+type AppDetailsSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
+    appDefinition: SysLink;
+    organization: SysLink;
+};
+export type IconType = 'base64';
+export interface AppIcon {
+    value: string;
+    type: IconType;
+}
+export type AppDetailsProps = {
+    /**
+     * System metadata
+     */
+    sys: AppDetailsSys;
+    /**
+     * An Icon that represents the App
+     */
+    icon?: AppIcon;
+};
+export type CreateAppDetailsProps = {
+    /**
+     * An Icon that represents the App
+     */
+    icon?: AppIcon;
+};
+export interface AppDetails extends AppDetailsProps, DefaultElements<AppDetailsProps> {
+    /**
+     * 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((organization) => organization.getAppDetails(<app-id>))
+     * .then((appDetails) => appDetails.delete())
+     * .then(() => console.log('appDetails deleted'))
+     * .catch(console.error)
+     * ```
+     */
+    delete(): Promise<void>;
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppDetails data
+ * @return Wrapped AppDetails data
+ */
+export declare function wrapAppDetails(makeRequest: MakeRequest, data: AppDetailsProps): AppDetails;
+export {};

package/dist/types/entities/app-details.js

@@ -0,0 +1,38 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @return Wrapped App Details data
+ */
+function createAppDetailsApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppDetails',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppDetails data
+ * @return Wrapped AppDetails data
+ */
+function wrapAppDetails(makeRequest, data) {
+    const appDetails = toPlainObject(copy(data));
+    return enhanceWithMethods(appDetails, createAppDetailsApi(makeRequest));
+}
+
+export { wrapAppDetails };
+//# sourceMappingURL=app-details.js.map

package/dist/types/entities/app-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-details.js","sources":["../../../lib/entities/app-details.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAuDA;;;;AAIG;AACH,SAAS,mBAAmB,CAAC,WAAwB,EAAA;AACnD,IAAA,MAAM,SAAS,GAAG,CAAC,IAAqB,MAAM;QAC5C,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QAC5C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC/C,KAAA,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,SAAS,GAAG,GAAA;YAClB,MAAM,IAAI,GAAG,IAAuB;AACpC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,YAAY;AACxB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA;;;;;AAKG;AACG,SAAU,cAAc,CAAC,WAAwB,EAAE,IAAqB,EAAA;IAC5E,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,OAAO,kBAAkB,CAAC,UAAU,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;AACzE;;;;"}

package/dist/types/entities/app-event-subscription.d.ts

@@ -0,0 +1,50 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest, SysLink } from '../common-types';
+type AppEventSubscriptionSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
+    appDefinition: SysLink;
+    organization: SysLink;
+};
+export type AppEventSubscriptionProps = {
+    /**
+     * System metadata
+     */
+    sys: AppEventSubscriptionSys;
+    /** Subscription url that will receive events */
+    targetUrl?: string;
+    /** List of topics to subscribe to */
+    topics: string[];
+    /** Optional filter, transformation, or handler function */
+    functions?: {
+        filter?: Link<'Function'>;
+        transformation?: Link<'Function'>;
+        handler?: Link<'Function'>;
+    };
+};
+export type CreateAppEventSubscriptionProps = Except<AppEventSubscriptionProps, 'sys'>;
+export interface AppEventSubscription extends AppEventSubscriptionProps, DefaultElements<AppEventSubscriptionProps> {
+    /**
+     * 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((organization) => organization.getAppEventSubscription(<app-definition-id>))
+     * .then((eventSubscription) => eventSubscription.delete())
+     * .then(() => console.log('eventSubscription deleted'))
+     * .catch(console.error)
+     * ```
+     */
+    delete(): Promise<void>;
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppEventSubscription data
+ * @return Wrapped AppEventSubscription data
+ */
+export declare function wrapAppEventSubscription(makeRequest: MakeRequest, data: AppEventSubscriptionProps): AppEventSubscription;
+export {};

package/dist/types/entities/app-event-subscription.js

@@ -0,0 +1,33 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+function createEventSubscriptionApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppEventSubscription',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppEventSubscription data
+ * @return Wrapped AppEventSubscription data
+ */
+function wrapAppEventSubscription(makeRequest, data) {
+    const eventSubscription = toPlainObject(copy(data));
+    return enhanceWithMethods(eventSubscription, createEventSubscriptionApi(makeRequest));
+}
+
+export { wrapAppEventSubscription };
+//# sourceMappingURL=app-event-subscription.js.map

package/dist/types/entities/app-event-subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-event-subscription.js","sources":["../../../lib/entities/app-event-subscription.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AA0DA,SAAS,0BAA0B,CAAC,WAAwB,EAAA;AAC1D,IAAA,MAAM,SAAS,GAAG,CAAC,IAA+B,MAAM;QACtD,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QAC5C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC/C,KAAA,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,SAAS,GAAG,GAAA;YAClB,MAAM,IAAI,GAAG,IAAiC;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,sBAAsB;AAClC,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA;;;;;AAKG;AACG,SAAU,wBAAwB,CACtC,WAAwB,EACxB,IAA+B,EAAA;IAE/B,MAAM,iBAAiB,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnD,OAAO,kBAAkB,CAAC,iBAAiB,EAAE,0BAA0B,CAAC,WAAW,CAAC,CAAC;AACvF;;;;"}

package/dist/types/entities/app-installation.d.ts

@@ -0,0 +1,70 @@
+import type { DefaultElements, BasicMetaSysProps, SysLink, MakeRequest } from '../common-types';
+import type { Except } from 'type-fest';
+import type { FreeFormParameters } from './widget-parameters';
+export type AppInstallationProps = {
+    sys: Omit<BasicMetaSysProps, 'id'> & {
+        appDefinition: SysLink;
+        environment: SysLink;
+        space: SysLink;
+        organization: SysLink;
+    };
+    /**
+     * Free-form installation parameters (API limits stringified length to 32KB)
+     */
+    parameters?: FreeFormParameters;
+};
+export type CreateAppInstallationProps = Except<AppInstallationProps, 'sys'>;
+export interface AppInstallation extends AppInstallationProps, DefaultElements<AppInstallationProps> {
+    /**
+     * 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.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getAppInstallation('<app_definition_id>'))
+     * .then((appInstallation) => {
+     *    appInstallation.parameters.someParameter = 'New Value'
+     *    return appInstallation.update()
+     * })
+     * .then((appInstallation) => console.log(`App installation ${appInstallation.sys.id} was updated`))
+     * .catch(console.error)
+     * ```
+     */
+    update(): Promise<AppInstallation>;
+    /**
+     * 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.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getAppInstallation('<app_definition_id>'))
+     * .then((appInstallation) => appInstallation.delete())
+     * .then(() => console.log(`App installation deleted.`))
+     * .catch(console.error)
+     * ```
+     */
+    delete(): Promise<void>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Installation data
+ * @return Wrapped App installation data
+ */
+export declare function wrapAppInstallation(makeRequest: MakeRequest, data: AppInstallationProps): AppInstallation;
+/**
+ * @private
+ */
+export declare const wrapAppInstallationCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<AppInstallationProps>) => import("..").Collection<AppInstallation, AppInstallationProps>;

package/dist/types/entities/app-installation.js

@@ -0,0 +1,53 @@
+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
+ */
+function createAppInstallationApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space.sys.id,
+        environmentId: data.sys.environment.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        update: function update() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppInstallation',
+                action: 'upsert',
+                params: getParams(data),
+                headers: {},
+                payload: data,
+            }).then((data) => wrapAppInstallation(makeRequest, data));
+        },
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppInstallation',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Installation data
+ * @return Wrapped App installation data
+ */
+function wrapAppInstallation(makeRequest, data) {
+    const appInstallation = toPlainObject(copy(data));
+    const appInstallationWithMethods = enhanceWithMethods(appInstallation, createAppInstallationApi(makeRequest));
+    return freezeSys(appInstallationWithMethods);
+}
+/**
+ * @private
+ */
+const wrapAppInstallationCollection = wrapCollection(wrapAppInstallation);
+
+export { wrapAppInstallation, wrapAppInstallationCollection };
+//# sourceMappingURL=app-installation.js.map

package/dist/types/entities/app-installation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-installation.js","sources":["../../../lib/entities/app-installation.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAqEA;;AAEG;AACH,SAAS,wBAAwB,CAAC,WAAwB,EAAA;AACxD,IAAA,MAAM,SAAS,GAAG,CAAC,IAA0B,MAAM;QACjD,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QAC9B,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;QAC1C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC/C,KAAA,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,SAAS,MAAM,GAAA;AACrB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAA0B;AACzD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,iBAAiB;AAC7B,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACvB,gBAAA,OAAO,EAAE,EAAE;AACX,gBAAA,OAAO,EAAE,IAAI;AACd,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,EAAE,SAAS,GAAG,GAAA;AAClB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAA0B;AACzD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,iBAAiB;AAC7B,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA;;;;;AAKG;AACG,SAAU,mBAAmB,CACjC,WAAwB,EACxB,IAA0B,EAAA;IAE1B,MAAM,eAAe,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,0BAA0B,GAAG,kBAAkB,CACnD,eAAe,EACf,wBAAwB,CAAC,WAAW,CAAC,CACtC;AACD,IAAA,OAAO,SAAS,CAAC,0BAA0B,CAAC;AAC9C;AAEA;;AAEG;MACU,6BAA6B,GAAG,cAAc,CAAC,mBAAmB;;;;"}

package/dist/types/entities/app-key.d.ts

@@ -0,0 +1,77 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
+type AppKeySys = Except<BasicMetaSysProps, 'version'> & {
+    appDefinition: SysLink;
+    organization: SysLink;
+};
+export interface JWK {
+    alg: 'RS256';
+    kty: 'RSA';
+    use: 'sig';
+    x5c: [string];
+    kid: string;
+    x5t: string;
+}
+export type AppKeyProps = {
+    /**
+     * System metadata
+     */
+    sys: AppKeySys;
+    /**
+     * JSON Web Key
+     */
+    jwk: JWK;
+    /**
+     * If generated, private key is returned
+     */
+    generated?: {
+        /**
+         * Base64 PEM
+         */
+        privateKey: string;
+    };
+};
+export type CreateAppKeyProps = {
+    /**
+     * Toggle for automatic private key generation
+     */
+    generate?: boolean;
+    /**
+     * JSON Web Key, required if generate is falsy
+     */
+    jwk?: JWK;
+};
+export interface AppKey extends AppKeyProps, DefaultElements<AppKeyProps> {
+    /**
+     * 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((organization) => organization.getAppKey(<api-key-id>))
+     * .then((signingSecret) => signingSecret.delete())
+     * .then(() => console.log('signingSecret deleted'))
+     * .catch(console.error)
+     * ```
+     */
+    delete(): Promise<void>;
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppKey data
+ * @return Wrapped AppKey data
+ */
+export declare function wrapAppKey(makeRequest: MakeRequest, data: AppKeyProps): AppKey;
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Key collection data
+ * @return Wrapped App Key collection data
+ */
+export declare const wrapAppKeyCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<AppKeyProps>) => import("..").Collection<AppKey, AppKeyProps>;
+export {};

package/dist/types/entities/app-key.js

@@ -0,0 +1,42 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+function createKeyApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+        fingerprint: data.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppKey',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppKey data
+ * @return Wrapped AppKey data
+ */
+function wrapAppKey(makeRequest, data) {
+    const key = toPlainObject(copy(data));
+    return enhanceWithMethods(key, createKeyApi(makeRequest));
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Key collection data
+ * @return Wrapped App Key collection data
+ */
+const wrapAppKeyCollection = wrapCollection(wrapAppKey);
+
+export { wrapAppKey, wrapAppKeyCollection };
+//# sourceMappingURL=app-key.js.map

package/dist/types/entities/app-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-key.js","sources":["../../../lib/entities/app-key.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAwEA,SAAS,YAAY,CAAC,WAAwB,EAAA;AAC5C,IAAA,MAAM,SAAS,GAAG,CAAC,IAAiB,MAAM;QACxC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QAC5C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC9C,QAAA,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE;AACzB,KAAA,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,SAAS,GAAG,GAAA;YAClB,MAAM,IAAI,GAAG,IAAmB;AAChC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,QAAQ;AACpB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA;;;;;AAKG;AACG,SAAU,UAAU,CAAC,WAAwB,EAAE,IAAiB,EAAA;IACpE,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,kBAAkB,CAAC,GAAG,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;AAC3D;AAEA;;;;;AAKG;MACU,oBAAoB,GAAG,cAAc,CAAC,UAAU;;;;"}

package/dist/types/entities/app-signed-request.d.ts

@@ -0,0 +1,42 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
+type AppSignedRequestSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
+    appDefinition: SysLink;
+    space: SysLink;
+    environment: SysLink;
+};
+export type AppSignedRequestProps = {
+    /**
+     * System metadata
+     */
+    sys: AppSignedRequestSys;
+    /** new headers to be included in the request */
+    additionalHeaders: {
+        'x-contentful-signature': string;
+        'x-contentful-signed-headers': string;
+        'x-contentful-timestamp': string;
+        'x-contentful-space-id': string;
+        'x-contentful-environment-id': string;
+        'x-contentful-user-id': string;
+    };
+};
+export type CreateAppSignedRequestProps = {
+    /** the request method */
+    method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'PATCH' | 'HEAD';
+    /** the path of the request method */
+    path: string;
+    /** optional stringified body of the request */
+    body?: string;
+    /** optional headers of the request */
+    headers?: Record<string, string>;
+};
+export interface AppSignedRequest extends AppSignedRequestProps, DefaultElements<AppSignedRequestProps> {
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppSignedRequest data
+ * @return Wrapped AppSignedRequest data
+ */
+export declare function wrapAppSignedRequest(_makeRequest: MakeRequest, data: AppSignedRequestProps): AppSignedRequest;
+export {};

package/dist/types/entities/app-signed-request.js

@@ -0,0 +1,16 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppSignedRequest data
+ * @return Wrapped AppSignedRequest data
+ */
+function wrapAppSignedRequest(_makeRequest, data) {
+    const signedRequest = toPlainObject(copy(data));
+    return signedRequest;
+}
+
+export { wrapAppSignedRequest };
+//# sourceMappingURL=app-signed-request.js.map