nfcfyi 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FYIPedia
+
+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

@@ -0,0 +1,90 @@
+# nfcfyi
+
+[![npm](https://img.shields.io/npm/v/nfcfyi)](https://www.npmjs.com/package/nfcfyi)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.7-blue)](https://www.typescriptlang.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Zero Dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)](https://www.npmjs.com/package/nfcfyi)
+
+TypeScript API client for [NFCFYI](https://nfcfyi.com) -- the comprehensive NFC reference covering NFC chips (NTAG, MIFARE, ST25), chip families, NDEF record types, operating modes (reader/writer, peer-to-peer, card emulation), ISO 14443/ISO 15693 standards, and real-world use cases. Zero dependencies, uses native `fetch`.
+
+> **Explore NFC at [nfcfyi.com](https://nfcfyi.com)** -- [Chips](https://nfcfyi.com/chips/) | [Standards](https://nfcfyi.com/standards/) | [Glossary](https://nfcfyi.com/glossary/) | [API Docs](https://nfcfyi.com/developers/)
+
+## Install
+
+```bash
+npm install nfcfyi
+```
+
+Works in Node.js, Deno, Bun, and browsers (ESM).
+
+## Quick Start
+
+```typescript
+import { NFCFYI } from "nfcfyi";
+
+const api = new NFCFYI();
+
+// Search NFC chips, standards, NDEF types
+const results = await api.search("ntag 215");
+
+// Get NFC chip detail
+const ntag215 = await api.chip("ntag-215");
+console.log(ntag215.memory_size);    // "504 bytes"
+console.log(ntag215.manufacturer);   // "NXP"
+
+// Get NDEF type detail
+const uri = await api.ndefType("uri");
+console.log(uri.tnf); // 1
+
+// Compare two NFC chips
+const comparison = await api.compare("ntag-215", "ntag-216");
+```
+
+## API Methods
+
+| Method | Description |
+|--------|-------------|
+| `search(query)` | Search chips, standards, NDEF types, glossary |
+| `glossaryTerm(slug)` | Get glossary term definition |
+| `chip(slug)` | NFC chip detail |
+| `chipFamily(slug)` | NFC chip family detail |
+| `standard(slug)` | NFC standard detail |
+| `operatingMode(slug)` | Operating mode detail |
+| `ndefType(slug)` | NDEF record type detail |
+| `useCase(slug)` | Use case detail |
+| `compare(slugA, slugB)` | Compare two NFC chips |
+| `random()` | Random NFC chip |
+| `openapi()` | OpenAPI 3.1.0 specification |
+
+## TypeScript Types
+
+```typescript
+import type {
+  SearchResult, ChipDetail, ChipFamilyDetail, StandardDetail,
+  OperatingModeDetail, NdefTypeDetail, UseCaseDetail, GlossaryTerm, CompareResult,
+} from "nfcfyi";
+```
+
+## Also Available
+
+| Language | Package |
+|----------|---------|
+| Python | [nfcfyi on PyPI](https://pypi.org/project/nfcfyi/) |
+| TypeScript | **This package** |
+
+## Code FYI Family
+
+Part of the [FYIPedia](https://fyipedia.com) open-source developer tools ecosystem -- automatic identification and data capture technologies.
+
+| Package | npm | Description |
+|---------|-----|-------------|
+| barcodefyi | [npm](https://www.npmjs.com/package/barcodefyi) | Barcode symbologies, standards -- [barcodefyi.com](https://barcodefyi.com/) |
+| qrcodefyi | [npm](https://www.npmjs.com/package/qrcodefyi) | QR code types, versions, encoding -- [qrcodefyi.com](https://qrcodefyi.com/) |
+| **nfcfyi** | [npm](https://www.npmjs.com/package/nfcfyi) | **NFC chips, NDEF, standards -- [nfcfyi.com](https://nfcfyi.com/)** |
+| blefyi | [npm](https://www.npmjs.com/package/blefyi) | BLE profiles, beacons, chips -- [blefyi.com](https://blefyi.com/) |
+| rfidfyi | [npm](https://www.npmjs.com/package/rfidfyi) | RFID tags, readers, frequencies -- [rfidfyi.com](https://rfidfyi.com/) |
+| smartcardfyi | [npm](https://www.npmjs.com/package/smartcardfyi) | Smart cards, EMV, platforms -- [smartcardfyi.com](https://smartcardfyi.com/) |
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,93 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  NFCFYI: () => NFCFYI
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var NFCFYI = class {
+  baseUrl;
+  constructor(baseUrl = "https://nfcfyi.com") {
+    this.baseUrl = baseUrl.replace(/\/+$/, "");
+  }
+  async get(path, params) {
+    const url = new URL(path, this.baseUrl);
+    if (params) {
+      Object.entries(params).forEach(([k, v]) => url.searchParams.set(k, v));
+    }
+    const res = await fetch(url.toString());
+    if (!res.ok) throw new Error(`HTTP ${res.status}`);
+    return res.json();
+  }
+  /** Search NFC chips, standards, NDEF types, and glossary terms. */
+  async search(query) {
+    return this.get("/api/search/", { q: query });
+  }
+  /** Get a glossary term by slug. */
+  async glossaryTerm(slug) {
+    return this.get(`/api/term/${slug}/`);
+  }
+  /** Get NFC chip detail by slug. */
+  async chip(slug) {
+    return this.get(`/api/chip/${slug}/`);
+  }
+  /** Get NFC chip family detail by slug. */
+  async chipFamily(slug) {
+    return this.get(`/api/chip-family/${slug}/`);
+  }
+  /** Get NFC standard detail by slug. */
+  async standard(slug) {
+    return this.get(`/api/standard/${slug}/`);
+  }
+  /** Get NFC operating mode detail by slug. */
+  async operatingMode(slug) {
+    return this.get(`/api/operating-mode/${slug}/`);
+  }
+  /** Get NDEF type detail by slug. */
+  async ndefType(slug) {
+    return this.get(`/api/ndef-type/${slug}/`);
+  }
+  /** Get use case detail by slug. */
+  async useCase(slug) {
+    return this.get(`/api/use-case/${slug}/`);
+  }
+  /** Compare two NFC chips. */
+  async compare(slugA, slugB) {
+    return this.get("/api/compare/", {
+      a: slugA,
+      b: slugB
+    });
+  }
+  /** Get a random NFC chip. */
+  async random() {
+    return this.get("/api/random/");
+  }
+  /** Get the OpenAPI 3.1.0 specification. */
+  async openapi() {
+    return this.get("/api/openapi.json");
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  NFCFYI
+});

package/dist/index.d.cts

@@ -0,0 +1,118 @@
+/**
+ * NFCFYI API response types.
+ */
+interface SearchResult {
+    results: Array<{
+        name: string;
+        slug: string;
+        type: string;
+        url: string;
+    }>;
+    query: string;
+    total: number;
+}
+interface GlossaryTerm {
+    name: string;
+    slug: string;
+    definition: string;
+    related_terms?: string[];
+}
+interface ChipDetail {
+    slug: string;
+    name: string;
+    description: string;
+    family?: string;
+    manufacturer?: string;
+    memory_size?: string;
+    frequency?: string;
+    data_rate?: string;
+    url: string;
+}
+interface ChipFamilyDetail {
+    slug: string;
+    name: string;
+    description: string;
+    chips?: string[];
+    url: string;
+}
+interface StandardDetail {
+    slug: string;
+    name: string;
+    description: string;
+    organization?: string;
+    year?: number;
+    url: string;
+}
+interface OperatingModeDetail {
+    slug: string;
+    name: string;
+    description: string;
+    url: string;
+}
+interface NdefTypeDetail {
+    slug: string;
+    name: string;
+    description: string;
+    tnf?: number;
+    url: string;
+}
+interface UseCaseDetail {
+    slug: string;
+    name: string;
+    description: string;
+    chips?: string[];
+    url: string;
+}
+interface CompareResult {
+    item_a: {
+        name: string;
+        slug: string;
+    };
+    item_b: {
+        name: string;
+        slug: string;
+    };
+    comparison: Record<string, unknown>;
+}
+interface RandomResult {
+    slug: string;
+    name: string;
+    type: string;
+    url: string;
+}
+
+/**
+ * NFCFYI API client -- TypeScript wrapper for nfcfyi.com REST API.
+ *
+ * Zero dependencies. Uses native `fetch`.
+ */
+
+declare class NFCFYI {
+    private baseUrl;
+    constructor(baseUrl?: string);
+    private get;
+    /** Search NFC chips, standards, NDEF types, and glossary terms. */
+    search(query: string): Promise<SearchResult>;
+    /** Get a glossary term by slug. */
+    glossaryTerm(slug: string): Promise<GlossaryTerm>;
+    /** Get NFC chip detail by slug. */
+    chip(slug: string): Promise<ChipDetail>;
+    /** Get NFC chip family detail by slug. */
+    chipFamily(slug: string): Promise<ChipFamilyDetail>;
+    /** Get NFC standard detail by slug. */
+    standard(slug: string): Promise<StandardDetail>;
+    /** Get NFC operating mode detail by slug. */
+    operatingMode(slug: string): Promise<OperatingModeDetail>;
+    /** Get NDEF type detail by slug. */
+    ndefType(slug: string): Promise<NdefTypeDetail>;
+    /** Get use case detail by slug. */
+    useCase(slug: string): Promise<UseCaseDetail>;
+    /** Compare two NFC chips. */
+    compare(slugA: string, slugB: string): Promise<CompareResult>;
+    /** Get a random NFC chip. */
+    random(): Promise<RandomResult>;
+    /** Get the OpenAPI 3.1.0 specification. */
+    openapi(): Promise<Record<string, unknown>>;
+}
+
+export { type ChipDetail, type ChipFamilyDetail, type CompareResult, type GlossaryTerm, NFCFYI, type NdefTypeDetail, type OperatingModeDetail, type RandomResult, type SearchResult, type StandardDetail, type UseCaseDetail };

package/dist/index.d.ts

@@ -0,0 +1,118 @@
+/**
+ * NFCFYI API response types.
+ */
+interface SearchResult {
+    results: Array<{
+        name: string;
+        slug: string;
+        type: string;
+        url: string;
+    }>;
+    query: string;
+    total: number;
+}
+interface GlossaryTerm {
+    name: string;
+    slug: string;
+    definition: string;
+    related_terms?: string[];
+}
+interface ChipDetail {
+    slug: string;
+    name: string;
+    description: string;
+    family?: string;
+    manufacturer?: string;
+    memory_size?: string;
+    frequency?: string;
+    data_rate?: string;
+    url: string;
+}
+interface ChipFamilyDetail {
+    slug: string;
+    name: string;
+    description: string;
+    chips?: string[];
+    url: string;
+}
+interface StandardDetail {
+    slug: string;
+    name: string;
+    description: string;
+    organization?: string;
+    year?: number;
+    url: string;
+}
+interface OperatingModeDetail {
+    slug: string;
+    name: string;
+    description: string;
+    url: string;
+}
+interface NdefTypeDetail {
+    slug: string;
+    name: string;
+    description: string;
+    tnf?: number;
+    url: string;
+}
+interface UseCaseDetail {
+    slug: string;
+    name: string;
+    description: string;
+    chips?: string[];
+    url: string;
+}
+interface CompareResult {
+    item_a: {
+        name: string;
+        slug: string;
+    };
+    item_b: {
+        name: string;
+        slug: string;
+    };
+    comparison: Record<string, unknown>;
+}
+interface RandomResult {
+    slug: string;
+    name: string;
+    type: string;
+    url: string;
+}
+
+/**
+ * NFCFYI API client -- TypeScript wrapper for nfcfyi.com REST API.
+ *
+ * Zero dependencies. Uses native `fetch`.
+ */
+
+declare class NFCFYI {
+    private baseUrl;
+    constructor(baseUrl?: string);
+    private get;
+    /** Search NFC chips, standards, NDEF types, and glossary terms. */
+    search(query: string): Promise<SearchResult>;
+    /** Get a glossary term by slug. */
+    glossaryTerm(slug: string): Promise<GlossaryTerm>;
+    /** Get NFC chip detail by slug. */
+    chip(slug: string): Promise<ChipDetail>;
+    /** Get NFC chip family detail by slug. */
+    chipFamily(slug: string): Promise<ChipFamilyDetail>;
+    /** Get NFC standard detail by slug. */
+    standard(slug: string): Promise<StandardDetail>;
+    /** Get NFC operating mode detail by slug. */
+    operatingMode(slug: string): Promise<OperatingModeDetail>;
+    /** Get NDEF type detail by slug. */
+    ndefType(slug: string): Promise<NdefTypeDetail>;
+    /** Get use case detail by slug. */
+    useCase(slug: string): Promise<UseCaseDetail>;
+    /** Compare two NFC chips. */
+    compare(slugA: string, slugB: string): Promise<CompareResult>;
+    /** Get a random NFC chip. */
+    random(): Promise<RandomResult>;
+    /** Get the OpenAPI 3.1.0 specification. */
+    openapi(): Promise<Record<string, unknown>>;
+}
+
+export { type ChipDetail, type ChipFamilyDetail, type CompareResult, type GlossaryTerm, NFCFYI, type NdefTypeDetail, type OperatingModeDetail, type RandomResult, type SearchResult, type StandardDetail, type UseCaseDetail };

package/dist/index.js

@@ -0,0 +1,66 @@
+// src/client.ts
+var NFCFYI = class {
+  baseUrl;
+  constructor(baseUrl = "https://nfcfyi.com") {
+    this.baseUrl = baseUrl.replace(/\/+$/, "");
+  }
+  async get(path, params) {
+    const url = new URL(path, this.baseUrl);
+    if (params) {
+      Object.entries(params).forEach(([k, v]) => url.searchParams.set(k, v));
+    }
+    const res = await fetch(url.toString());
+    if (!res.ok) throw new Error(`HTTP ${res.status}`);
+    return res.json();
+  }
+  /** Search NFC chips, standards, NDEF types, and glossary terms. */
+  async search(query) {
+    return this.get("/api/search/", { q: query });
+  }
+  /** Get a glossary term by slug. */
+  async glossaryTerm(slug) {
+    return this.get(`/api/term/${slug}/`);
+  }
+  /** Get NFC chip detail by slug. */
+  async chip(slug) {
+    return this.get(`/api/chip/${slug}/`);
+  }
+  /** Get NFC chip family detail by slug. */
+  async chipFamily(slug) {
+    return this.get(`/api/chip-family/${slug}/`);
+  }
+  /** Get NFC standard detail by slug. */
+  async standard(slug) {
+    return this.get(`/api/standard/${slug}/`);
+  }
+  /** Get NFC operating mode detail by slug. */
+  async operatingMode(slug) {
+    return this.get(`/api/operating-mode/${slug}/`);
+  }
+  /** Get NDEF type detail by slug. */
+  async ndefType(slug) {
+    return this.get(`/api/ndef-type/${slug}/`);
+  }
+  /** Get use case detail by slug. */
+  async useCase(slug) {
+    return this.get(`/api/use-case/${slug}/`);
+  }
+  /** Compare two NFC chips. */
+  async compare(slugA, slugB) {
+    return this.get("/api/compare/", {
+      a: slugA,
+      b: slugB
+    });
+  }
+  /** Get a random NFC chip. */
+  async random() {
+    return this.get("/api/random/");
+  }
+  /** Get the OpenAPI 3.1.0 specification. */
+  async openapi() {
+    return this.get("/api/openapi.json");
+  }
+};
+export {
+  NFCFYI
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "nfcfyi",
+  "version": "0.1.0",
+  "description": "TypeScript API client for NFCFYI -- NFC chips, chip families, NDEF types, operating modes, and standards. Zero dependencies.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "nfc",
+    "ndef",
+    "contactless",
+    "iso-14443",
+    "rfid",
+    "api-client",
+    "nfcfyi"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fyipedia/nfcfyi-js"
+  },
+  "homepage": "https://nfcfyi.com",
+  "license": "MIT",
+  "author": "FYIPedia",
+  "devDependencies": {
+    "tsup": "^8.0",
+    "typescript": "^5.7",
+    "vitest": "^3.0"
+  }
+}