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

package/dist/types/entities/scheduled-action.d.ts

@@ -0,0 +1,112 @@
+import type { DefaultElements, ISO8601Timestamp, MetaLinkProps, Link, MakeRequest, SysLink, ScheduledActionReferenceFilters, BasicCursorPaginationOptions, CollectionProp } from '../common-types';
+/**
+ * Represents that state of the scheduled action
+ */
+export declare enum ScheduledActionStatus {
+    /** action is pending execution */
+    scheduled = "scheduled",
+    /** action has been started and pending completion */
+    inProgress = "inProgress",
+    /** action was completed successfully (terminal state) */
+    succeeded = "succeeded",
+    /** action failed to complete (terminal state) */
+    failed = "failed",
+    /** action was canceled by a user (terminal state) */
+    canceled = "canceled"
+}
+type SchedulableEntityType = 'Entry' | 'Asset' | 'Release';
+type SchedulableActionType = 'publish' | 'unpublish';
+type ErrorDetail = {
+    error: any;
+};
+interface ScheduledActionFailedError {
+    sys: {
+        type: 'Error';
+        id: string;
+    };
+    message?: string;
+    details?: {
+        errors: ErrorDetail[];
+    };
+}
+export interface CursorPaginatedCollectionProp<TObj> extends Omit<CollectionProp<TObj>, 'total' | 'skip'> {
+    pages?: BasicCursorPaginationOptions;
+}
+export type ScheduledActionSysProps = {
+    id: string;
+    type: 'ScheduledAction';
+    version: number;
+    space: SysLink;
+    status: ScheduledActionStatus;
+    createdAt: ISO8601Timestamp;
+    createdBy: Link<'User'> | Link<'AppDefinition'>;
+    /** an ISO8601 date string representing when an action was moved to canceled */
+    canceledAt?: ISO8601Timestamp;
+    canceledBy?: Link<'User'> | Link<'AppDefinition'>;
+    /** an ISO8601 date string representing when an action was updated */
+    updatedAt: ISO8601Timestamp;
+    updatedBy: Link<'User'> | Link<'AppDefinition'>;
+};
+export type ScheduledActionPayloadProps = {
+    withReferences?: Record<ScheduledActionReferenceFilters, string[]>;
+};
+export type ScheduledActionProps = {
+    sys: ScheduledActionSysProps;
+    action: SchedulableActionType;
+    entity: Link<SchedulableEntityType>;
+    environment?: {
+        sys: MetaLinkProps;
+    };
+    scheduledFor: {
+        datetime: ISO8601Timestamp;
+        /**
+         * A valid IANA timezone Olson identifier
+         *
+         * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+         * @example 'Asia/Kolkata'
+         */
+        timezone?: string;
+    };
+    /**
+     * The Contentful-style error that occurred during execution if sys.status is failed
+     *
+     * @example
+     * {
+     *   sys: {
+     *     type: 'Error',
+     *     id: 'InvalidEntry'
+     *   },
+     *   message: 'Entry is invalid',
+     *   details: {
+     *     errors: [...]
+     *   }
+     * }
+     */
+    error?: ScheduledActionFailedError;
+    payload?: ScheduledActionPayloadProps;
+};
+export type CreateUpdateScheduledActionProps = Pick<ScheduledActionProps, 'action' | 'entity' | 'environment' | 'scheduledFor' | 'payload'>;
+export type ScheduledActionCollection = CursorPaginatedCollectionProp<ScheduledActionProps>;
+export interface ScheduledActionQueryOptions {
+    'environment.sys.id': string;
+    [key: string]: any;
+    limit?: number;
+    next?: string;
+    prev?: string;
+}
+export type ScheduledActionApi = {
+    delete(): Promise<ScheduledAction>;
+    update(): Promise<ScheduledAction>;
+};
+export interface ScheduledAction extends ScheduledActionProps, DefaultElements<ScheduledActionProps>, ScheduledActionApi {
+}
+export default function getInstanceMethods(makeRequest: MakeRequest): ScheduledActionApi;
+/**
+ * @private
+ */
+export declare function wrapScheduledAction(makeRequest: MakeRequest, data: ScheduledActionProps): ScheduledAction;
+/**
+ * @private
+ */
+export declare const wrapScheduledActionCollection: (makeRequest: MakeRequest, data: CollectionProp<ScheduledActionProps>) => import("..").Collection<ScheduledAction, ScheduledActionProps>;
+export {};

package/dist/types/entities/scheduled-action.js

@@ -0,0 +1,147 @@
+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';
+
+/**
+ * Represents that state of the scheduled action
+ */
+var ScheduledActionStatus;
+(function (ScheduledActionStatus) {
+    /** action is pending execution */
+    ScheduledActionStatus["scheduled"] = "scheduled";
+    /** action has been started and pending completion */
+    ScheduledActionStatus["inProgress"] = "inProgress";
+    /** action was completed successfully (terminal state) */
+    ScheduledActionStatus["succeeded"] = "succeeded";
+    /** action failed to complete (terminal state) */
+    ScheduledActionStatus["failed"] = "failed";
+    /** action was canceled by a user (terminal state) */
+    ScheduledActionStatus["canceled"] = "canceled";
+})(ScheduledActionStatus || (ScheduledActionStatus = {}));
+function getInstanceMethods(makeRequest) {
+    const getParams = (self) => {
+        const scheduledAction = self.toPlainObject();
+        return {
+            spaceId: scheduledAction.sys.space.sys.id,
+            environmentId: scheduledAction.environment?.sys.id,
+            scheduledActionId: scheduledAction.sys.id,
+            version: scheduledAction.sys.version,
+        };
+    };
+    return {
+        /**
+         * Cancels the current Scheduled Action schedule.
+         *
+         * @example ```javascript
+         *  const contentful = require('contentful-management');
+         *
+         *  const client = contentful.createClient({
+         *    accessToken: '<content_management_api_key>'
+         *  })
+         *
+         *  client.getSpace('<space_id>')
+         *    .then((space) => {
+         *      return space.createScheduledAction({
+         *        entity: {
+         *          sys: {
+         *            type: 'Link',
+         *            linkType: 'Entry',
+         *            id: '<entry_id>'
+         *          }
+         *        },
+         *        environment: {
+         *          sys: {
+         *            type: 'Link',
+         *            linkType: 'Environment',
+         *            id: '<environment_id>'
+         *          }
+         *        },
+         *        action: 'publish',
+         *        scheduledFor: {
+         *          datetime: <ISO_date_string>,
+         *          timezone: 'Europe/Berlin'
+         *        }
+         *      })
+         *    .then((scheduledAction) => scheduledAction.delete())
+         *    .then((deletedScheduledAction) => console.log(deletedScheduledAction))
+         *    .catch(console.error);
+         * ```
+         */
+        async delete() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'ScheduledAction',
+                action: 'delete',
+                params,
+            }).then((data) => wrapScheduledAction(makeRequest, data));
+        },
+        /**
+         * Update the current scheduled action. Currently, only changes made to the `scheduledFor` property will be saved.
+         *
+         * @example ```javascript
+         *  const contentful = require('contentful-management');
+         *
+         *  const client = contentful.createClient({
+         *    accessToken: '<content_management_api_key>'
+         *  })
+         *
+         *  client.getSpace('<space_id>')
+         *    .then((space) => {
+         *      return space.createScheduledAction({
+         *        entity: {
+         *          sys: {
+         *            type: 'Link',
+         *            linkType: 'Entry',
+         *            id: '<entry_id>'
+         *          }
+         *        },
+         *        environment: {
+         *          sys: {
+         *            type: 'Link',
+         *            linkType: 'Environment',
+         *            id: '<environment_id>'
+         *          }
+         *        },
+         *        action: 'publish',
+         *        scheduledFor: {
+         *          datetime: <ISO_date_string>,
+         *          timezone: 'Europe/Berlin'
+         *        }
+         *      })
+         *    .then((scheduledAction) => {
+         *      scheduledAction.scheduledFor.timezone = 'Europe/Paris';
+         *      return scheduledAction.update();
+         *    })
+         *    .then((scheduledAction) => console.log(scheduledAction))
+         *    .catch(console.error);
+         * ```
+         */
+        async update() {
+            const params = getParams(this);
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const { sys, ...payload } = this.toPlainObject();
+            return makeRequest({
+                entityType: 'ScheduledAction',
+                action: 'update',
+                params,
+                payload,
+            }).then((data) => wrapScheduledAction(makeRequest, data));
+        },
+    };
+}
+/**
+ * @private
+ */
+function wrapScheduledAction(makeRequest, data) {
+    const scheduledAction = toPlainObject(copy(data));
+    const scheduledActionWithMethods = enhanceWithMethods(scheduledAction, getInstanceMethods(makeRequest));
+    return freezeSys(scheduledActionWithMethods);
+}
+/**
+ * @private
+ */
+const wrapScheduledActionCollection = wrapCollection(wrapScheduledAction);
+
+export { ScheduledActionStatus, getInstanceMethods as default, wrapScheduledAction, wrapScheduledActionCollection };
+//# sourceMappingURL=scheduled-action.js.map

package/dist/types/entities/scheduled-action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduled-action.js","sources":["../../../lib/entities/scheduled-action.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAgBA;;AAEG;IACS;AAAZ,CAAA,UAAY,qBAAqB,EAAA;;AAE/B,IAAA,qBAAA,CAAA,WAAA,CAAA,GAAA,WAAuB;;AAEvB,IAAA,qBAAA,CAAA,YAAA,CAAA,GAAA,YAAyB;;AAEzB,IAAA,qBAAA,CAAA,WAAA,CAAA,GAAA,WAAuB;;AAEvB,IAAA,qBAAA,CAAA,QAAA,CAAA,GAAA,QAAiB;;AAEjB,IAAA,qBAAA,CAAA,UAAA,CAAA,GAAA,UAAqB;AACvB,CAAC,EAXW,qBAAqB,KAArB,qBAAqB,GAAA,EAAA,CAAA,CAAA;AA+GnB,SAAU,kBAAkB,CAAC,WAAwB,EAAA;AACjE,IAAA,MAAM,SAAS,GAAG,CAAC,IAAqB,KAAI;AAC1C,QAAA,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,EAAE;QAC5C,OAAO;YACL,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;AACzC,YAAA,aAAa,EAAE,eAAe,CAAC,WAAW,EAAE,GAAG,CAAC,EAAY;AAC5D,YAAA,iBAAiB,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE;AACzC,YAAA,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,OAAO;SACrC;AACH,IAAA,CAAC;IAED,OAAO;AACL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCG;AACH,QAAA,MAAM,MAAM,GAAA;AACV,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,iBAAiB;AAC7B,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCG;AACH,QAAA,MAAM,MAAM,GAAA;AACV,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;;YAG9B,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE;AAEhD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,iBAAiB;AAC7B,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM;gBACN,OAAO;AACR,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC;KACF;AACH;AAEA;;AAEG;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,kBAAkB,CAAC,WAAW,CAAC,CAChC;AACD,IAAA,OAAO,SAAS,CAAC,0BAA0B,CAAC;AAC9C;AAEA;;AAEG;MACU,6BAA6B,GAAG,cAAc,CAAC,mBAAmB;;;;"}

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

@@ -0,0 +1,24 @@
+import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
+export type SnapshotProps<T> = {
+    sys: MetaSysProps & {
+        snapshotType: string;
+        snapshotEntityType: string;
+    };
+    snapshot: T;
+};
+export interface Snapshot<T> extends SnapshotProps<T>, DefaultElements<SnapshotProps<T>> {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw snapshot data
+ * @return Wrapped snapshot data
+ */
+export declare function wrapSnapshot<T>(_makeRequest: MakeRequest, data: SnapshotProps<T>): Snapshot<T>;
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw snapshot collection data
+ * @return Wrapped snapshot collection data
+ */
+export declare const wrapSnapshotCollection: <T>(makeRequest: MakeRequest, data: import("..").CollectionProp<SnapshotProps<T>>) => import("..").Collection<Snapshot<T>, SnapshotProps<T>>;

package/dist/types/entities/snapshot.js

@@ -0,0 +1,34 @@
+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 createSnapshotApi() {
+    return {
+    /* In case the snapshot object evolve later */
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw snapshot data
+ * @return Wrapped snapshot data
+ */
+function wrapSnapshot(_makeRequest, data) {
+    const snapshot = toPlainObject(copy(data));
+    const snapshotWithMethods = enhanceWithMethods(snapshot, createSnapshotApi());
+    return freezeSys(snapshotWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw snapshot collection data
+ * @return Wrapped snapshot collection data
+ */
+const wrapSnapshotCollection = wrapCollection(wrapSnapshot);
+
+export { wrapSnapshot, wrapSnapshotCollection };
+//# sourceMappingURL=snapshot.js.map

package/dist/types/entities/snapshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.js","sources":["../../../lib/entities/snapshot.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAgBA;;AAEG;AACH,SAAS,iBAAiB,GAAA;IACxB,OAAO;;KAEN;AACH;AACA;;;;;AAKG;AACG,SAAU,YAAY,CAAI,YAAyB,EAAE,IAAsB,EAAA;IAC/E,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,CAAC;AAC7E,IAAA,OAAO,SAAS,CAAC,mBAAmB,CAAC;AACvC;AAEA;;;;;AAKG;MACU,sBAAsB,GAAG,cAAc,CAAC,YAAY;;;;"}

package/dist/types/entities/space-member.d.ts

@@ -0,0 +1,31 @@
+import type { DefaultElements, MakeRequest, MetaLinkProps, MetaSysProps } from '../common-types';
+export type SpaceMemberProps = {
+    sys: MetaSysProps;
+    /**
+     * User is an admin
+     */
+    admin: boolean;
+    /**
+     * Array of Role Links
+     */
+    roles: {
+        sys: MetaLinkProps;
+    }[];
+};
+export interface SpaceMember extends SpaceMemberProps, DefaultElements<SpaceMemberProps> {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw space member data
+ * @return Wrapped space member data
+ */
+export declare function wrapSpaceMember(_makeRequest: MakeRequest, data: SpaceMemberProps): SpaceMemberProps & {
+    toPlainObject(): SpaceMemberProps;
+};
+/**
+ * @private
+ */
+export declare const wrapSpaceMemberCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<SpaceMemberProps>) => import("..").Collection<SpaceMemberProps & {
+    toPlainObject(): SpaceMemberProps;
+}, SpaceMemberProps>;

package/dist/types/entities/space-member.js

@@ -0,0 +1,21 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw space member data
+ * @return Wrapped space member data
+ */
+function wrapSpaceMember(_makeRequest, data) {
+    const spaceMember = toPlainObject(copy(data));
+    return freezeSys(spaceMember);
+}
+/**
+ * @private
+ */
+const wrapSpaceMemberCollection = wrapCollection(wrapSpaceMember);
+
+export { wrapSpaceMember, wrapSpaceMemberCollection };
+//# sourceMappingURL=space-member.js.map

package/dist/types/entities/space-member.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"space-member.js","sources":["../../../lib/entities/space-member.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAmBA;;;;;AAKG;AACG,SAAU,eAAe,CAAC,YAAyB,EAAE,IAAsB,EAAA;IAC/E,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7C,IAAA,OAAO,SAAS,CAAC,WAAW,CAAC;AAC/B;AAEA;;AAEG;MACU,yBAAyB,GAAG,cAAc,CAAC,eAAe;;;;"}

package/dist/types/entities/space-membership.d.ts

@@ -0,0 +1,64 @@
+import type { SysLink, MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
+export type SpaceMembershipProps = {
+    sys: MetaSysProps & {
+        space: SysLink;
+        user: SysLink;
+    };
+    user: SysLink;
+    admin: boolean;
+    roles: SysLink[];
+};
+export type CreateSpaceMembershipProps = Omit<SpaceMembershipProps, 'sys' | 'user'> & {
+    email: string;
+};
+export interface SpaceMembership extends SpaceMembershipProps, DefaultElements<SpaceMembershipProps> {
+    /**
+     * 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.getSpaceMembership('<spaceMembership_id>'))
+     * .then((spaceMembership) => spaceMembership.delete())
+     * .then(() => console.log(`spaceMembership deleted.`))
+     * .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.getSpace('<space_id>')
+     * .then((space) => space.getSpaceMembership('<spaceMembership_id>'))
+     * .then((spaceMembership) => {
+     *  spaceMembership.name = 'new space membership name'
+     * })
+     * .then((spaceMembership) => console.log(`spaceMembership ${spaceMembership.sys.id} updated.`))
+     * .catch(console.error)
+     * ```
+     */
+    update(): Promise<SpaceMembership>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw space membership data
+ * @return Wrapped space membership data
+ */
+export declare function wrapSpaceMembership(makeRequest: MakeRequest, data: SpaceMembershipProps): SpaceMembership;
+/**
+ * @private
+ */
+export declare const wrapSpaceMembershipCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<SpaceMembershipProps>) => import("..").Collection<SpaceMembership, SpaceMembershipProps>;

package/dist/types/entities/space-membership.js

@@ -0,0 +1,51 @@
+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 createSpaceMembershipApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space.sys.id,
+        spaceMembershipId: data.sys.id,
+    });
+    return {
+        update: function update() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'SpaceMembership',
+                action: 'update',
+                params: getParams(data),
+                payload: data,
+            }).then((data) => wrapSpaceMembership(makeRequest, data));
+        },
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'SpaceMembership',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw space membership data
+ * @return Wrapped space membership data
+ */
+function wrapSpaceMembership(makeRequest, data) {
+    const spaceMembership = toPlainObject(copy(data));
+    const spaceMembershipWithMethods = enhanceWithMethods(spaceMembership, createSpaceMembershipApi(makeRequest));
+    return freezeSys(spaceMembershipWithMethods);
+}
+/**
+ * @private
+ */
+const wrapSpaceMembershipCollection = wrapCollection(wrapSpaceMembership);
+
+export { wrapSpaceMembership, wrapSpaceMembershipCollection };
+//# sourceMappingURL=space-membership.js.map

package/dist/types/entities/space-membership.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"space-membership.js","sources":["../../../lib/entities/space-membership.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AA4DA;;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;AAC9B,QAAA,iBAAiB,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE;AAC/B,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,IAAI;AACd,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC;QACD,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/space.d.ts

@@ -0,0 +1,31 @@
+import type { BasicMetaSysProps, DefaultElements, MakeRequest } from '../common-types';
+import type { ContentfulSpaceAPI } from '../create-space-api';
+export type SpaceProps = {
+    sys: BasicMetaSysProps & {
+        organization: {
+            sys: {
+                id: string;
+            };
+        };
+        archivedAt?: string;
+    };
+    name: string;
+};
+export type Space = SpaceProps & DefaultElements<SpaceProps> & ContentfulSpaceAPI;
+/**
+ * This method creates the API for the given space with all the methods for
+ * reading and creating other entities. It also passes down a clone of the
+ * http client with a space id, so the base path for requests now has the
+ * space id already set.
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - API response for a Space
+ * @return {Space}
+ */
+export declare function wrapSpace(makeRequest: MakeRequest, data: SpaceProps): Space;
+/**
+ * This method wraps each space in a collection with the space API. See wrapSpace
+ * above for more details.
+ * @private
+ */
+export declare const wrapSpaceCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<SpaceProps>) => import("..").Collection<Space, SpaceProps>;

package/dist/types/entities/space.js

@@ -0,0 +1,31 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import createSpaceApi from '../create-space-api.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * This method creates the API for the given space with all the methods for
+ * reading and creating other entities. It also passes down a clone of the
+ * http client with a space id, so the base path for requests now has the
+ * space id already set.
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - API response for a Space
+ * @return {Space}
+ */
+function wrapSpace(makeRequest, data) {
+    const space = toPlainObject(copy(data));
+    const spaceApi = createSpaceApi(makeRequest);
+    const enhancedSpace = enhanceWithMethods(space, spaceApi);
+    return freezeSys(enhancedSpace);
+}
+/**
+ * This method wraps each space in a collection with the space API. See wrapSpace
+ * above for more details.
+ * @private
+ */
+const wrapSpaceCollection = wrapCollection(wrapSpace);
+
+export { wrapSpace, wrapSpaceCollection };
+//# sourceMappingURL=space.js.map

package/dist/types/entities/space.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"space.js","sources":["../../../lib/entities/space.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAeA;;;;;;;;;AASG;AACG,SAAU,SAAS,CAAC,WAAwB,EAAE,IAAgB,EAAA;IAClE,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvC,IAAA,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,CAAC;IAC5C,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC;AACzD,IAAA,OAAO,SAAS,CAAC,aAAa,CAAC;AACjC;AAEA;;;;AAIG;MACU,mBAAmB,GAAG,cAAc,CAAC,SAAS;;;;"}

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

@@ -0,0 +1,51 @@
+import type { DefaultElements, GetTagParams, MakeRequest, MetaSysProps, SysLink } from '../common-types';
+export type TagVisibility = 'private' | 'public';
+export type TagSysProps = Pick<MetaSysProps, 'id' | 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy'> & {
+    type: 'Tag';
+    visibility: TagVisibility;
+    space: SysLink;
+    environment: SysLink;
+};
+export type TagProps = {
+    sys: TagSysProps;
+    name: string;
+};
+export type CreateTagProps = Omit<TagProps, 'sys'> & {
+    sys: Pick<TagSysProps, 'visibility'>;
+};
+export type UpdateTagProps = Omit<TagProps, 'sys'> & {
+    sys: Pick<TagSysProps, 'version'>;
+};
+export type DeleteTagParams = GetTagParams & {
+    version: number;
+};
+export type TagCollectionProps = {
+    sys: {
+        type: 'Array';
+    };
+    items: TagProps[];
+    total: number;
+};
+export interface TagCollection {
+    items: Tag[];
+    total: number;
+}
+type TagApi = {
+    update(): Promise<Tag>;
+    delete(): Promise<void>;
+};
+export interface Tag extends TagProps, DefaultElements<TagProps>, TagApi {
+}
+/**
+ * @private
+ */
+export default function createTagApi(makeRequest: MakeRequest): TagApi;
+/**
+ * @private
+ */
+export declare function wrapTag(makeRequest: MakeRequest, data: TagProps): Tag;
+/**
+ * @private
+ */
+export declare const wrapTagCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<TagProps>) => import("..").Collection<Tag, TagProps>;
+export {};