@supersuit/artifacts 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.
Files changed (49) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/LICENSE +21 -0
  3. package/README.md +206 -0
  4. package/fonts/Newsreader-600.ttf +0 -0
  5. package/lib/artifacts/assets.d.ts +27 -0
  6. package/lib/artifacts/assets.js +63 -0
  7. package/lib/artifacts/auth.d.ts +1 -0
  8. package/lib/artifacts/auth.js +8 -0
  9. package/lib/artifacts/confidential.d.ts +47 -0
  10. package/lib/artifacts/confidential.js +39 -0
  11. package/lib/artifacts/door.d.ts +5 -0
  12. package/lib/artifacts/door.js +4 -0
  13. package/lib/artifacts/front-matter.d.ts +34 -0
  14. package/lib/artifacts/front-matter.js +37 -0
  15. package/lib/artifacts/index.d.ts +9 -0
  16. package/lib/artifacts/index.js +9 -0
  17. package/lib/artifacts/narration.d.ts +8 -0
  18. package/lib/artifacts/narration.js +85 -0
  19. package/lib/artifacts/reader.d.ts +54 -0
  20. package/lib/artifacts/reader.js +109 -0
  21. package/lib/artifacts/readers-store.d.ts +90 -0
  22. package/lib/artifacts/readers-store.js +141 -0
  23. package/lib/artifacts/render.d.ts +4 -0
  24. package/lib/artifacts/render.js +90 -0
  25. package/lib/artifacts/store.d.ts +52 -0
  26. package/lib/artifacts/store.js +114 -0
  27. package/lib/artifacts/unlock.d.ts +9 -0
  28. package/lib/artifacts/unlock.js +24 -0
  29. package/lib/brand/default-share.d.ts +5 -0
  30. package/lib/brand/default-share.js +37 -0
  31. package/lib/brand/index.d.ts +3 -0
  32. package/lib/brand/index.js +3 -0
  33. package/lib/brand/pack.d.ts +48 -0
  34. package/lib/brand/pack.js +17 -0
  35. package/lib/brand/share-card.d.ts +13 -0
  36. package/lib/brand/share-card.js +50 -0
  37. package/lib/brand/wrapper.d.ts +12 -0
  38. package/lib/brand/wrapper.js +13 -0
  39. package/lib/gate.d.ts +1 -0
  40. package/lib/gate.js +5 -0
  41. package/lib/index.d.ts +4 -0
  42. package/lib/index.js +4 -0
  43. package/lib/reader/artifact-reader.d.ts +14 -0
  44. package/lib/reader/artifact-reader.js +165 -0
  45. package/lib/reader/reader-watch.d.ts +7 -0
  46. package/lib/reader/reader-watch.js +125 -0
  47. package/lib/routes/artifacts.d.ts +115 -0
  48. package/lib/routes/artifacts.js +345 -0
  49. package/package.json +74 -0
package/package.json ADDED
@@ -0,0 +1,74 @@
1
+ {
2
+ "name": "@supersuit/artifacts",
3
+ "version": "0.1.0",
4
+ "description": "Publish markdown as branded, read-aloud pages from a Next.js app: the artifacts store, the route factory, the read-along reader, brand packs, password and confidential pages, and share cards.",
5
+ "license": "MIT",
6
+ "type": "module",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "git+https://github.com/SupersuitUp/artifacts.git"
10
+ },
11
+ "homepage": "https://github.com/SupersuitUp/artifacts#readme",
12
+ "bugs": "https://github.com/SupersuitUp/artifacts/issues",
13
+ "keywords": ["nextjs", "markdown", "publishing", "firestore", "read-aloud", "og-image"],
14
+ "main": "lib/index.js",
15
+ "types": "lib/index.d.ts",
16
+ "exports": {
17
+ ".": { "types": "./lib/index.d.ts", "default": "./lib/index.js" },
18
+ "./artifacts": { "types": "./lib/artifacts/index.d.ts", "default": "./lib/artifacts/index.js" },
19
+ "./routes": { "types": "./lib/routes/artifacts.d.ts", "default": "./lib/routes/artifacts.js" },
20
+ "./brand": { "types": "./lib/brand/index.d.ts", "default": "./lib/brand/index.js" },
21
+ "./reader": { "types": "./lib/reader/artifact-reader.d.ts", "default": "./lib/reader/artifact-reader.js" },
22
+ "./gate": { "types": "./lib/gate.d.ts", "default": "./lib/gate.js" },
23
+ "./fonts/*": "./fonts/*",
24
+ "./package.json": "./package.json"
25
+ },
26
+ "files": [
27
+ "lib",
28
+ "fonts",
29
+ "README.md",
30
+ "CHANGELOG.md",
31
+ "LICENSE"
32
+ ],
33
+ "sideEffects": false,
34
+ "scripts": {
35
+ "build": "rm -rf lib && tsc -p tsconfig.json",
36
+ "typecheck": "tsc -p tsconfig.json --noEmit",
37
+ "test": "vitest run",
38
+ "test:packed": "node scripts/check-packed.mjs",
39
+ "prepack": "npm run build"
40
+ },
41
+ "peerDependencies": {
42
+ "@google-cloud/storage": ">=7",
43
+ "firebase-admin": ">=13",
44
+ "next": ">=16",
45
+ "react": ">=19",
46
+ "react-dom": ">=19"
47
+ },
48
+ "peerDependenciesMeta": {
49
+ "@google-cloud/storage": { "optional": true }
50
+ },
51
+ "dependencies": {
52
+ "gray-matter": "^4.0.3",
53
+ "react-markdown": "^9.0.3",
54
+ "remark-gfm": "^4.0.1",
55
+ "remark-parse": "^11.0.0",
56
+ "unified": "^11.0.0"
57
+ },
58
+ "devDependencies": {
59
+ "@google-cloud/storage": "^7.22.0",
60
+ "@types/mdast": "^4.0.4",
61
+ "@types/node": "^22",
62
+ "@types/react": "^19.0.7",
63
+ "@types/react-dom": "^19.0.3",
64
+ "@vitejs/plugin-react": "^5.1.2",
65
+ "firebase-admin": "^13.7.0",
66
+ "jsdom": "^26",
67
+ "next": "^16.0.1",
68
+ "react": "^19.0.0",
69
+ "react-dom": "^19.0.0",
70
+ "typescript": "~5.9.0",
71
+ "vitest": "^4.0.18"
72
+ },
73
+ "engines": { "node": ">=20" }
74
+ }