@wp-typia/block-types 0.2.1 → 0.2.3

package/README.md

@@ -18,12 +18,14 @@ Shared WordPress block semantic types derived from Gutenberg source and unoffici
 - `@wp-typia/block-types/block-editor/style-attributes`
 - `@wp-typia/block-types/block-editor/typography`
 - `@wp-typia/block-types/blocks`
+- `@wp-typia/block-types/blocks/registration`
 - `@wp-typia/block-types/blocks/supports`
 
 ## Current policy
 
 - alignment types reuse `@types/wordpress__block-editor` where a narrow union already exists
 - layout, spacing, typography, and supports types are curated from Gutenberg source when no stable unofficial narrow export exists
+- registration-facing block types are exposed through a local facade that currently adapts the upstream `@wordpress/blocks` declarations behind a stable `@wp-typia/block-types/blocks/registration` boundary
 - every exported tuple has a matching exported type alias so templates can share both values and semantics
 - this package is publish-ready, but scaffolded projects will switch to semver usage in the same round
 
@@ -36,9 +38,39 @@ Shared WordPress block semantic types derived from Gutenberg source and unoffici
 - support-generated block style attribute helpers
 - typography enums used by core block supports
 - structural block support types for `block.json`
+- registration-facing block types for `registerBlockType(...)`,
+  `BlockEditProps`, `BlockSaveProps`, `BlockVariation`, deprecations, and
+  migration-facing `BlockInstance`
 - additive stable Core coverage for drop caps, spacing sizes, layout gaps,
   duotone, per-side border widths, and `js` / `locking`
 
+## Registration facade
+
+Generated scaffolds and reference apps should prefer the local registration
+facade over direct type imports from `@wordpress/blocks`:
+
+```ts
+import type {
+  BlockConfiguration,
+  BlockEditProps,
+  BlockInstance,
+  BlockVariation,
+  RegisterBlockTypeResult,
+} from '@wp-typia/block-types/blocks/registration';
+```
+
+The facade is locally owned but targets the current generated-project minimum
+WordPress blocks baseline:
+
+- `@wordpress/blocks@^15.2.0`
+- `@types/wordpress__blocks@^12.5.18`
+
+The package manifest declares the same pair as peer dependencies so downstream
+TypeScript installs surface the requirement explicitly.
+
+Compatibility should track that floor unless the generated project dependency
+matrix changes in the same release.
+
 ## WordPress style support helpers
 
 The package now exposes two complementary surfaces:

package/dist/blocks/index.d.ts

@@ -1 +1,2 @@
-export * from "./supports";
+export * from './registration';
+export * from './supports';

package/dist/blocks/index.js

@@ -1 +1,2 @@
-export * from "./supports";
+export * from './registration';
+export * from './supports';

package/dist/blocks/registration.d.ts

@@ -0,0 +1,31 @@
+import type { Block as WordPressRegisteredBlockType, BlockAttribute as WordPressBlockAttribute, BlockConfiguration as WordPressBlockConfiguration, BlockDeprecation as WordPressBlockDeprecation, BlockEditProps as WordPressBlockEditProps, BlockInstance as WordPressBlockInstance, BlockSaveProps as WordPressBlockSaveProps, BlockVariation as WordPressBlockVariation, BlockVariationScope as WordPressBlockVariationScope, InnerBlockTemplate as WordPressInnerBlockTemplate } from '@wordpress/blocks';
+/**
+ * Local compatibility facade for the Gutenberg block registration surface.
+ *
+ * The public contract is owned by `@wp-typia/block-types`, while the current
+ * v1 implementation intentionally adapts the upstream `@wordpress/blocks`
+ * declarations behind this stable import path.
+ */
+export type BlockAttributes = Record<string, any>;
+export type BlockAttribute<TValue = unknown> = WordPressBlockAttribute<TValue>;
+export type BlockSaveProps<TAttributes extends BlockAttributes = BlockAttributes> = WordPressBlockSaveProps<TAttributes>;
+export type BlockEditProps<TAttributes extends BlockAttributes = BlockAttributes> = WordPressBlockEditProps<TAttributes>;
+export type BlockConfiguration<TAttributes extends BlockAttributes = BlockAttributes> = WordPressBlockConfiguration<TAttributes>;
+export type BlockDeprecation<TNewAttributes extends BlockAttributes = BlockAttributes, TOldAttributes extends BlockAttributes = BlockAttributes> = WordPressBlockDeprecation<TNewAttributes, TOldAttributes>;
+export type BlockDeprecationList<TNewAttributes extends BlockAttributes = BlockAttributes, TOldAttributes extends BlockAttributes = BlockAttributes> = ReadonlyArray<BlockDeprecation<TNewAttributes, TOldAttributes>>;
+export type BlockInstance<TAttributes extends BlockAttributes = BlockAttributes> = WordPressBlockInstance<TAttributes>;
+export type BlockInnerTemplate = WordPressInnerBlockTemplate;
+export type BlockTemplate = BlockInnerTemplate[];
+export type BlockVariationScope = WordPressBlockVariationScope;
+export declare const BLOCK_VARIATION_SCOPES: readonly ["block", "inserter", "transform"];
+export type BlockVariation<TAttributes extends BlockAttributes = BlockAttributes> = WordPressBlockVariation<TAttributes>;
+export type RegisteredBlockType<TAttributes extends BlockAttributes = BlockAttributes> = WordPressRegisteredBlockType<TAttributes>;
+export type RegisterBlockTypeResult<TAttributes extends BlockAttributes = BlockAttributes> = RegisteredBlockType<TAttributes> | undefined;
+/**
+ * Runtime shim for scaffolded registrations.
+ *
+ * Generated projects keep strong typing around scaffold metadata while
+ * centralizing the compatibility cast required by the currently published
+ * `@wordpress/blocks` registration surface.
+ */
+export declare function registerScaffoldBlockType<TAttributes extends BlockAttributes = BlockAttributes, TSettings extends object = object>(blockName: string, settings: TSettings): RegisterBlockTypeResult<TAttributes>;

package/dist/blocks/registration.js

@@ -0,0 +1,9 @@
+import { registerBlockType } from '@wordpress/blocks';
+export const BLOCK_VARIATION_SCOPES = [
+    'block',
+    'inserter',
+    'transform',
+];
+export function registerScaffoldBlockType(blockName, settings) {
+    return registerBlockType(blockName, settings);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wp-typia/block-types",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Shared WordPress block semantic types derived from Gutenberg and unofficial declarations",
   "type": "module",
   "main": "dist/index.js",
@@ -56,6 +56,11 @@
       "import": "./dist/blocks/index.js",
       "default": "./dist/blocks/index.js"
     },
+    "./blocks/registration": {
+      "types": "./dist/blocks/registration.d.ts",
+      "import": "./dist/blocks/registration.js",
+      "default": "./dist/blocks/registration.js"
+    },
     "./blocks/supports": {
       "types": "./dist/blocks/supports.d.ts",
       "import": "./dist/blocks/supports.js",
@@ -92,9 +97,14 @@
     "npm": ">=10.0.0",
     "bun": ">=1.3.11"
   },
+  "peerDependencies": {
+    "@types/wordpress__blocks": "^12.5.18",
+    "@wordpress/blocks": "^15.2.0"
+  },
   "devDependencies": {
     "@types/react": "^18.3.12",
     "@types/wordpress__block-editor": "^11.5.17",
+    "@types/wordpress__blocks": "^12.5.18",
     "typescript": "^5.9.2"
   }
 }