@webbio/strapi-plugin-page-builder 0.8.5-platform → 0.9.1-platform

package/admin/src/components/StrapiCore/content-manager/shared/contracts/collection-types.ts

@@ -0,0 +1,300 @@
+import { errors } from '@strapi/utils';
+import { Schema, Common, EntityService } from '@strapi/types';
+
+// Admin entity response follows the same format as the entity service
+type Entity = EntityService.Result<Common.UID.Schema>;
+type PaginatedEntities = EntityService.PaginatedResult<Common.UID.Schema>;
+
+type PaginationQuery = EntityService.Params.Pagination.PageNotation;
+type SortQuery = EntityService.Params.Sort.StringNotation<Common.UID.Schema> & string;
+
+/**
+ * GET /collection-types/:model
+ */
+export declare namespace Find {
+	export interface Request {
+		body: {};
+		query: {
+			page: PaginationQuery['page'];
+			pageSize: PaginationQuery['pageSize'];
+			sort: SortQuery;
+		};
+	}
+
+	export interface Params {
+		model: string;
+	}
+
+	export interface Response {
+		results: PaginatedEntities['results'];
+		pagination: PaginatedEntities['pagination'];
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * GET /collection-types/:model/:id
+ */
+export declare namespace FindOne {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		id: number;
+	}
+
+	export interface Response {
+		data: Entity;
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * POST /collection-types/:model
+ */
+export declare namespace Create {
+	export interface Request {
+		body: Schema.Attributes;
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+	}
+
+	export interface Response {
+		data: Entity;
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * POST /collection-types/:model/auto-clone/:sourceId
+ */
+export declare namespace AutoClone {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		sourceId: Entity['id'];
+	}
+
+	export type Response =
+		| Entity
+		| {
+				error?: errors.ApplicationError;
+		  };
+}
+
+/**
+ * POST /collection-types/:model/clone/:sourceId
+ */
+export declare namespace Clone {
+	export interface Request {
+		body: Schema.Attributes;
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		sourceId: number;
+	}
+
+	export interface Response {
+		data: Entity;
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * POST /collection-types/:model/:id
+ */
+export declare namespace Update {
+	export interface Request {
+		body: Entity;
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		id: number;
+	}
+
+	export interface Response {
+		data: Entity;
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * DELETE /collection-types/:model/:id
+ */
+export declare namespace Delete {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		id: Entity['id'];
+	}
+
+	export interface Response {
+		data: Entity;
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * POST /collection-types/:model/:id/actions/publish
+ */
+export declare namespace Publish {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		id: number;
+	}
+
+	export interface Response {
+		data: Entity;
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * POST /collection-types/:model/:id/actions/unpublish
+ */
+export declare namespace Unpublish {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		id: Entity['id'];
+	}
+
+	export interface Response {
+		data: Entity;
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * POST /collection-types/:model/actions/bulkDelete
+ */
+export declare namespace BulkDelete {
+	export interface Request {
+		body: {
+			ids: Entity['id'][];
+		};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+	}
+
+	export interface Response {
+		data: {
+			count: number;
+		};
+		error?: errors.ApplicationError | errors.YupValidationError;
+	}
+}
+
+/**
+ * POST /collection-types/:model/actions/bulkPublish
+ */
+export declare namespace BulkPublish {
+	export interface Request {
+		body: {
+			ids: Entity['id'][];
+		};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+	}
+
+	export interface Response {
+		count: number;
+		error?: errors.ApplicationError | errors.YupValidationError;
+	}
+}
+
+/**
+ * POST /collection-types/:model/actions/bulkUnpublish
+ */
+export declare namespace BulkUnpublish {
+	export interface Request {
+		body: {
+			ids: Entity['id'][];
+		};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+	}
+
+	export interface Response {
+		data: {
+			count: number;
+		};
+		error?: errors.ApplicationError | errors.YupValidationError;
+	}
+}
+
+/**
+ * GET /collection-types/:model/:id/actions/countDraftRelations
+ */
+export declare namespace CountDraftRelations {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+	}
+
+	export interface Response {
+		data: number;
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * GET /collection-types/:model/actions/countManyEntriesDraftRelations
+ */
+export declare namespace CountManyEntriesDraftRelations {
+	export interface Request {
+		body: {
+			ids: number[];
+		};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+	}
+
+	export interface Response {
+		data: number;
+		error?: errors.ApplicationError;
+	}
+}

package/admin/src/components/StrapiCore/content-manager/shared/contracts/components.ts

@@ -0,0 +1,72 @@
+import { Schema } from '@strapi/types';
+import { errors } from '@strapi/utils';
+import { Configuration, Settings, Metadatas, Layouts } from './content-types';
+
+export interface Component extends Schema.Component {
+	isDisplayed: boolean;
+	info: Schema.Info;
+	apiID: string;
+}
+
+export interface ComponentConfiguration extends Configuration {
+	category: string;
+	isComponent: boolean;
+}
+
+/**
+ * GET /components
+ */
+export declare namespace FindComponents {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+	export interface Response {
+		data: Component[];
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * GET /components/:uid/configuration
+ */
+export declare namespace FindComponentConfiguration {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Params {
+		uid: string;
+	}
+	export interface Response {
+		data: {
+			component: ComponentConfiguration;
+			components: Record<string, ComponentConfiguration>;
+		};
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * PUT /components/:uid/configuration
+ */
+export declare namespace UpdateComponentConfiguration {
+	export interface Request {
+		body: {
+			layouts: Layouts;
+			metadatas: Metadatas;
+			settings: Settings;
+		};
+		query: {};
+	}
+
+	export interface Params {
+		uid: string;
+	}
+
+	export interface Response {
+		data: ComponentConfiguration;
+		error?: errors.ApplicationError | errors.YupValidationError;
+	}
+}

package/admin/src/components/StrapiCore/content-manager/shared/contracts/content-types.ts

@@ -0,0 +1,116 @@
+import { Schema } from '@strapi/types';
+import { errors } from '@strapi/utils';
+import { ComponentConfiguration } from './components';
+
+export type Settings = {
+	bulkable: boolean;
+	filterable: boolean;
+	searchable: boolean;
+	pageSize: number;
+	mainField: string;
+	defaultSortBy: string;
+	defaultSortOrder: string;
+};
+
+export type Metadatas = {
+	[key: string]: {
+		edit: {
+			label?: string;
+			description?: string;
+			placeholder?: string;
+			visible?: boolean;
+			editable?: boolean;
+		};
+		list: {
+			label?: string;
+			searchable?: boolean;
+			sortable?: boolean;
+		};
+	};
+};
+
+export type Layouts = {
+	list: string[];
+	edit: { name: string; size: number }[][];
+};
+
+export type Configuration = {
+	uid?: string;
+	settings: Settings;
+	metadatas: Metadatas;
+	layouts: Layouts;
+};
+
+export interface ContentType extends Schema.ContentType {
+	isDisplayed: boolean;
+	apiID: string;
+}
+
+/**
+ * GET /content-types
+ */
+export declare namespace FindContentTypes {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+	export interface Response {
+		data: ContentType[];
+		error?: errors.ApplicationError | errors.YupValidationError;
+	}
+}
+
+/**
+ * GET /content-types-settings
+ */
+export declare namespace FindContentTypesSettings {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+	export interface Response {
+		data: Array<{
+			uid: string;
+			settings: Settings;
+		}>;
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * GET /content-types/:uid/configuration
+ */
+export declare namespace FindContentTypeConfiguration {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+	export interface Response {
+		data: {
+			contentType: Configuration;
+			components: Record<string, ComponentConfiguration>;
+		};
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * PUT /content-types/:uid/configuration
+ */
+export declare namespace UpdateContentTypeConfiguration {
+	export interface Request {
+		body: {
+			layouts: Layouts;
+			metadatas: Metadatas;
+			settings: Settings;
+		};
+		query: {};
+	}
+	export interface Response {
+		data: {
+			contentType: Configuration;
+			components: Record<string, ComponentConfiguration>;
+		};
+		error?: errors.ApplicationError | errors.YupValidationError;
+	}
+}

package/admin/src/components/StrapiCore/content-manager/shared/contracts/index.ts

@@ -0,0 +1,8 @@
+export * as CollectionTypes from './collection-types';
+export * as Components from './components';
+export * as ContentTypes from './content-types';
+export * as Init from './init';
+export * as Relations from './relations';
+export * as SingleTypes from './single-types';
+export * as UID from './uid';
+export * as ReviewWorkflows from './review-workflows';

package/admin/src/components/StrapiCore/content-manager/shared/contracts/init.ts

@@ -0,0 +1,22 @@
+import { errors } from '@strapi/utils';
+import { Component } from './components';
+import { ContentType } from './content-types';
+
+/**
+ * GET /init
+ */
+export declare namespace GetInitData {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Response {
+		data: {
+			fieldSizes: Record<string, { default: number; isResizeable: boolean }>;
+			components: Component[];
+			contentTypes: ContentType[];
+		};
+		error?: errors.ApplicationError;
+	}
+}

package/admin/src/components/StrapiCore/content-manager/shared/contracts/relations.ts

@@ -0,0 +1,80 @@
+import { Entity, EntityService } from '@strapi/types';
+import { errors } from '@strapi/utils';
+
+type PaginationQuery = EntityService.Params.Pagination.PageNotation;
+
+export interface RelationResult {
+	id: Entity.ID;
+	publishedAt: string | null;
+}
+
+/**
+ * GET /relations/:model/:targetField
+ */
+export declare namespace FindAvailable {
+	export interface Request {
+		body: {};
+		query: {
+			pageSize: PaginationQuery['pageSize'];
+			page: PaginationQuery['page'];
+		};
+	}
+
+	export interface Params {
+		model: string;
+		targetField: string;
+	}
+
+	export type Response =
+		| {
+				results: RelationResult[];
+				pagination: {
+					page: NonNullable<PaginationQuery['page']>;
+					pageSize: NonNullable<PaginationQuery['pageSize']>;
+					pageCount: number;
+					total: number;
+				};
+				error?: never;
+		  }
+		| {
+				results?: never;
+				pagination?: never;
+				error?: errors.ApplicationError | errors.YupValidationError;
+		  };
+}
+
+/**
+ * GET /relations/:model/:id/:targetField
+ */
+export declare namespace FindExisting {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		targetField: string;
+		id: number;
+	}
+
+	export type Response =
+		| {
+				results: RelationResult[];
+				pagination: {
+					page: NonNullable<PaginationQuery['page']>;
+					pageSize: NonNullable<PaginationQuery['pageSize']>;
+					pageCount: number;
+					total: number;
+				};
+				error?: never;
+		  }
+		| {
+				data: RelationResult;
+				error?: never;
+		  }
+		| {
+				data?: never;
+				error: errors.ApplicationError | errors.YupValidationError;
+		  };
+}

package/admin/src/components/StrapiCore/content-manager/shared/contracts/review-workflows.ts

@@ -0,0 +1,88 @@
+import type { Common, EntityService } from '@strapi/types';
+import type { errors } from '@strapi/utils';
+
+type Entity = EntityService.Result<Common.UID.Schema>;
+
+/**
+ * /content-manager/<collection-type | single-type>/:model/:id/assignee
+ */
+namespace UpdateAssignee {
+	export interface Request {
+		body: {
+			data: {
+				id: Entity['id'] | null;
+			};
+		};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		id: Entity['id'];
+	}
+
+	export interface Response {
+		data: Entity;
+		error?: errors.ApplicationError;
+	}
+}
+
+interface StagePermission extends Omit<Entity, 'createdAt' | 'updatedAt'> {
+	action: string;
+	actionParameters: object;
+	subject?: string | null;
+	role: number;
+}
+
+interface Stage extends Entity {
+	color: string;
+	name: string;
+	permissions?: StagePermission[];
+}
+
+/**
+ * GET /content-manager/<collection-type | single-type>/:model/:id/stages
+ */
+namespace GetStages {
+	export interface Request {
+		body: {};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		id: Entity['id'];
+	}
+
+	export interface Response {
+		data: Stage[];
+		meta?: { workflowCount: number };
+		error?: errors.ApplicationError;
+	}
+}
+
+/**
+ * PUT /content-manager/<collection-type | single-type>/:model/:id/stage
+ */
+namespace UpdateStage {
+	export interface Request {
+		body: {
+			data: {
+				id: Entity['id'];
+			};
+		};
+		query: {};
+	}
+
+	export interface Params {
+		model: string;
+		id: Entity['id'];
+	}
+
+	export interface Response {
+		data: Entity;
+		error?: errors.ApplicationError;
+	}
+}
+
+export type { UpdateAssignee, UpdateStage, GetStages, Stage, StagePermission };