feat: create @qifi/generate package

Author: LittleSound

cspell.config.yaml

@@ -8,6 +8,7 @@ words:
   - luby
   - Nuxt
   - pako
+  - qifi
   - Soliton
   - timeseries
   - unocss

packages/generate/README.md

@@ -0,0 +1,32 @@
+# @qifi/generate
+
+Stream Generated QR Codes for data transmission
+
+# Usage
+
+```javascript
+import {
+  createGeneraterANSI,
+  createGeneraterUnicode,
+  createGeneraterUnicodeCompact,
+  createGeneraterSVG,
+  createGeneraterQRCodeArray,
+} from '@qifi/generate'
+
+const generaterSvg = createGeneraterSVG(new Uint8Array(file.buffer))
+
+const generaterANSI = createGeneraterANSI(new Uint8Array(file.buffer), {
+  // Size of each data slice
+  indicesSize: 250,
+  // Error correction level
+  ecc: 'L',
+  // Border width
+  border: 2,
+})
+
+// display QR Code in terminal
+for (const blockQRCode of generaterANSI) {
+  console.log(blockQRCode)
+}
+
+```

packages/generate/build.config.ts

@@ -0,0 +1,19 @@
+import { defineBuildConfig } from 'unbuild'
+
+export default defineBuildConfig({
+  entries: [
+    'src/index.ts',
+  ],
+  declaration: true,
+  rollup: {
+    emitCJS: false,
+    dts: {
+      compilerOptions: {
+        paths: {},
+      },
+    },
+  },
+  externals: [
+    'pako',
+  ],
+})

packages/generate/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@qifi/generate",
+  "type": "module",
+  "version": "0.0.2",
+  "description": "Stream Generated QR Codes for data transmission",
+  "author": "Rizumu Ayaka <[email protected]>",
+  "license": "MIT",
+  "homepage": "https://github.com/qifi-dev/qrs#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/qifi-dev/qrs.git",
+    "directory": "packages/generate"
+  },
+  "bug": "https://github.com/qifi-dev/qrs/issues",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "stub": "unbuild --stub"
+  },
+  "dependencies": {
+    "js-base64": "^3.7.7",
+    "luby-transform": "workspace:*",
+    "uqr": "^0.1.2"
+  }
+}

packages/generate/src/base-generater.ts

@@ -0,0 +1,36 @@
+import { createEncoder } from 'luby-transform'
+import { type CreateBlockRenderFn, type GeneraterBaseOptions, GeneraterDefaultOptions } from './shared'
+
+export function createGeneraterWithRender<Result, RenderOptions>(createRender: CreateBlockRenderFn<Result, RenderOptions>) {
+  return (data: Uint8Array, options?: GeneraterBaseOptions<RenderOptions>) => {
+    const _options = Object.assign({}, GeneraterDefaultOptions, options)
+
+    const encoder = createEncoder(data, _options.indicesSize, _options.compress)
+
+    let _fountain: ReturnType<typeof encoder.fountain>
+
+    const render = createRender(_options)
+
+    return {
+      encoder,
+
+      /**
+       * Generate random encoded blocks that **never** ends
+       */
+      *fountain(): Generator<Result> {
+        while (true) {
+          _fountain ||= encoder.fountain()
+          const block = _fountain.next().value
+          yield render(block)
+        }
+      },
+
+      /**
+       * Manually creates an encoded block from the original data.
+       */
+      createBlock(indices: number[]): Result {
+        return render(encoder.createBlock(indices))
+      },
+    }
+  }
+}

packages/generate/src/generater.ts

@@ -0,0 +1,64 @@
+import type { EncodedBlock } from 'luby-transform'
+import { type QrCodeGenerateOptions, type QrCodeGenerateSvgOptions, type QrCodeGenerateUnicodeOptions, encode as qrEncode, renderANSI, renderSVG, renderUnicode } from 'uqr'
+import { createGeneraterWithRender } from './base-generater'
+import { addUrlPrefix, blockToBase64, type GeneraterBaseOptions } from './shared'
+
+/**
+ * Render QR Code to ANSI colored string.
+ */
+export const createGeneraterANSI = /* @__PURE__ */ createGeneraterWithRender(withRenderANSI)
+function withRenderANSI(options: GeneraterBaseOptions<QrCodeGenerateOptions>) {
+  return (data: EncodedBlock) => {
+    let base64str = blockToBase64(data)
+    base64str = addUrlPrefix(options.urlPrefix, base64str)
+    return renderANSI(base64str, options)
+  }
+}
+
+/**
+ * Render QR Code to Unicode string for each pixel. By default it uses █ and ░ to represent black and white pixels, and it can be customizable.
+ */
+export const createGeneraterUnicode = /* @__PURE__ */ createGeneraterWithRender(withRenderUnicode)
+function withRenderUnicode(options: GeneraterBaseOptions<QrCodeGenerateUnicodeOptions>) {
+  return (data: EncodedBlock) => {
+    let base64str = blockToBase64(data)
+    base64str = addUrlPrefix(options.urlPrefix, base64str)
+    return renderUnicode(base64str, options)
+  }
+}
+
+/**
+ * Render QR Code with two rows into one line with unicode ▀, ▄, █,  . It is useful when you want to display QR Code in terminal with limited height.
+ */
+export const createGeneraterUnicodeCompact = /* @__PURE__ */ createGeneraterWithRender(withRenderUnicodeCompact)
+function withRenderUnicodeCompact(options: GeneraterBaseOptions<QrCodeGenerateUnicodeOptions>) {
+  return (data: EncodedBlock) => {
+    let base64str = blockToBase64(data)
+    base64str = addUrlPrefix(options.urlPrefix, base64str)
+    return renderUnicode(base64str, options)
+  }
+}
+
+/**
+ * Render QR Code to SVG string.
+ */
+export const createGeneraterSVG = /* @__PURE__ */ createGeneraterWithRender(withRenderSVG)
+function withRenderSVG(options: GeneraterBaseOptions<QrCodeGenerateSvgOptions>) {
+  return (data: EncodedBlock) => {
+    let base64str = blockToBase64(data)
+    base64str = addUrlPrefix(options.urlPrefix, base64str)
+    return renderSVG(base64str, options)
+  }
+}
+
+/**
+ * Encode data into QR Code represented by a 2D array.
+ */
+export const createGeneraterQRCodeArray = /* @__PURE__ */ createGeneraterWithRender(withRenderQRCodeArray)
+function withRenderQRCodeArray(options: GeneraterBaseOptions<QrCodeGenerateOptions>) {
+  return (data: EncodedBlock) => {
+    let base64str = blockToBase64(data)
+    base64str = addUrlPrefix(options.urlPrefix, base64str)
+    return qrEncode(base64str, options)
+  }
+}

packages/generate/src/index.ts

@@ -0,0 +1,9 @@
+export * from './base-generater'
+export * from './generater'
+
+export {
+  type CreateBlockRenderFn,
+  type GeneraterBaseOptions,
+
+  GeneraterDefaultOptions,
+} from './shared'

packages/generate/src/shared.ts

@@ -0,0 +1,23 @@
+import { fromUint8Array } from 'js-base64'
+import { blockToBinary, type EncodedBlock } from 'luby-transform'
+
+export type CreateBlockRenderFn<Result, RenderOptions> = (renderOptions: GeneraterBaseOptions<RenderOptions>) => (block: EncodedBlock) => Result
+
+export type GeneraterBaseOptions<RenderOptions> = {
+  indicesSize?: number
+  compress?: boolean
+  urlPrefix?: string
+} & RenderOptions
+
+export const GeneraterDefaultOptions = {
+  indicesSize: 500,
+  urlPrefix: '',
+}
+
+export function blockToBase64(block: EncodedBlock) {
+  return fromUint8Array(blockToBinary(block))
+}
+
+export function addUrlPrefix(urlPrefix: string | undefined, base64str: string) {
+  return urlPrefix ? urlPrefix + base64str : base64str
+}

packages/generate/test/generate.test.ts

@@ -0,0 +1,5 @@
+import { expect, it } from 'vitest'
+
+it.todo('should generate test', () => {
+  expect(1).toBe(1)
+})