html-json-extractor 0.0.1 → 0.1.0

package/README.md

@@ -15,7 +15,12 @@ npm install html-json-extractor
 ## Usage
 
 ```ts
-import { extractJsonLd, extractJsonLdStrings } from 'html-json-extractor';
+import {
+  extractJsonLd,
+  extractJsonLdStrings,
+  getJsonLdItems,
+  getJsonLdRecords
+} from 'html-json-extractor';
 
 const html = `
   <script type="application/ld+json">{"@type":"WebSite","name":"Example"}</script>
@@ -28,6 +33,12 @@ const raw = extractJsonLdStrings(html);
 
 const parsed = extractJsonLd(html);
 // [{ '@type': 'WebSite', name: 'Example' }, [{ '@type': 'Person', name: 'Ada' }]]
+
+const items = parsed.flatMap(getJsonLdItems);
+// [{ '@type': 'WebSite', name: 'Example' }, { '@type': 'Person', name: 'Ada' }]
+
+const records = parsed.flatMap(getJsonLdRecords);
+// [{ '@type': 'WebSite', name: 'Example' }, { '@type': 'Person', name: 'Ada' }]
 ```
 
 ## API
@@ -40,6 +51,14 @@ Returns normalized JSON-LD script contents as strings.
 
 Parses the extracted strings with `JSON.parse`. Entries that fail to parse are skipped.
 
+### `getJsonLdItems(value: unknown): unknown[]`
+
+Normalizes a single parsed entry or parsed array entry into a flat list of items.
+
+### `getJsonLdRecords(value: unknown): Record<string, unknown>[]`
+
+Returns record-shaped items and follows nested `@graph` content.
+
 ## License
 
 MIT

package/dist/index.cjs

@@ -315,5 +315,29 @@ function extractJsonLd(html) {
 	return results;
 }
 //#endregion
+//#region src/helpers.ts
+const isRecord = (value) => {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+};
+const asRecord = (value) => {
+	return isRecord(value) ? value : void 0;
+};
+const asArray = (value) => {
+	return Array.isArray(value) ? value : void 0;
+};
+function getJsonLdRecords(value) {
+	const items = asArray(value);
+	if (items) return items.flatMap(getJsonLdRecords);
+	const record = asRecord(value);
+	if (!record) return [];
+	return [record, ...getJsonLdRecords(record["@graph"])];
+}
+function getJsonLdItems(value) {
+	if (value === void 0) return [];
+	return asArray(value) ?? [value];
+}
+//#endregion
 exports.extractJsonLd = extractJsonLd;
 exports.extractJsonLdStrings = extractJsonLdStrings;
+exports.getJsonLdItems = getJsonLdItems;
+exports.getJsonLdRecords = getJsonLdRecords;

package/dist/index.d.cts

@@ -12,4 +12,8 @@ declare function extractJsonLd<T extends JsonValue = JsonValue>(html: string): T
 //#region src/scan.d.ts
 declare function extractJsonLdStrings(html: string): string[];
 //#endregion
-export { type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, extractJsonLd, extractJsonLdStrings };
+//#region src/helpers.d.ts
+declare function getJsonLdRecords(value: unknown): Record<string, unknown>[];
+declare function getJsonLdItems(value: unknown): unknown[];
+//#endregion
+export { type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, extractJsonLd, extractJsonLdStrings, getJsonLdItems, getJsonLdRecords };

package/dist/index.d.ts

@@ -12,4 +12,8 @@ declare function extractJsonLd<T extends JsonValue = JsonValue>(html: string): T
 //#region src/scan.d.ts
 declare function extractJsonLdStrings(html: string): string[];
 //#endregion
-export { type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, extractJsonLd, extractJsonLdStrings };
+//#region src/helpers.d.ts
+declare function getJsonLdRecords(value: unknown): Record<string, unknown>[];
+declare function getJsonLdItems(value: unknown): unknown[];
+//#endregion
+export { type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, extractJsonLd, extractJsonLdStrings, getJsonLdItems, getJsonLdRecords };

package/dist/index.js

@@ -314,4 +314,26 @@ function extractJsonLd(html) {
 	return results;
 }
 //#endregion
-export { extractJsonLd, extractJsonLdStrings };
+//#region src/helpers.ts
+const isRecord = (value) => {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+};
+const asRecord = (value) => {
+	return isRecord(value) ? value : void 0;
+};
+const asArray = (value) => {
+	return Array.isArray(value) ? value : void 0;
+};
+function getJsonLdRecords(value) {
+	const items = asArray(value);
+	if (items) return items.flatMap(getJsonLdRecords);
+	const record = asRecord(value);
+	if (!record) return [];
+	return [record, ...getJsonLdRecords(record["@graph"])];
+}
+function getJsonLdItems(value) {
+	if (value === void 0) return [];
+	return asArray(value) ?? [value];
+}
+//#endregion
+export { extractJsonLd, extractJsonLdStrings, getJsonLdItems, getJsonLdRecords };

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "html-json-extractor",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Fast, forgiving extraction of application/ld+json script blocks from HTML strings.",
   "license": "MIT",
   "author": "VastBlast",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/VastBlast/html-json-extractor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/VastBlast/html-json-extractor/issues"
+  },
+  "homepage": "https://github.com/VastBlast/html-json-extractor#readme",
   "type": "module",
   "sideEffects": false,
   "files": [
@@ -42,10 +50,9 @@
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },