logomarks 1.0.0 → 2.0.0

package/src/similar/nearest.d.ts

@@ -22,7 +22,7 @@ export interface SimilarOptions {
 	top?: number;
 	/** Compare the candidate's knocked-out letter (its holes) instead of its outline (false). */
 	letters?: boolean;
-	/** The live marks (the bundled index). */
+	/** The live marks (the cached index). */
 	index?: MarkIndex;
 	/** A slug to leave out (the candidate itself). */
 	exclude?: string;

package/src/similar/store.d.ts

@@ -12,6 +12,8 @@ export interface MarkAbout {
 	mood: string[];
 	/** The letter or number it shows, for letter marks. */
 	letter?: string;
+	/** What it depicts: subject ids (letter, animal, food-drink …), the main one first. */
+	subject?: string[];
 	/** What it looks like, in a sentence. */
 	description: string;
 	/** The kinds of business it suits, best fit first (may be empty). */
@@ -45,7 +47,7 @@ export interface MarkIndex {
 	built: string;
 	marks: IndexedMark[];
 	letters: IndexedLetter[];
-	/** The board's search over `marks`, in the same order (a packed @arraypress/search index); only the bundled index has it. */
+	/** The board's search over `marks`, in the same order (a packed @arraypress/search index); only the live set's index has it, not a folder's. */
 	search?: Packed;
 }
 
@@ -59,9 +61,10 @@ export interface IndexInput {
 	search: Packed;
 }
 
-/** Where the bundled index lives. */
-export const INDEX_FILE: URL;
-/** Writes an index (brotli) and returns its size in bytes. */
-export function writeIndex(input: IndexInput, file?: string | URL): number;
-/** Reads an index, once per file. Throws when it is missing or from another version. */
+/** Writes an index file (brotli) and returns its size in bytes. */
+export function writeIndex(input: IndexInput, file: string | URL): number;
+/**
+ * Reads an index, once per file. With no file, the process's: the one `ensureIndex` settled on, else
+ * `LOGOMARKS_INDEX`, else the cached one. Throws an `IndexError` when there's none or it's in another format.
+ */
 export function loadIndex(file?: string | URL): MarkIndex;

package/src/similar/store.js

@@ -1,88 +1,49 @@
 /**
  * @module logomarks/similar/store
  *
- * The bundled index of live marks: each mark's slug, name and SVG, what it is
- * (tags, collection, style, mood, letter, description, industries: what
+ * The live set's index: each mark's slug, name and SVG, what it is (tags,
+ * collection, style, mood, letter, subject, description, industries: what
  * `findMarks` searches), its 48 px coverage (the outline signature before its
- * blur), and for badges and letter marks a letter signature, and the board's search over them (a packed
- * @arraypress/search index: `findMarks`). One brotli-compressed file, built by
- * `npm run index` from the Logomarks data, so `similar` and `sheet` work
- * offline. Layout: a 4-byte JSON length, the JSON (marks and letters), then
- * the signature bytes.
+ * blur), for badges and letter marks a letter signature, and the board's
+ * search over them (a packed @arraypress/search index). It isn't bundled: the
+ * site serves it, and `ensureIndex` (../live/ensure.js) downloads and caches
+ * it. The format is ../live/format.js.
  */
 
 import fs from 'node:fs';
-import zlib from 'node:zlib';
-import { SIMILAR, LETTERS } from '../rules.js';
-import { blur } from './signature.js';
-
-/** Where the bundled index lives. */
-export const INDEX_FILE = new URL('../../data/index.bin', import.meta.url);
-
-/** The file format's version. */
-const VERSION = 3;
-
-/** Letter signatures are quarters (2×2 supersampling): stored ×4. */
-const QUARTERS = 4;
+import { encodeIndex, decodeIndex } from '../live/format.js';
+import { currentIndexFile } from '../live/current.js';
 
+/** Each file's index, read once. */
 /** @type {Map<string, import('./store.js').MarkIndex>} */
 const cache = new Map();
 
 /**
- * Writes an index.
+ * Writes an index file (the monorepo's `npm run index`; the site builds its own with `buildIndex`).
  *
- * @param {import('./store.js').IndexInput} input The marks and their signatures.
- * @param {string | URL} [file] Where (the bundled index).
+ * @param {import('./store.js').IndexInput} input The marks, their signatures and the packed search.
+ * @param {string | URL} file Where.
  * @returns {number} The file's size in bytes.
  */
-export function writeIndex({ marks, coverages, letters, search }, file = INDEX_FILE) {
-	const head = Buffer.from(JSON.stringify({
-		version: VERSION,
-		built: new Date().toISOString().slice(0, 10),
-		size: SIMILAR.size,
-		letterSize: LETTERS.size,
-		marks: marks.map(({ slug, name, svg, ...about }) => [slug, name, svg, about]),
-		letters: letters.map((l) => [l.mark, l.kind]),
-		search,
-	}));
-	const length = Buffer.alloc(4);
-	length.writeUInt32LE(head.length);
-	const bytes = (/** @type {ArrayLike<number>} */ a, /** @type {number} */ k) => Uint8Array.from(a, (v) => Math.round(v * k));
-	const body = Buffer.concat([length, head, ...coverages.map((c) => bytes(c, 255)), ...letters.map((l) => bytes(l.sig, QUARTERS))]);
-	const out = zlib.brotliCompressSync(body, { params: { [zlib.constants.BROTLI_PARAM_QUALITY]: 11 } });
-	fs.writeFileSync(file, out);
-	return out.length;
+export function writeIndex(input, file) {
+	const bytes = encodeIndex(input);
+	fs.writeFileSync(file, bytes);
+	return bytes.length;
 }
 
 /**
- * Reads an index (once per file) and blurs its coverages into outline signatures.
+ * Reads an index (once per file) and blurs its coverages into outline signatures. With no file, the process's
+ * index: the one `ensureIndex` settled on, else `LOGOMARKS_INDEX`, else the cached one.
  *
- * @param {string | URL} [file] Which (the bundled index).
+ * @param {string | URL} [file] Which.
  * @returns {import('./store.js').MarkIndex} The index.
- * @throws {Error} When the file is missing or from another version.
+ * @throws {Error} When there's none (an `IndexError` saying how to get it), or it's in another format.
  */
-export function loadIndex(file = INDEX_FILE) {
-	const key = String(file);
+export function loadIndex(file) {
+	const key = String(file ?? currentIndexFile());
 	const hit = cache.get(key);
 	if (hit) return hit;
-	const body = zlib.brotliDecompressSync(fs.readFileSync(file));
-	const n = body.readUInt32LE(0);
-	const raw = JSON.parse(body.toString('utf8', 4, 4 + n));
-	if (raw.version !== VERSION) throw new Error(`index version ${raw.version}, expected ${VERSION}: run npm run index`);
-	const S = raw.size * raw.size, L = raw.letterSize * raw.letterSize;
-	let at = 4 + n;
-	const take = (/** @type {number} */ len, /** @type {number} */ k) => {
-		const a = Float32Array.from(body.subarray(at, at + len), (v) => v / k);
-		at += len;
-		return a;
-	};
-	/** @type {import('./store.js').MarkIndex} */
-	const index = {
-		built: raw.built,
-		marks: raw.marks.map((/** @type {[string, string, string, import('./store.js').MarkAbout]} */ [slug, name, svg, about]) => ({ slug, name, svg, ...about, outline: blur(take(S, 255), raw.size) })),
-		letters: raw.letters.map((/** @type {[number, 'hole' | 'ink']} */ [mark, kind]) => ({ mark, kind, sig: take(L, QUARTERS) })),
-		search: raw.search,
-	};
+	const index = decodeIndex(fs.readFileSync(key.startsWith('file:') ? new URL(key) : key));
 	cache.set(key, index);
 	return index;
 }