@wordpress/fields 0.0.2

package/src/actions/pattern/export-pattern.tsx

@@ -0,0 +1,76 @@
+/**
+ * External dependencies
+ */
+import { paramCase as kebabCase } from 'change-case';
+import { downloadZip } from 'client-zip';
+
+/**
+ * WordPress dependencies
+ */
+import { downloadBlob } from '@wordpress/blob';
+import { __ } from '@wordpress/i18n';
+import { download } from '@wordpress/icons';
+import type { Action } from '@wordpress/dataviews';
+
+/**
+ * Internal dependencies
+ */
+import type { Pattern } from '../../types';
+import { getItemTitle } from '../utils';
+
+function getJsonFromItem( item: Pattern ) {
+	return JSON.stringify(
+		{
+			__file: item.type,
+			title: getItemTitle( item ),
+			content:
+				typeof item.content === 'string'
+					? item.content
+					: item.content?.raw,
+			syncStatus: item.wp_pattern_sync_status,
+		},
+		null,
+		2
+	);
+}
+
+const exportPattern: Action< Pattern > = {
+	id: 'export-pattern',
+	label: __( 'Export as JSON' ),
+	icon: download,
+	supportsBulk: true,
+	isEligible: ( item ) => item.type === 'wp_block',
+	callback: async ( items ) => {
+		if ( items.length === 1 ) {
+			return downloadBlob(
+				`${ kebabCase(
+					getItemTitle( items[ 0 ] ) || items[ 0 ].slug
+				) }.json`,
+				getJsonFromItem( items[ 0 ] ),
+				'application/json'
+			);
+		}
+		const nameCount: Record< string, number > = {};
+		const filesToZip = items.map( ( item ) => {
+			const name = kebabCase( getItemTitle( item ) || item.slug );
+			nameCount[ name ] = ( nameCount[ name ] || 0 ) + 1;
+			return {
+				name: `${
+					name +
+					( nameCount[ name ] > 1
+						? '-' + ( nameCount[ name ] - 1 )
+						: '' )
+				}.json`,
+				lastModified: new Date(),
+				input: getJsonFromItem( item ),
+			};
+		} );
+		return downloadBlob(
+			__( 'patterns-export' ) + '.zip',
+			await downloadZip( filesToZip ).blob(),
+			'application/zip'
+		);
+	},
+};
+
+export default exportPattern;

package/src/actions/pattern/index.ts

@@ -0,0 +1,3 @@
+export { default as duplicatePattern } from './duplicate-pattern';
+export { default as exportPattern } from './export-pattern';
+export { default as exportPatternNative } from './export-pattern.native';

package/src/actions/utils.ts

@@ -0,0 +1,66 @@
+/**
+ * WordPress dependencies
+ */
+import { decodeEntities } from '@wordpress/html-entities';
+
+/**
+ * Internal dependencies
+ */
+import type { Post, TemplatePart, Template } from '../types';
+
+export const TEMPLATE_POST_TYPE = 'wp_template';
+export const TEMPLATE_PART_POST_TYPE = 'wp_template_part';
+export const TEMPLATE_ORIGINS = {
+	custom: 'custom',
+	theme: 'theme',
+	plugin: 'plugin',
+};
+
+export function isTemplate( post: Post ): post is Template {
+	return post.type === TEMPLATE_POST_TYPE;
+}
+
+export function isTemplatePart( post: Post ): post is TemplatePart {
+	return post.type === TEMPLATE_PART_POST_TYPE;
+}
+
+export function isTemplateOrTemplatePart(
+	p: Post
+): p is Template | TemplatePart {
+	return p.type === TEMPLATE_POST_TYPE || p.type === TEMPLATE_PART_POST_TYPE;
+}
+
+export function getItemTitle( item: Post ) {
+	if ( typeof item.title === 'string' ) {
+		return decodeEntities( item.title );
+	}
+	if ( 'rendered' in item.title ) {
+		return decodeEntities( item.title.rendered );
+	}
+	if ( 'raw' in item.title ) {
+		return decodeEntities( item.title.raw );
+	}
+	return '';
+}
+
+/**
+ * Check if a template is removable.
+ *
+ * @param template The template entity to check.
+ * @return Whether the template is removable.
+ */
+export function isTemplateRemovable( template: Template | TemplatePart ) {
+	if ( ! template ) {
+		return false;
+	}
+	// In patterns list page we map the templates parts to a different object
+	// than the one returned from the endpoint. This is why we need to check for
+	// two props whether is custom or has a theme file.
+	return (
+		[ template.source, template.source ].includes(
+			TEMPLATE_ORIGINS.custom
+		) &&
+		! Boolean( template.type === 'wp_template' && template?.plugin ) &&
+		! template.has_theme_file
+	);
+}

package/src/fields/index.ts

@@ -0,0 +1,2 @@
+export { default as titleField } from './title';
+export { default as orderField } from './order';

package/src/fields/order/index.ts

@@ -0,0 +1,18 @@
+/**
+ * WordPress dependencies
+ */
+import type { Field } from '@wordpress/dataviews';
+import { __ } from '@wordpress/i18n';
+/**
+ * Internal dependencies
+ */
+import type { BasePost } from '../../types';
+
+const orderField: Field< BasePost > = {
+	type: 'integer',
+	id: 'menu_order',
+	label: __( 'Order' ),
+	description: __( 'Determines the order of pages.' ),
+};
+
+export default orderField;

package/src/fields/title/index.ts

@@ -0,0 +1,21 @@
+/**
+ * WordPress dependencies
+ */
+import type { Field } from '@wordpress/dataviews';
+import { __ } from '@wordpress/i18n';
+
+/**
+ * Internal dependencies
+ */
+import type { BasePost } from '../../types';
+import { getItemTitle } from '../../actions/utils';
+
+const titleField: Field< BasePost > = {
+	type: 'text',
+	id: 'title',
+	label: __( 'Title' ),
+	placeholder: __( 'No title' ),
+	getValue: ( { item } ) => getItemTitle( item ),
+};
+
+export default titleField;

package/src/index.native.ts

@@ -0,0 +1,2 @@
+export * from './actions/base-post/duplicate-post.native';
+export * from './actions/base-post/reorder-page.native';

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './fields';
+export * from './actions';

package/src/lock-unlock.ts

@@ -0,0 +1,9 @@
+/**
+ * WordPress dependencies
+ */
+import { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from '@wordpress/private-apis';
+export const { lock, unlock } =
+	__dangerousOptInToUnstableAPIsOnlyForCoreModules(
+		'I acknowledge private features are not for use in themes or plugins and doing so will break in the next version of WordPress.',
+		'@wordpress/fields'
+	);

package/src/types.ts

@@ -0,0 +1,85 @@
+type PostStatus =
+	| 'published'
+	| 'draft'
+	| 'pending'
+	| 'private'
+	| 'future'
+	| 'auto-draft'
+	| 'trash';
+
+export interface CommonPost {
+	status?: PostStatus;
+	title: string | { rendered: string } | { raw: string };
+	content: string | { raw: string; rendered: string };
+	type: string;
+	id: string | number;
+	blocks?: Object[];
+	_links?: Links;
+}
+
+interface Links {
+	'predecessor-version'?: { href: string; id: number }[];
+	'version-history'?: { href: string; count: number }[];
+	[ key: string ]: { href: string }[] | undefined;
+}
+
+export interface BasePost extends CommonPost {
+	comment_status?: 'open' | 'closed';
+	excerpt?: string | { raw: string; rendered: string };
+	meta?: Record< string, any >;
+	parent?: number;
+	password?: string;
+	template?: string;
+	format?: string;
+	featured_media?: number;
+	menu_order?: number;
+	ping_status?: 'open' | 'closed';
+	link?: string;
+}
+
+export interface Template extends CommonPost {
+	type: 'wp_template';
+	is_custom: boolean;
+	source: string;
+	origin: string;
+	plugin?: string;
+	has_theme_file: boolean;
+	id: string;
+}
+
+export interface TemplatePart extends CommonPost {
+	type: 'wp_template_part';
+	source: string;
+	origin: string;
+	has_theme_file: boolean;
+	id: string;
+	area: string;
+}
+
+export interface Pattern extends CommonPost {
+	slug: string;
+	title: { raw: string };
+	wp_pattern_sync_status: string;
+}
+
+export type Post = Template | TemplatePart | Pattern | BasePost;
+
+export type PostWithPermissions = Post & {
+	permissions: {
+		delete: boolean;
+		update: boolean;
+	};
+};
+
+export interface PostType {
+	slug: string;
+	viewable: boolean;
+	supports?: {
+		'page-attributes'?: boolean;
+		title?: boolean;
+		revisions?: boolean;
+	};
+}
+
+// Will be unnecessary after typescript 5.0 upgrade.
+export type CoreDataError = { message?: string; code?: string };

package/src/wordpress-editor.d.ts

@@ -0,0 +1 @@
+declare module '@wordpress/editor';

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+	"$schema": "https://json.schemastore.org/tsconfig.json",
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"rootDir": "src",
+		"declarationDir": "build-types",
+		"checkJs": false
+	},
+	"references": [
+		{ "path": "../components" },
+		{ "path": "../compose" },
+		{ "path": "../data" },
+		{ "path": "../element" },
+		{ "path": "../i18n" },
+		{ "path": "../icons" },
+		{ "path": "../primitives" },
+		{ "path": "../private-apis" },
+		{ "path": "../warning" },
+		{ "path": "../url" },
+		{ "path": "../notices" },
+		{ "path": "../dataviews" },
+		{ "path": "../blob" },
+		{ "path": "../core-data" },
+		{ "path": "../hooks" },
+		{ "path": "../html-entities" }
+	],
+	"include": [ "src" ],
+	"exclude": [ "@wordpress/editor" ]
+}