ink-framework-barcode 0.0.0-stage → 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vandam Dinh
+
+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/ink-native.json

@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "modules": {
+    "src/generate.ts": [
+      "barcode-generate",
+      "image"
+    ],
+    "src/scan.ts": [
+      "code-scanner"
+    ]
+  }
+}

package/package.json

@@ -1,6 +1,24 @@
 {
   "name": "ink-framework-barcode",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-alpha.1",
+  "exports": {
+    ".": "./src/generate.ts",
+    "./scan": "./src/scan.ts"
+  },
+  "peerDependencies": {
+    "ink": "npm:ink-framework@0.1.0-alpha.1",
+    "react": "19.2.8",
+    "@ink/camera": "npm:ink-framework-camera@0.1.0-alpha.1"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/No-Scrolling/ink.git",
+    "directory": "packages/barcode"
+  },
+  "files": [
+    "src",
+    "*.json",
+    "*.ts"
+  ]
+}

package/src/generate.ts

@@ -0,0 +1,20 @@
+import { createElement } from "react";
+
+export const supportedFormats = ["qr", "aztec", "data-matrix", "pdf417", "ean-13", "ean-8", "upc-a", "upc-e", "code-39", "code-93", "code-128", "itf", "codabar"] as const;
+export type BarcodeFormat = typeof supportedFormats[number];
+
+export function Barcode(props: {
+  format: BarcodeFormat;
+  value: string;
+  /** Display width in Ink layout units; height follows the generated code. */
+  size: number;
+  /** Print the encoded value beneath a linear barcode. */
+  showValue?: boolean;
+}) {
+  if (!supportedFormats.includes(props.format)) throw new Error("Unsupported barcode format");
+  if (!props.value.length) throw new Error("Barcode value must not be empty");
+  if (!Number.isFinite(props.size) || props.size <= 0 || props.size > 1080) {
+    throw new RangeError("Barcode size must be greater than zero and at most 1080");
+  }
+  return createElement("Barcode", props);
+}

package/src/scan.ts

@@ -0,0 +1,21 @@
+import { NativeError } from "ink/native";
+import { useSession, codeFormats, type CodeFormat, type CodeScan } from "@ink/camera/internal";
+export { CameraPreview, codeFormats, type CodeFormat, type CodeScan } from "@ink/camera/internal";
+
+function codeFormat(value: unknown): CodeFormat {
+  const format = codeFormats.find(format => format === value);
+  if (!format) throw new NativeError("protocol", "Invalid barcode format");
+  return format;
+}
+function decodeCode(value: unknown): CodeScan {
+  if (typeof value !== "object" || value === null || !("text" in value) || typeof value.text !== "string" || !("format" in value)) throw new NativeError("protocol", "Invalid scanned code");
+  if (!("rawBytes" in value) || (value.rawBytes !== null && (!Array.isArray(value.rawBytes)
+    || !value.rawBytes.every((byte: unknown) => typeof byte === "number" && Number.isInteger(byte) && byte >= 0 && byte <= 255)))) throw new NativeError("protocol", "Invalid barcode bytes");
+  return { text: value.text, format: codeFormat(value.format), rawBytes: value.rawBytes === null ? null : new Uint8Array(value.rawBytes) };
+}
+
+export function useCodeScanner({ formats = [...codeFormats], continuous = false, intervalMs = 1000, facing = "back" }: { formats?: readonly CodeFormat[]; continuous?: boolean; intervalMs?: number; facing?: "back" | "front" } = {}) {
+  if (!Number.isSafeInteger(intervalMs) || intervalMs < 100 || intervalMs > 60_000) throw new RangeError("Scan interval must be between 100 and 60000 milliseconds");
+  if (!formats.length) throw new TypeError("Choose at least one barcode format");
+  return useSession("scanner", decodeCode, JSON.stringify({ formats: formats.map(codeFormat), continuous, intervalMs, facing }));
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.