avatarsverse 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Kristi Kumrija
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,154 @@
1
+ # Avatarverse
2
+
3
+ Deterministic profile avatar library. Same seed, same avatar. Every time.
4
+
5
+ Pre-made voxel-style avatars for mockups, prototypes, and placeholders. Use any string as a seed (username, email, ID) and get the same avatar URL across all platforms.
6
+
7
+ ---
8
+
9
+ ## Quick Start
10
+
11
+ ### 1. CDN (no install)
12
+
13
+ Use the avatar URL directly in an `<img>` tag:
14
+
15
+ ```html
16
+ <img
17
+ src="https://cdn.jsdelivr.net/gh/coppermare/avatarverse@main/avatars/voxel/1.png"
18
+ alt="Avatar"
19
+ width="64"
20
+ height="64"
21
+ />
22
+ ```
23
+
24
+ Replace the filename with any entry from `avatars/avatars.json`. Use `@main` for latest, or `@1.0.0` (recommended) to pin to a release.
25
+
26
+ ### 2. NPM package (seed → URL)
27
+
28
+ ```bash
29
+ npm install avatarsverse
30
+ ```
31
+
32
+ ```javascript
33
+ import { avatarUrl } from "avatarsverse";
34
+
35
+ // Same seed always returns the same URL
36
+ const url = avatarUrl("alice@example.com");
37
+ // -> https://cdn.jsdelivr.net/gh/coppermare/avatarverse@main/avatars/voxel/<deterministic-file>
38
+ ```
39
+
40
+ ```jsx
41
+ // React
42
+ <img
43
+ src={avatarUrl(seed)}
44
+ alt={`Avatar for ${userName}`}
45
+ width={64}
46
+ height={64}
47
+ />
48
+ ```
49
+
50
+ ---
51
+
52
+ ## API Reference
53
+
54
+ ### `avatarUrl(seed, category?, total?, tag?)`
55
+
56
+ Get a deterministic avatar URL from a seed.
57
+
58
+ | Parameter | Type | Default | Description |
59
+ |-----------|--------|----------|-------------|
60
+ | `seed` | string | required | Any string (username, email, ID) |
61
+ | `category`| string | `"voxel"`| Avatar category |
62
+ | `total` | number | `undefined` | Optional legacy mode. If provided, URL format is `{n}.png` from `1..total`. If omitted, Avatarverse uses the built-in manifest and returns a real filename with extension. |
63
+ | `tag` | string | `"main"` | jsDelivr tag: `"main"` or pinned release such as `"1.0.0"` |
64
+
65
+ ```ts
66
+ import { avatarUrl } from "avatarsverse";
67
+
68
+ // Recommended: manifest-aware mode (safe with mixed extensions)
69
+ avatarUrl("alice@example.com");
70
+ // -> https://cdn.jsdelivr.net/gh/coppermare/avatarverse@main/avatars/voxel/148.jpeg
71
+
72
+ // Legacy explicit pool mode
73
+ avatarUrl("alice@example.com", "voxel", 15, "1.0.0");
74
+ // -> https://cdn.jsdelivr.net/gh/coppermare/avatarverse@1.0.0/avatars/voxel/7.png
75
+ ```
76
+
77
+ ---
78
+
79
+ ## Avatar Files (for maintainers)
80
+
81
+ - Avatars live under `avatars/{category}/` (currently `avatars/voxel/`).
82
+ - Supported file extensions: `.png`, `.jpg`, `.jpeg`.
83
+ - Use numeric file names where possible (`1.png`, `2.jpeg`, `3.png`, ...).
84
+ - After adding/removing avatar files, always run:
85
+
86
+ ```bash
87
+ npm run generate-avatars
88
+ ```
89
+
90
+ This updates:
91
+ - `avatars/avatars.json` (runtime/public manifest)
92
+ - `avatar-manifest.ts` (library build-time manifest)
93
+
94
+ ---
95
+
96
+ ## HTTP API (for external apps)
97
+
98
+ Run locally (`npm run dev`) or deploy the Next app.
99
+
100
+ - `GET /api/avatars`
101
+ - Returns `{ categories: { [category]: string[] } }`
102
+ - `GET /api/avatars/{category}`
103
+ - Returns `{ files: string[] }`
104
+ - `GET /api/avatars/{category}/{id}`
105
+ - Returns image binary (supports `.png`, `.jpg`, `.jpeg` and id without extension)
106
+
107
+ All routes include CORS headers and structured JSON errors:
108
+
109
+ ```json
110
+ {
111
+ "error": {
112
+ "code": "not_found",
113
+ "message": "Avatar not found."
114
+ }
115
+ }
116
+ ```
117
+
118
+ ---
119
+
120
+ ## Playground
121
+
122
+ Run locally to preview avatars and copy URLs:
123
+
124
+ ```bash
125
+ npm install
126
+ npm run dev
127
+ ```
128
+
129
+ Open http://localhost:3000
130
+
131
+ ---
132
+
133
+ ## Development Checklist
134
+
135
+ Before opening a PR or publishing:
136
+
137
+ - `npm run generate-avatars`
138
+ - `npm run lint`
139
+ - `npm test`
140
+ - `npm run build:lib`
141
+ - `npm run build`
142
+
143
+ ---
144
+
145
+ ## Contributing & Security
146
+
147
+ - Open bugs/features in GitHub Issues.
148
+ - For security vulnerabilities, do not open public issues. Use GitHub Security Advisories for private reporting.
149
+
150
+ ---
151
+
152
+ ## License
153
+
154
+ MIT. See [LICENSE](LICENSE).
@@ -0,0 +1,10 @@
1
+ export type AvatarManifest = Record<string, {
2
+ count: number;
3
+ files: string[];
4
+ }>;
5
+ /**
6
+ * Generated from avatars/avatars.json.
7
+ * Run `npm run generate-avatars` after changing avatar assets.
8
+ */
9
+ export declare const AVATAR_MANIFEST: AvatarManifest;
10
+ //# sourceMappingURL=avatar-manifest.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"avatar-manifest.d.ts","sourceRoot":"","sources":["../avatar-manifest.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,MAAM,CACjC,MAAM,EACN;IACE,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CACF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,cA6W7B,CAAC"}
@@ -0,0 +1,370 @@
1
+ /**
2
+ * Generated from avatars/avatars.json.
3
+ * Run `npm run generate-avatars` after changing avatar assets.
4
+ */
5
+ export const AVATAR_MANIFEST = {
6
+ "voxel": {
7
+ "count": 359,
8
+ "files": [
9
+ "1.jpeg",
10
+ "2.png",
11
+ "3.png",
12
+ "4.png",
13
+ "5.png",
14
+ "6.png",
15
+ "7.png",
16
+ "8.jpeg",
17
+ "9.png",
18
+ "10.png",
19
+ "11.png",
20
+ "12.png",
21
+ "13.png",
22
+ "14.png",
23
+ "15.png",
24
+ "16.png",
25
+ "17.png",
26
+ "18.jpeg",
27
+ "19.jpeg",
28
+ "20.png",
29
+ "21.jpeg",
30
+ "22.png",
31
+ "23.png",
32
+ "24.jpeg",
33
+ "25.png",
34
+ "26.jpeg",
35
+ "27.png",
36
+ "28.png",
37
+ "29.png",
38
+ "30.jpeg",
39
+ "31.png",
40
+ "32.png",
41
+ "33.jpeg",
42
+ "34.png",
43
+ "35.png",
44
+ "36.png",
45
+ "37.png",
46
+ "38.png",
47
+ "39.jpeg",
48
+ "40.png",
49
+ "41.png",
50
+ "42.jpeg",
51
+ "43.png",
52
+ "44.png",
53
+ "45.png",
54
+ "46.png",
55
+ "47.png",
56
+ "48.png",
57
+ "49.png",
58
+ "50.jpeg",
59
+ "51.png",
60
+ "52.jpeg",
61
+ "53.jpeg",
62
+ "54.png",
63
+ "55.png",
64
+ "56.png",
65
+ "57.png",
66
+ "58.png",
67
+ "59.jpeg",
68
+ "60.png",
69
+ "61.png",
70
+ "62.png",
71
+ "63.png",
72
+ "64.png",
73
+ "65.png",
74
+ "66.png",
75
+ "67.png",
76
+ "68.png",
77
+ "69.jpeg",
78
+ "70.jpeg",
79
+ "71.png",
80
+ "72.png",
81
+ "73.png",
82
+ "74.jpeg",
83
+ "75.png",
84
+ "76.png",
85
+ "77.jpeg",
86
+ "78.png",
87
+ "79.png",
88
+ "80.jpeg",
89
+ "81.png",
90
+ "82.jpeg",
91
+ "83.jpeg",
92
+ "84.png",
93
+ "85.jpeg",
94
+ "86.jpeg",
95
+ "87.png",
96
+ "88.png",
97
+ "89.jpeg",
98
+ "90.png",
99
+ "91.png",
100
+ "92.png",
101
+ "93.png",
102
+ "94.jpeg",
103
+ "95.png",
104
+ "96.jpeg",
105
+ "97.png",
106
+ "98.jpeg",
107
+ "99.png",
108
+ "100.png",
109
+ "101.png",
110
+ "102.jpeg",
111
+ "103.png",
112
+ "104.png",
113
+ "105.jpeg",
114
+ "106.jpeg",
115
+ "107.png",
116
+ "108.png",
117
+ "109.png",
118
+ "110.png",
119
+ "111.png",
120
+ "112.png",
121
+ "113.png",
122
+ "114.png",
123
+ "115.png",
124
+ "116.png",
125
+ "117.png",
126
+ "118.png",
127
+ "119.png",
128
+ "120.png",
129
+ "121.png",
130
+ "122.png",
131
+ "123.png",
132
+ "124.png",
133
+ "125.png",
134
+ "126.png",
135
+ "127.png",
136
+ "128.png",
137
+ "129.jpeg",
138
+ "130.png",
139
+ "131.png",
140
+ "132.png",
141
+ "133.png",
142
+ "134.jpeg",
143
+ "135.png",
144
+ "136.png",
145
+ "137.png",
146
+ "138.png",
147
+ "139.png",
148
+ "140.jpeg",
149
+ "141.png",
150
+ "142.jpeg",
151
+ "143.png",
152
+ "144.png",
153
+ "145.png",
154
+ "146.png",
155
+ "147.png",
156
+ "148.jpeg",
157
+ "149.jpeg",
158
+ "150.png",
159
+ "151.png",
160
+ "152.jpeg",
161
+ "153.png",
162
+ "154.png",
163
+ "155.png",
164
+ "156.png",
165
+ "157.png",
166
+ "158.jpeg",
167
+ "159.jpeg",
168
+ "160.jpeg",
169
+ "161.jpeg",
170
+ "162.png",
171
+ "163.jpeg",
172
+ "164.png",
173
+ "165.jpeg",
174
+ "166.png",
175
+ "167.png",
176
+ "168.png",
177
+ "169.jpeg",
178
+ "170.png",
179
+ "171.png",
180
+ "172.jpeg",
181
+ "173.png",
182
+ "174.png",
183
+ "175.png",
184
+ "176.png",
185
+ "177.png",
186
+ "178.png",
187
+ "179.jpeg",
188
+ "180.png",
189
+ "181.png",
190
+ "182.jpeg",
191
+ "183.png",
192
+ "184.png",
193
+ "185.png",
194
+ "186.png",
195
+ "187.png",
196
+ "188.png",
197
+ "189.png",
198
+ "190.png",
199
+ "191.png",
200
+ "192.jpeg",
201
+ "193.png",
202
+ "194.png",
203
+ "195.png",
204
+ "196.png",
205
+ "197.png",
206
+ "198.png",
207
+ "199.png",
208
+ "200.png",
209
+ "201.jpeg",
210
+ "202.png",
211
+ "203.png",
212
+ "204.png",
213
+ "205.png",
214
+ "206.png",
215
+ "207.png",
216
+ "208.jpeg",
217
+ "209.png",
218
+ "210.jpeg",
219
+ "211.png",
220
+ "212.png",
221
+ "213.png",
222
+ "214.jpeg",
223
+ "215.jpeg",
224
+ "216.png",
225
+ "217.png",
226
+ "218.jpeg",
227
+ "219.png",
228
+ "220.png",
229
+ "221.jpeg",
230
+ "222.png",
231
+ "223.png",
232
+ "224.png",
233
+ "225.png",
234
+ "226.jpeg",
235
+ "227.jpeg",
236
+ "228.png",
237
+ "229.png",
238
+ "230.png",
239
+ "231.png",
240
+ "232.png",
241
+ "233.jpeg",
242
+ "234.jpeg",
243
+ "235.png",
244
+ "236.png",
245
+ "237.jpeg",
246
+ "238.jpeg",
247
+ "239.png",
248
+ "240.jpeg",
249
+ "241.png",
250
+ "242.png",
251
+ "243.jpeg",
252
+ "244.png",
253
+ "245.png",
254
+ "246.png",
255
+ "247.png",
256
+ "248.jpeg",
257
+ "249.png",
258
+ "250.png",
259
+ "251.jpeg",
260
+ "252.jpeg",
261
+ "253.jpeg",
262
+ "254.png",
263
+ "255.jpeg",
264
+ "256.jpeg",
265
+ "257.png",
266
+ "258.png",
267
+ "259.png",
268
+ "260.jpeg",
269
+ "261.png",
270
+ "262.png",
271
+ "263.png",
272
+ "264.png",
273
+ "265.png",
274
+ "266.png",
275
+ "267.png",
276
+ "268.png",
277
+ "269.png",
278
+ "270.png",
279
+ "271.jpeg",
280
+ "272.png",
281
+ "273.jpeg",
282
+ "274.png",
283
+ "275.png",
284
+ "276.jpeg",
285
+ "277.png",
286
+ "278.png",
287
+ "279.jpeg",
288
+ "280.jpeg",
289
+ "281.png",
290
+ "282.jpeg",
291
+ "283.jpeg",
292
+ "284.png",
293
+ "285.png",
294
+ "286.png",
295
+ "287.png",
296
+ "288.jpeg",
297
+ "289.png",
298
+ "290.jpeg",
299
+ "291.png",
300
+ "292.png",
301
+ "293.png",
302
+ "294.jpeg",
303
+ "295.png",
304
+ "296.jpeg",
305
+ "297.png",
306
+ "298.jpeg",
307
+ "299.jpeg",
308
+ "300.jpeg",
309
+ "301.jpeg",
310
+ "302.png",
311
+ "303.png",
312
+ "304.jpeg",
313
+ "305.jpeg",
314
+ "306.jpeg",
315
+ "307.png",
316
+ "308.png",
317
+ "309.png",
318
+ "310.png",
319
+ "311.jpeg",
320
+ "312.png",
321
+ "313.png",
322
+ "314.png",
323
+ "315.png",
324
+ "316.png",
325
+ "317.png",
326
+ "318.png",
327
+ "319.png",
328
+ "320.png",
329
+ "321.png",
330
+ "322.png",
331
+ "323.png",
332
+ "324.jpeg",
333
+ "325.png",
334
+ "326.png",
335
+ "327.jpeg",
336
+ "328.png",
337
+ "329.png",
338
+ "330.png",
339
+ "331.jpeg",
340
+ "332.jpeg",
341
+ "333.png",
342
+ "334.png",
343
+ "335.png",
344
+ "336.png",
345
+ "337.png",
346
+ "338.jpeg",
347
+ "339.png",
348
+ "340.png",
349
+ "341.jpeg",
350
+ "342.png",
351
+ "343.jpeg",
352
+ "344.png",
353
+ "345.png",
354
+ "346.png",
355
+ "347.jpeg",
356
+ "348.jpeg",
357
+ "349.png",
358
+ "350.png",
359
+ "351.png",
360
+ "352.png",
361
+ "353.png",
362
+ "354.png",
363
+ "355.png",
364
+ "356.jpeg",
365
+ "357.png",
366
+ "358.png",
367
+ "359.png"
368
+ ]
369
+ }
370
+ };
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Avatarverse - Deterministic profile avatar library
3
+ * Same seed, same avatar. Every time.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ /**
8
+ * Cyrb53 hash for even distribution of seeds to avatar indices.
9
+ * @internal
10
+ */
11
+ export declare function cyrb53(str: string, seed?: number): number;
12
+ /**
13
+ * Get a deterministic avatar URL from a seed.
14
+ * Same seed always returns the same CDN URL.
15
+ *
16
+ * @param seed - Any string (username, email, ID)
17
+ * @param category - Avatar category (default: "voxel")
18
+ * @param total - Optional explicit numeric pool size (legacy mode uses .png URLs)
19
+ * @param tag - jsDelivr tag: "main" for latest, or "1.0.0" for pinned release
20
+ */
21
+ export declare function avatarUrl(seed: string, category?: string, total?: number, tag?: string): string;
22
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH;;;GAGG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,SAAI,GAAG,MAAM,CAWpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,QAAQ,SAAU,EAClB,KAAK,CAAC,EAAE,MAAM,EACd,GAAG,SAAS,GACX,MAAM,CAsBR"}
package/dist/index.js ADDED
@@ -0,0 +1,52 @@
1
+ /**
2
+ * Avatarverse - Deterministic profile avatar library
3
+ * Same seed, same avatar. Every time.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ import { AVATAR_MANIFEST } from "./avatar-manifest";
8
+ const CDN_BASE = "https://cdn.jsdelivr.net/gh/coppermare/avatarverse";
9
+ /**
10
+ * Cyrb53 hash for even distribution of seeds to avatar indices.
11
+ * @internal
12
+ */
13
+ export function cyrb53(str, seed = 0) {
14
+ let h1 = 0xdeadbeef ^ seed;
15
+ let h2 = 0x41c6ce57 ^ seed;
16
+ for (let i = 0; i < str.length; i++) {
17
+ const ch = str.charCodeAt(i);
18
+ h1 = Math.imul(h1 ^ ch, 2654435761);
19
+ h2 = Math.imul(h2 ^ ch, 1597334677);
20
+ }
21
+ h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507);
22
+ h2 = Math.imul(h2 ^ (h2 >>> 13), 3266489909);
23
+ return 4294967296 * (2097151 & h2) + (h1 >>> 0);
24
+ }
25
+ /**
26
+ * Get a deterministic avatar URL from a seed.
27
+ * Same seed always returns the same CDN URL.
28
+ *
29
+ * @param seed - Any string (username, email, ID)
30
+ * @param category - Avatar category (default: "voxel")
31
+ * @param total - Optional explicit numeric pool size (legacy mode uses .png URLs)
32
+ * @param tag - jsDelivr tag: "main" for latest, or "1.0.0" for pinned release
33
+ */
34
+ export function avatarUrl(seed, category = "voxel", total, tag = "main") {
35
+ if (!seed) {
36
+ throw new Error("avatarUrl: `seed` is required.");
37
+ }
38
+ const manifestEntry = AVATAR_MANIFEST[category];
39
+ const files = manifestEntry?.files ?? [];
40
+ if (typeof total === "number") {
41
+ if (!Number.isInteger(total) || total <= 0) {
42
+ throw new Error("avatarUrl: `total` must be a positive integer.");
43
+ }
44
+ const n = (cyrb53(seed) % total) + 1;
45
+ return `${CDN_BASE}@${tag}/avatars/${category}/${n}.png`;
46
+ }
47
+ if (files.length > 0) {
48
+ const filename = files[cyrb53(seed) % files.length];
49
+ return `${CDN_BASE}@${tag}/avatars/${category}/${filename}`;
50
+ }
51
+ return `${CDN_BASE}@${tag}/avatars/${category}/1.png`;
52
+ }
package/package.json ADDED
@@ -0,0 +1,67 @@
1
+ {
2
+ "name": "avatarsverse",
3
+ "version": "0.1.0",
4
+ "description": "Deterministic profile avatar library. Same seed, same avatar. Every time.",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "types": "./dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "import": "./dist/index.js",
11
+ "types": "./dist/index.d.ts"
12
+ }
13
+ },
14
+ "files": [
15
+ "dist",
16
+ "LICENSE",
17
+ "README.md"
18
+ ],
19
+ "scripts": {
20
+ "clean": "rm -rf dist",
21
+ "dev": "next dev",
22
+ "build": "next build",
23
+ "build:lib": "npm run clean && tsc -p tsconfig.lib.json",
24
+ "build:next": "next build",
25
+ "start": "next start",
26
+ "lint": "next lint",
27
+ "test": "vitest run",
28
+ "format": "prettier --write \"**/*.{ts,tsx,js,json,md}\"",
29
+ "prepublishOnly": "npm run generate-avatars && npm run build:lib",
30
+ "generate-avatars": "node scripts/generate-avatar-manifest.mjs"
31
+ },
32
+ "keywords": [
33
+ "avatar",
34
+ "profile-picture",
35
+ "deterministic",
36
+ "voxel",
37
+ "placeholder"
38
+ ],
39
+ "repository": {
40
+ "type": "git",
41
+ "url": "https://github.com/coppermare/avatarverse.git"
42
+ },
43
+ "bugs": {
44
+ "url": "https://github.com/coppermare/avatarverse/issues"
45
+ },
46
+ "homepage": "https://github.com/coppermare/avatarverse#readme",
47
+ "license": "MIT",
48
+ "author": "Kristi Kumrija",
49
+ "engines": {
50
+ "node": ">=18.0.0"
51
+ },
52
+ "devDependencies": {
53
+ "@types/node": "^22",
54
+ "@types/react": "^19",
55
+ "@types/react-dom": "^19",
56
+ "eslint": "^9",
57
+ "eslint-config-next": "15.1.11",
58
+ "next": "15.1.11",
59
+ "postcss": "^8",
60
+ "prettier": "^3.8.1",
61
+ "react": "^19.0.0",
62
+ "react-dom": "^19.0.0",
63
+ "tailwindcss": "^3.4.1",
64
+ "typescript": "^5",
65
+ "vitest": "^3.2.4"
66
+ }
67
+ }