@doan-labs/peek 0.1.0

package/dist/tables.d.ts

@@ -0,0 +1,258 @@
+type Pt = readonly [number, number];
+/** Structure inks: never a body color. Signal stays in the interface. */
+export declare const INK: {
+    readonly ink: "#1A1918";
+    readonly bone: "#F3F0E8";
+    readonly paper: "#FFFDF8";
+};
+export type FaceGeom = {
+    /** `stroke` rounds the corners: a round-join outline in the body ink. */
+    body: {
+        readonly d: string;
+        readonly stroke?: number;
+    } | {
+        readonly circle: readonly [number, number, number];
+    };
+    bottom: number;
+    /** How far the body sinks below the floor at rest. */
+    sink: number;
+    eyes: readonly [Pt, Pt];
+    rx: number;
+    ry: number;
+    pr: number;
+    brow: {
+        readonly y: number;
+        readonly hw: number;
+        readonly arch: number;
+        readonly w: number;
+    };
+    cheeks: readonly [Pt, Pt];
+    crx: number;
+    cry: number;
+    mouth: {
+        readonly x: number;
+        readonly y: number;
+        readonly w: number;
+        readonly d: number;
+        readonly sw: number;
+    };
+    /**
+     * The crown: the visible outline above the eyes, as a convex polygon grown
+     * by `r` (a point grown by r is a circle). `poly[0]` is the top and the
+     * polygon runs clockwise. Every trait sits on this outline, so any trait
+     * fits any face.
+     */
+    crown: {
+        readonly poly: readonly Pt[];
+        readonly r: number;
+    };
+};
+export declare const FACES: {
+    readonly diamond: {
+        readonly body: {
+            readonly d: "M170 20L320 170L170 320L20 170Z";
+        };
+        readonly bottom: 320;
+        readonly sink: 30;
+        readonly eyes: readonly [readonly [132.5, 155], readonly [207.5, 155]];
+        readonly rx: 20;
+        readonly ry: 27.5;
+        readonly pr: 10;
+        readonly brow: {
+            readonly y: 102.5;
+            readonly hw: 18.75;
+            readonly arch: 15;
+            readonly w: 5.62;
+        };
+        readonly cheeks: readonly [readonly [117.5, 200], readonly [222.5, 200]];
+        readonly crx: 11.25;
+        readonly cry: 5.62;
+        readonly mouth: {
+            readonly x: 170;
+            readonly y: 218.75;
+            readonly w: 15;
+            readonly d: 16.25;
+            readonly sw: 4.38;
+        };
+        readonly crown: {
+            readonly poly: readonly [readonly [170, 20], readonly [320, 170], readonly [170, 320], readonly [20, 170]];
+            readonly r: 0;
+        };
+    };
+    readonly semicircle: {
+        readonly body: {
+            readonly d: "M0 255A170 170 0 0 1 340 255Z";
+        };
+        readonly bottom: 255;
+        readonly sink: 0;
+        readonly eyes: readonly [readonly [102.5, 175], readonly [237.5, 175]];
+        readonly rx: 30;
+        readonly ry: 25;
+        readonly pr: 11.25;
+        readonly brow: {
+            readonly y: 127.5;
+            readonly hw: 25;
+            readonly arch: 15;
+            readonly w: 5.62;
+        };
+        readonly cheeks: readonly [readonly [55, 212.5], readonly [285, 212.5]];
+        readonly crx: 11.25;
+        readonly cry: 5.62;
+        readonly mouth: {
+            readonly x: 170;
+            readonly y: 221.25;
+            readonly w: 16.25;
+            readonly d: 16.25;
+            readonly sw: 4.38;
+        };
+        readonly crown: {
+            readonly poly: readonly [readonly [170, 255]];
+            readonly r: 170;
+        };
+    };
+    readonly circle: {
+        readonly body: {
+            readonly circle: readonly [170, 170, 150];
+        };
+        readonly bottom: 320;
+        readonly sink: 20;
+        readonly eyes: readonly [readonly [112.8, 162.2], readonly [227.2, 162.2]];
+        readonly rx: 29.9;
+        readonly ry: 29.9;
+        readonly pr: 13;
+        readonly brow: {
+            readonly y: 110.2;
+            readonly hw: 23.4;
+            readonly arch: 15.6;
+            readonly w: 5.85;
+        };
+        readonly cheeks: readonly [readonly [84.2, 203.8], readonly [255.8, 203.8]];
+        readonly crx: 11.7;
+        readonly cry: 5.85;
+        readonly mouth: {
+            readonly x: 170;
+            readonly y: 223.3;
+            readonly w: 16.9;
+            readonly d: 16.9;
+            readonly sw: 4.55;
+        };
+        readonly crown: {
+            readonly poly: readonly [readonly [170, 170]];
+            readonly r: 150;
+        };
+    };
+    readonly triangle: {
+        readonly body: {
+            readonly d: "M170 40.8L312.8 299.2L27.2 299.2Z";
+            readonly stroke: 27.2;
+        };
+        readonly bottom: 312.8;
+        readonly sink: 0;
+        readonly eyes: readonly [readonly [132.6, 210.8], readonly [207.4, 210.8]];
+        readonly rx: 20.4;
+        readonly ry: 27.2;
+        readonly pr: 10;
+        readonly brow: {
+            readonly y: 166.6;
+            readonly hw: 18.7;
+            readonly arch: 15.3;
+            readonly w: 5.62;
+        };
+        readonly cheeks: readonly [readonly [98.6, 238], readonly [241.4, 238]];
+        readonly crx: 11.5;
+        readonly cry: 5.75;
+        readonly mouth: {
+            readonly x: 170;
+            readonly y: 254;
+            readonly w: 17;
+            readonly d: 16.25;
+            readonly sw: 4.38;
+        };
+        readonly crown: {
+            readonly poly: readonly [readonly [170, 40.8], readonly [312.8, 299.2], readonly [27.2, 299.2]];
+            readonly r: 13.6;
+        };
+    };
+};
+/**
+ * Body inks, each with a deep partner at the same hue. The body fills the
+ * face and the lids, the deep ink carries cheeks and trait. The first four
+ * are from v1.2; butter, rose and aqua are provisional, matched to the same
+ * OKLCH lightness and chroma.
+ */
+export declare const COLORS: {
+    readonly lavender: {
+        readonly body: "#D8CDF0";
+        readonly deep: "#BDAEE6";
+    };
+    readonly fog: {
+        readonly body: "#C8D6E8";
+        readonly deep: "#A8BCDC";
+    };
+    readonly clay: {
+        readonly body: "#F1CDBF";
+        readonly deep: "#E2A893";
+    };
+    readonly mint: {
+        readonly body: "#CFE7D6";
+        readonly deep: "#A5CDB1";
+    };
+    readonly butter: {
+        readonly body: "#ECE2B9";
+        readonly deep: "#D9C284";
+    };
+    readonly rose: {
+        readonly body: "#EFCAD7";
+        readonly deep: "#DFA4BA";
+    };
+    readonly aqua: {
+        readonly body: "#BDE1E5";
+        readonly deep: "#8FC7D1";
+    };
+};
+/** Discrete anatomy. Each part reads every channel its feature owns. */
+export declare const PARTS: {
+    readonly eyes: readonly ["oval", "bead", "ring"];
+    readonly brows: readonly ["arch", "bar", "wedge", "dash"];
+    readonly mouth: readonly ["poly", "round", "line", "box"];
+    readonly cheeks: readonly ["oval", "dots", "lines"];
+    readonly trait: readonly ["square", "fin", "ring", "dot", "peak"];
+};
+export type Face = keyof typeof FACES;
+export type Color = keyof typeof COLORS;
+export type Part = keyof typeof PARTS;
+export type Eyes = (typeof PARTS.eyes)[number];
+export type Brows = (typeof PARTS.brows)[number];
+export type Mouth = (typeof PARTS.mouth)[number];
+export type Cheeks = (typeof PARTS.cheeks)[number];
+export type Trait = (typeof PARTS.trait)[number];
+export type Axis = 'face' | 'color' | Part;
+/** How much of each list a version may pick from. Append-only too. */
+export declare const VERSIONS: Record<number, Record<Axis, number>>;
+export declare const LATEST = 1;
+export declare const GROUPS: {
+    readonly eyes: readonly ["lid", "lower", "lidTilt", "eyeS", "lidAsym"];
+    readonly pupil: readonly ["pupil", "gx", "gy", "shine"];
+    readonly brows: readonly ["browY", "browTilt", "browArch", "browW", "browAsym"];
+    readonly mouth: readonly ["mw", "mt", "mb", "mx", "my", "mk"];
+    readonly body: readonly ["alt", "rot", "x", "sx", "sy"];
+    readonly extra: readonly ["blush", "hair", "dim", "thing"];
+};
+export type Group = keyof typeof GROUPS;
+export type Channel = (typeof GROUPS)[Group][number];
+export type Channels = Record<Channel, number>;
+export declare const EXPRESSIONS: {
+    readonly normal: Readonly<Channels>;
+    readonly happy: Readonly<Channels>;
+    readonly sad: Readonly<Channels>;
+    readonly angry: Readonly<Channels>;
+    readonly sleepy: Readonly<Channels>;
+    readonly curious: Readonly<Channels>;
+    readonly surprised: Readonly<Channels>;
+    readonly excited: Readonly<Channels>;
+    readonly confused: Readonly<Channels>;
+    readonly bored: Readonly<Channels>;
+    readonly attentive: Readonly<Channels>;
+};
+export type Expression = keyof typeof EXPRESSIONS;
+export {};

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@doan-labs/peek",
+  "version": "0.1.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "development": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./svg": {
+      "types": "./dist/svg.d.ts",
+      "import": "./dist/svg.js",
+      "default": "./dist/svg.js"
+    },
+    "./identity": {
+      "types": "./dist/identity.d.ts",
+      "import": "./dist/identity.js",
+      "default": "./dist/identity.js"
+    }
+  },
+  "scripts": {
+    "check-types": "tsc --noEmit",
+    "test": "bun test",
+    "build": "bun scripts/build.ts",
+    "prepack": "bun run build"
+  },
+  "peerDependencies": {
+    "react": ">=19"
+  },
+  "devDependencies": {
+    "@peek/typescript-config": "workspace:*",
+    "@types/bun": "latest",
+    "@types/react": "^19.2.0",
+    "@types/react-dom": "^19.2.0",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "typescript": "^6.0.2"
+  },
+  "description": "Deterministic SVG avatars from a name, with expressions and a React component.",
+  "homepage": "https://peek.doan-labs.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/doan-labs/peek.git",
+    "directory": "packages/peek"
+  },
+  "keywords": [
+    "avatar",
+    "svg",
+    "react",
+    "deterministic",
+    "peek"
+  ],
+  "files": [
+    "dist",
+    "src/*.ts",
+    "src/*.tsx",
+    "!src/*.test.ts",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  }
+}