contentful-management
Version:
Client for Contentful's Content Management API
143 lines (142 loc) • 5.9 kB
TypeScript
import type { BaseCollection, CursorPaginatedCollection, CursorPaginatedCollectionProp, DefaultElements, ISO8601Timestamp, Link, MakeRequest, MakeRequestPayload } from '../common-types';
import { ScheduledActionReferenceFilters } from '../common-types';
import type { AsyncActionProcessingOptions } from '../methods/action';
import type { ReleaseAction } from './release-action';
/** Entity types supported by the Release API */
type Entity = 'Entry' | 'Asset';
type ReleaseStatus = 'active' | 'archived';
export interface ReleaseQueryOptions {
/** Find releases filtered by the Entity type (Asset, Entry) */
'entities.sys.linkType'?: string;
/** Find releases containing the specified, comma-separated entities. Requires `entities.sys.linkType` */
'entities.sys.id[in]'?: string;
/** Comma-separated list of ids to exclude from the query */
'sys.id[nin]'?: string;
/** Comma-separated list of Ids to find (inclusion) */
'sys.id[in]'?: string;
/** Comma-separated list of user Ids to find releases by creator */
'sys.createdBy.sys.id[in]'?: string;
/** Comma-separated filter (inclusion) by Release status (active, archived) */
'sys.status[in]'?: ReleaseStatus;
/** Determines the Release API version to use. 'Release.v1' refers to Launch, 'Release.v2' refers to Releases. */
'sys.schemaVersion'?: 'Release.v1' | 'Release.v2';
/** Comma-separated filter (exclusion) by Release status (active, archived) */
'sys.status[nin]'?: ReleaseStatus;
/** Find releases using full text phrase and term matching */
'title[match]'?: string;
/** Filter by empty Releases (exists=false) or Releases with items (exists=true) */
'entities[exists]'?: boolean;
/** If present, will return results based on a pagination cursor */
pageNext?: string;
/**
* Limit how many records are returned in the result
* @default 100
* */
limit?: number;
/**
* Order releases
* Supported values include
* - `title`, `-title`
* - `sys.updatedAt`, `-sys.updatedAt`
* - `sys.createdAt`, `-sys.createdAt`
* @default -sys.updatedAt
* */
order?: string;
}
export type ReleaseSysProps = {
id: string;
type: 'Release';
version: number;
status: ReleaseStatus;
space: Link<'Space'>;
environment: Link<'Environment'>;
archivedBy?: Link<'User'>;
archivedAt?: ISO8601Timestamp;
createdBy: Link<'User'> | Link<'AppDefinition'>;
updatedBy: Link<'User'> | Link<'AppDefinition'>;
createdAt: ISO8601Timestamp;
updatedAt: ISO8601Timestamp;
lastAction?: Link<'ReleaseAction'>;
schemaVersion?: 'Release.v2';
};
export type ReleaseReferenceFilters = ScheduledActionReferenceFilters;
export declare const ReleaseReferenceFilters: typeof ScheduledActionReferenceFilters;
export type ReleaseMetadata = {
withReferences: {
entity: Link<'Entry'>;
filter: Record<ReleaseReferenceFilters, string[]>;
}[];
};
/** The object returned by the Releases API */
export interface ReleaseProps {
title: string;
sys: ReleaseSysProps;
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
}
export interface ReleasePayload extends MakeRequestPayload {
sys?: {
type: 'Release';
schemaVersion?: 'Release.v1' | undefined;
};
title: string;
entities: BaseCollection<Link<Entity>>;
}
export interface ReleasePayloadV2 extends MakeRequestPayload {
sys?: {
type: 'Release';
schemaVersion: 'Release.v2';
};
title: string;
entities: BaseCollection<{
entity: Link<Entity>;
} & ReleaseValidatePayload>;
}
export interface ReleaseValidatePayload {
action?: 'publish' | 'unpublish';
}
export interface ReleaseValidateOptions {
payload?: ReleaseValidatePayload;
processingOptions?: AsyncActionProcessingOptions;
}
export interface ReleaseApiMethods {
/**
* Archives a release and locks any actions such as adding new entities or publishing/unpublishing.
* This operation increases the sys.version property
* @throws {BadRequest} if the release is already archived
* */
archive(): Promise<Release>;
/**
* Unarchives an `archived` release and unlocks operations on the Release. This operation increases the sys.version property
* @throws {BadRequest} if the release is not archived
* */
unarchive(): Promise<Release>;
/** Updates a Release and returns the updated Release object */
update(payload: ReleasePayload): Promise<Release>;
/** Deletes a Release and all ReleaseActions linked to it (non-reversible) */
delete(): Promise<void>;
/** Publishes a Release and waits until the asynchronous action is completed */
publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<'publish'>>;
/** Unpublishes a Release and waits until the asynchronous action is completed */
unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<'unpublish'>>;
/** Validates a Release and waits until the asynchronous action is completed */
validate({ payload, options, }?: {
payload?: ReleaseValidatePayload;
options?: AsyncActionProcessingOptions;
}): Promise<ReleaseAction<'validate'>>;
}
export interface Release extends ReleaseProps, ReleaseApiMethods, DefaultElements<ReleaseProps> {
}
/**
* Return a Release object enhanced with its own API helper functions.
* @private
* @param makeRequest - function to make requests via an adapter
* @param data - Raw Release data
* @return Wrapped Release data
*/
export declare function wrapRelease(makeRequest: MakeRequest, data: ReleaseProps): Release;
/**
* @private
*/
export declare const wrapReleaseCollection: (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<ReleaseProps>) => CursorPaginatedCollection<Release, ReleaseProps>;
export {};