@portabletext/html 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+import { n as TypedObject, t as DeserializerRule } from "./_chunks-dts/types.js";
+import * as _portabletext_schema3 from "@portabletext/schema";
+import { PortableTextObject, Schema, SchemaDefinition } from "@portabletext/schema";
+/**
+ * Matcher function for mapping HTML objects to Portable Text block or inline objects.
+ *
+ * @public
+ */
+type ObjectMatcher<TValue extends Record<string, unknown> = Record<string, never>> = ({
+  context,
+  value,
+  isInline
+}: {
+  context: {
+    schema: Schema;
+    keyGenerator: () => string;
+  };
+  value: TValue;
+  isInline: boolean;
+}) => PortableTextObject | undefined;
+/**
+ * @public
+ */
+declare function buildObjectMatcher<TDefinition extends {
+  name: string;
+}>(definition: TDefinition): ObjectMatcher<ExtractValue<TDefinition>>;
+/**
+ * @public
+ */
+type ExtractValue<TDefinition extends NonNullable<SchemaDefinition['blockObjects']>[0]> = TDefinition extends {
+  fields: ReadonlyArray<{
+    name: infer TNames;
+  }>;
+} ? Record<TNames & string, unknown> : Record<string, never>;
+/**
+ * Options for converting HTML to Portable Text
+ *
+ * @public
+ */
+type HtmlToPortableTextOptions = {
+  schema?: Schema;
+  keyGenerator?: () => string;
+  parseHtml?: (html: string) => Document;
+  rules?: DeserializerRule[];
+  whitespaceMode?: 'preserve' | 'remove' | 'normalize';
+  types?: {
+    image?: ObjectMatcher<{
+      src?: string;
+      alt?: string;
+    }>;
+  };
+};
+/**
+ * Convert HTML to Portable Text
+ *
+ * @param html - The HTML string to convert
+ * @param options - Options for the conversion
+ * @returns Array of Portable Text blocks
+ * @public
+ */
+declare function htmlToPortableText(html: string, options?: HtmlToPortableTextOptions): (Omit<TypedObject | _portabletext_schema3.PortableTextTextBlock<TypedObject | _portabletext_schema3.PortableTextSpan>, "_key"> & {
+  _key: string;
+})[];
+/**
+ * The default schema for converting HTML to Portable Text.
+ *
+ * @public
+ */
+declare const defaultSchema: _portabletext_schema3.Schema;
+export { type DeserializerRule, type HtmlToPortableTextOptions, type ObjectMatcher, buildObjectMatcher, defaultSchema, htmlToPortableText };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/matchers.ts","../src/html-to-portable-text.ts","../src/default-schema.ts"],"sourcesContent":[],"mappings":";;;;;;;;KAuJY,6BACK,0BAA0B;;;;;;YAMvB;;;SACX;;MAEH;;;;iBAKU;;eACF,cACX,cAAc,aAAa;;;;KAqClB,iCACU,YAAY,wCAC9B;UAA6B;;;IAC7B,OAAO,4BACP;;AA1DJ;;;;AAIE,KC9IU,yBAAA,GD8IV;EACA,MAAA,CAAA,EC9IS,MD8IT;EAEkB,YAAA,CAAA,EAAA,GAAA,GAAA,MAAA;EACX,SAAA,CAAA,EAAA,CAAA,IAAA,EAAA,MAAA,EAAA,GC/IuB,QD+IvB;EAEH,KAAA,CAAA,EChJI,gBDgJJ,EAAA;EAAkB,cAAA,CAAA,EAAA,UAAA,GAAA,QAAA,GAAA,WAAA;EAKR,KAAA,CAAA,EAAA;IACF,KAAA,CAAA,ECnJF,aDmJE,CAAA;MACgB,GAAA,CAAA,EAAA,MAAA;MAAb,GAAA,CAAA,EAAA,MAAA;IAAd,CAAA,CAAA;EAAa,CAAA;AAqChB,CAAA;;;;;;;;;iBC7KgB,kBAAA,yBAEL,6BAA8B,KAAA,WAAA,GAAA,qBAAA,CAAA,sBAAA,WAAA,GAAA,qBAAA,CAAA;EArB7B,IAAA,EAAA,MAAA;CACD,CAAA,EAAA;;;;;;cCuHE,eAgCZ,qBAAA,CAhCyB"}