@qrxcode/js 0.1.1 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yeldar Kudaibergen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # QRX flow discovery SDK for JavaScript
 
-Detect RSS, Atom and JSON Feed flows from normal website and page URLs.
+Detect machine-readable flows from normal website and page URLs.
 
 With QRX, applications with QR scanners can interact with QR codes
 more like browsers interact with links.
@@ -29,12 +29,10 @@ and natural as following someone on social media.
 
 Examples of flows:
 
-- RSS feeds
-- Atom feeds
-- JSON feeds
+- Feed flows
 
-At the moment, "flow" is a broad term used by QRX
-to describe machine-readable update streams and feeds.
+In QRX, a "flow" is a recognized machine-readable relationship
+that applications can discover and interact with.
 
 QRX does not replace RSS or existing feed technologies.
 
@@ -42,6 +40,57 @@ QRX helps applications discover and work with them more naturally.
 
 Learn more at https://qrx.dev
 
+## Breaking change in 0.3.0
+
+Version `0.3.0` introduces a breaking cleanup of feed flow classification.
+
+Before `0.3.0`, RSS, Atom, and JSON Feed were represented as separate
+QRX flow types:
+
+```js
+{
+  flowType: "rss",
+  rel: "alternate",
+  href: "https://example.com/feed.xml",
+  type: "application/rss+xml"
+}
+````
+
+Starting from `0.3.0`, RSS, Atom, and JSON Feed are represented as the same
+QRX flow category:
+
+```js
+{
+  flowType: "feed",
+  rel: "alternate",
+  href: "https://example.com/feed.xml",
+  type: "application/rss+xml"
+}
+```
+
+The actual feed format remains in the original HTML/link media type:
+
+```js
+type: "application/rss+xml"
+type: "application/atom+xml"
+type: "application/feed+json"
+```
+
+Core formula:
+
+```txt
+flowType = QRX category
+type = original web/media format
+```
+
+Migration:
+
+* `flow.flowType === "rss"` is now `flow.flowType === "feed" && flow.type === "application/rss+xml"`.
+* `flow.flowType === "atom"` is now `flow.flowType === "feed" && flow.type === "application/atom+xml"`.
+* `flow.flowType === "jsonfeed"` is now `flow.flowType === "feed" && flow.type === "application/feed+json"`.
+
+QRX discovers recognized flows. Applications decide what to do with them.
+
 ## Install
 
 ```bash
@@ -65,21 +114,81 @@ console.log(result.flows);
 ```js
 [
   {
-    type: "rss",
-    url: "https://podnews.net/rss"
+    flowType: "feed",
+    rel: "alternate",
+    href: "https://podnews.net/rss",
+    type: "application/rss+xml"
   },
   {
-    type: "jsonfeed",
-    url: "https://podnews.net/feed.json"
+    flowType: "feed",
+    rel: "alternate",
+    href: "https://podnews.net/feed.json",
+    type: "application/feed+json"
   }
 ]
 ```
 
+## Selecting flows
+
+To select all feed flows:
+
+```js
+import {
+  resolveQRX,
+  selectFlowsByFlowType
+} from "@qrxcode/js";
+
+const result = await resolveQRX(
+  "https://podnews.net"
+);
+
+const feeds = selectFlowsByFlowType(
+  result.flows,
+  ["feed"]
+);
+```
+
+This returns RSS, Atom, and JSON Feed flows together.
+
+To select only RSS feeds, filter by the original media type:
+
+```js
+const rssFeeds = result.flows.filter(
+  (discoveredFlow) =>
+    discoveredFlow.flowType === "feed" &&
+    discoveredFlow.type === "application/rss+xml"
+);
+```
+
+To select only Atom feeds:
+
+```js
+const atomFeeds = result.flows.filter(
+  (discoveredFlow) =>
+    discoveredFlow.flowType === "feed" &&
+    discoveredFlow.type === "application/atom+xml"
+);
+```
+
+To select only JSON Feed feeds:
+
+```js
+const jsonFeeds = result.flows.filter(
+  (discoveredFlow) =>
+    discoveredFlow.flowType === "feed" &&
+    discoveredFlow.type === "application/feed+json"
+);
+```
+
 ## Supported flow types
 
-* RSS
-* Atom
-* JSON Feed
+* feed
+
+## Supported feed formats
+
+* RSS: `application/rss+xml`
+* Atom: `application/atom+xml`
+* JSON Feed: `application/feed+json`
 
 ## Supported discovery methods
 
@@ -108,6 +217,9 @@ console.log(result.flows);
 
 QRX does not change QR codes.
 
+QRX discovers recognized flows.
+
+Applications decide what to do with them.
+
 With QRX, sources can expose machine-readable flows,
 and applications can understand and interact with them naturally.
-

package/dist/index.cjs

@@ -22,16 +22,16 @@ var index_exports = {};
 __export(index_exports, {
   detectFlows: () => detectFlows,
   resolveQRX: () => resolveQRX,
-  selectFlows: () => selectFlows
+  selectFlowsByFlowType: () => selectFlowsByFlowType
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/detect.ts
-var FLOW_TYPES = {
-  "application/rss+xml": "rss",
-  "application/atom+xml": "atom",
-  "application/feed+json": "jsonfeed"
-};
+var FEED_TYPES = /* @__PURE__ */ new Set([
+  "application/rss+xml",
+  "application/atom+xml",
+  "application/feed+json"
+]);
 function detectFlows(html, sourceUrl) {
   const flows = [];
   const linkTagRegex = /<link\s+[^>]*>/gi;
@@ -40,54 +40,62 @@ function detectFlows(html, sourceUrl) {
     const rel = getAttribute(tag, "rel");
     const type = getAttribute(tag, "type");
     const href = getAttribute(tag, "href");
-    if (!rel || !type || !href) continue;
-    if (!rel.includes("alternate")) continue;
-    const flowType = FLOW_TYPES[type];
-    if (!flowType) continue;
+    if (!rel || !type || !href) {
+      continue;
+    }
+    const normalizedRel = rel.trim();
+    const normalizedType = type.trim().toLowerCase();
+    if (!hasRel(normalizedRel, "alternate")) {
+      continue;
+    }
+    if (!FEED_TYPES.has(normalizedType)) {
+      continue;
+    }
     flows.push({
-      type: flowType,
-      url: new URL(href, sourceUrl).toString()
+      flowType: "feed",
+      rel: normalizedRel,
+      href: new URL(href, sourceUrl).toString(),
+      type: normalizedType
     });
   }
-  return dedupeFlows(flows);
+  return flows;
 }
 function getAttribute(tag, attribute) {
   const regex = new RegExp(
-    `${attribute}=["']([^"']+)["']`,
+    `${attribute}\\s*=\\s*["']([^"']+)["']`,
     "i"
   );
   const match = tag.match(regex);
   return match ? match[1] : null;
 }
-function dedupeFlows(flows) {
-  const seen = /* @__PURE__ */ new Set();
-  return flows.filter((flow) => {
-    const key = `${flow.type}:${flow.url}`;
-    if (seen.has(key)) return false;
-    seen.add(key);
-    return true;
-  });
+function hasRel(rel, expected) {
+  return rel.toLowerCase().split(/\s+/).includes(expected);
 }
 
 // src/resolve.ts
 async function resolveQRX(url) {
   const response = await fetch(url);
   const html = await response.text();
-  const flows = detectFlows(html, response.url);
+  const flows = detectFlows(
+    html,
+    response.url
+  );
   return {
     flows
   };
 }
 
 // src/select.ts
-function selectFlows(flows, preferredTypes) {
+function selectFlowsByFlowType(flows, preferredFlowTypes) {
   return flows.filter(
-    (flow) => preferredTypes.includes(flow.type)
+    (flow) => preferredFlowTypes.includes(
+      flow.flowType
+    )
   );
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   detectFlows,
   resolveQRX,
-  selectFlows
+  selectFlowsByFlowType
 });

package/dist/index.d.cts

@@ -1,7 +1,9 @@
-type FlowType = "rss" | "atom" | "jsonfeed";
+type FlowType = "feed";
 interface Flow {
-    type: FlowType;
-    url: string;
+    flowType: FlowType;
+    rel: string;
+    href: string;
+    type: string;
 }
 interface QRXResult {
     flows: Flow[];
@@ -11,6 +13,6 @@ declare function detectFlows(html: string, sourceUrl: string): Flow[];
 
 declare function resolveQRX(url: string): Promise<QRXResult>;
 
-declare function selectFlows(flows: Flow[], preferredTypes: FlowType[]): Flow[];
+declare function selectFlowsByFlowType(flows: Flow[], preferredFlowTypes: FlowType[]): Flow[];
 
-export { type Flow, type FlowType, type QRXResult, detectFlows, resolveQRX, selectFlows };
+export { type Flow, type FlowType, type QRXResult, detectFlows, resolveQRX, selectFlowsByFlowType };

package/dist/index.d.ts

@@ -1,7 +1,9 @@
-type FlowType = "rss" | "atom" | "jsonfeed";
+type FlowType = "feed";
 interface Flow {
-    type: FlowType;
-    url: string;
+    flowType: FlowType;
+    rel: string;
+    href: string;
+    type: string;
 }
 interface QRXResult {
     flows: Flow[];
@@ -11,6 +13,6 @@ declare function detectFlows(html: string, sourceUrl: string): Flow[];
 
 declare function resolveQRX(url: string): Promise<QRXResult>;
 
-declare function selectFlows(flows: Flow[], preferredTypes: FlowType[]): Flow[];
+declare function selectFlowsByFlowType(flows: Flow[], preferredFlowTypes: FlowType[]): Flow[];
 
-export { type Flow, type FlowType, type QRXResult, detectFlows, resolveQRX, selectFlows };
+export { type Flow, type FlowType, type QRXResult, detectFlows, resolveQRX, selectFlowsByFlowType };

package/dist/index.js

@@ -1,9 +1,9 @@
 // src/detect.ts
-var FLOW_TYPES = {
-  "application/rss+xml": "rss",
-  "application/atom+xml": "atom",
-  "application/feed+json": "jsonfeed"
-};
+var FEED_TYPES = /* @__PURE__ */ new Set([
+  "application/rss+xml",
+  "application/atom+xml",
+  "application/feed+json"
+]);
 function detectFlows(html, sourceUrl) {
   const flows = [];
   const linkTagRegex = /<link\s+[^>]*>/gi;
@@ -12,53 +12,61 @@ function detectFlows(html, sourceUrl) {
     const rel = getAttribute(tag, "rel");
     const type = getAttribute(tag, "type");
     const href = getAttribute(tag, "href");
-    if (!rel || !type || !href) continue;
-    if (!rel.includes("alternate")) continue;
-    const flowType = FLOW_TYPES[type];
-    if (!flowType) continue;
+    if (!rel || !type || !href) {
+      continue;
+    }
+    const normalizedRel = rel.trim();
+    const normalizedType = type.trim().toLowerCase();
+    if (!hasRel(normalizedRel, "alternate")) {
+      continue;
+    }
+    if (!FEED_TYPES.has(normalizedType)) {
+      continue;
+    }
     flows.push({
-      type: flowType,
-      url: new URL(href, sourceUrl).toString()
+      flowType: "feed",
+      rel: normalizedRel,
+      href: new URL(href, sourceUrl).toString(),
+      type: normalizedType
     });
   }
-  return dedupeFlows(flows);
+  return flows;
 }
 function getAttribute(tag, attribute) {
   const regex = new RegExp(
-    `${attribute}=["']([^"']+)["']`,
+    `${attribute}\\s*=\\s*["']([^"']+)["']`,
     "i"
   );
   const match = tag.match(regex);
   return match ? match[1] : null;
 }
-function dedupeFlows(flows) {
-  const seen = /* @__PURE__ */ new Set();
-  return flows.filter((flow) => {
-    const key = `${flow.type}:${flow.url}`;
-    if (seen.has(key)) return false;
-    seen.add(key);
-    return true;
-  });
+function hasRel(rel, expected) {
+  return rel.toLowerCase().split(/\s+/).includes(expected);
 }
 
 // src/resolve.ts
 async function resolveQRX(url) {
   const response = await fetch(url);
   const html = await response.text();
-  const flows = detectFlows(html, response.url);
+  const flows = detectFlows(
+    html,
+    response.url
+  );
   return {
     flows
   };
 }
 
 // src/select.ts
-function selectFlows(flows, preferredTypes) {
+function selectFlowsByFlowType(flows, preferredFlowTypes) {
   return flows.filter(
-    (flow) => preferredTypes.includes(flow.type)
+    (flow) => preferredFlowTypes.includes(
+      flow.flowType
+    )
   );
 }
 export {
   detectFlows,
   resolveQRX,
-  selectFlows
+  selectFlowsByFlowType
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrxcode/js",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "QRX flow discovery SDK for JavaScript.",
   "homepage": "https://qrx.dev",
   "repository": {
@@ -21,7 +21,11 @@
       "require": "./dist/index.cjs"
     }
   },
-  "files": ["dist", "README.md"],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",
     "test": "vitest run",