refactor!: remove BlockStyle and isBlockStyle

theisel · Sep 30, 2022 · cfaaf38 · cfaaf38
1 parent 6ef982b
commit cfaaf38
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 44 deletions.
diff --git a/.changeset/six-walls-sneeze.md b/.changeset/six-walls-sneeze.md
@@ -0,0 +1,9 @@
+---
+"astro-portabletext": minor
+---
+
+**BREAKING**
+
+- Removed deprecated `BlockStyle` type; use `Block` type instead
+- Removed deprecated `isBlockStyle`; a utility _type guard_ function which is tied to `BlockStyle`
+and has no purpose
diff --git a/astro-portabletext/src/types.ts b/astro-portabletext/src/types.ts
@@ -66,11 +66,11 @@ export interface PortableTextComponents {
   /**
    * How blocks should be rendered
    */
-  block: ComponentOrRecord<BlockStyle> | ComponentOrRecord<Block>;
+  block: ComponentOrRecord<Block>;
   /**
    * Used when a `block` handler isn't found
    */
-  unknownBlock: Component<BlockStyle> | Component<Block>;
+  unknownBlock: Component<Block>;
   /**
    * How lists should be rendered
    */
@@ -144,17 +144,6 @@ export interface Block extends PortableTextBlock {
   style: "normal" | PortableTextBlockStyle;
 }
 
-/**
- * @deprecated Use `Block` instead
- *
- * @example
- * import type { BlockStyle, Props } from "astro-portabletext/types";
- * const props = Astro.props as Props<BlockStyle>;
- */
-export interface BlockStyle extends Block {
-  style: "normal" | PortableTextBlockStyle;
-}
-
 /**
  * Alias to `ToolkitPortableTextList`
  *

diff --git a/astro-portabletext/src/utils.ts b/astro-portabletext/src/utils.ts
@@ -1,12 +1,2 @@
-import type { TypedObject, BlockStyle } from "./types";
-
 export { toPlainText } from "@portabletext/toolkit";
 export { mergeComponents } from "./internal";
-
-/**
- * @deprecated Has no purpose anymore
- *
- * Checks if (node) is of {@link BlockStyle}
- */
-export const isBlockStyle = (node: TypedObject): node is BlockStyle =>
-  typeof (node as BlockStyle).style === "string";
diff --git a/astro-portabletext/test/lib/utils.test.ts b/astro-portabletext/test/lib/utils.test.ts
@@ -1,26 +1,6 @@
 import { suite } from "uvu";
 import * as assert from "uvu/assert";
-import { isBlockStyle, mergeComponents } from "../../src/utils";
-
-// ----------------------------------------------------------------------------
-// Test `isBlockStyle`
-// ----------------------------------------------------------------------------
-
-const testIsBlockStyle = suite("isBlockStyle");
-
-testIsBlockStyle("returns true for block style", () => {
-  const node = { _type: "block", style: "normal" };
-
-  assert.ok(isBlockStyle(node));
-});
-
-testIsBlockStyle("returns false for non-block style", () => {
-  const node = { _type: "block" };
-
-  assert.not.ok(isBlockStyle(node));
-});
-
-testIsBlockStyle.run();
+import { mergeComponents } from "../../src/utils";
 
 // ----------------------------------------------------------------------------
 // Test `mergeComponents`