modkit-server 0.0.0-stage → 1.0.0-beta.1

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 (51) hide show
  1. package/README.md +23 -2
  2. package/dist/adapters/classifiers.d.ts +45 -0
  3. package/dist/adapters/classifiers.d.ts.map +1 -0
  4. package/dist/adapters/classifiers.js +271 -0
  5. package/dist/adapters/classifiers.js.map +1 -0
  6. package/dist/adapters/notifiers.d.ts +34 -0
  7. package/dist/adapters/notifiers.d.ts.map +1 -0
  8. package/dist/adapters/notifiers.js +114 -0
  9. package/dist/adapters/notifiers.js.map +1 -0
  10. package/dist/adapters/storage.d.ts +15 -0
  11. package/dist/adapters/storage.d.ts.map +1 -0
  12. package/dist/adapters/storage.js +77 -0
  13. package/dist/adapters/storage.js.map +1 -0
  14. package/dist/auth.d.ts +43 -0
  15. package/dist/auth.d.ts.map +1 -0
  16. package/dist/auth.js +260 -0
  17. package/dist/auth.js.map +1 -0
  18. package/dist/cli.d.ts +18 -0
  19. package/dist/cli.d.ts.map +1 -0
  20. package/dist/cli.js +306 -0
  21. package/dist/cli.js.map +1 -0
  22. package/dist/conformance.d.ts +21 -0
  23. package/dist/conformance.d.ts.map +1 -0
  24. package/dist/conformance.js +188 -0
  25. package/dist/conformance.js.map +1 -0
  26. package/dist/errors.d.ts +7 -0
  27. package/dist/errors.d.ts.map +1 -0
  28. package/dist/errors.js +18 -0
  29. package/dist/errors.js.map +1 -0
  30. package/dist/index.d.ts +12 -0
  31. package/dist/index.d.ts.map +1 -0
  32. package/dist/index.js +12 -0
  33. package/dist/index.js.map +1 -0
  34. package/dist/memoryStore.d.ts +6 -0
  35. package/dist/memoryStore.d.ts.map +1 -0
  36. package/dist/memoryStore.js +332 -0
  37. package/dist/memoryStore.js.map +1 -0
  38. package/dist/postgresStore.d.ts +20 -0
  39. package/dist/postgresStore.d.ts.map +1 -0
  40. package/dist/postgresStore.js +457 -0
  41. package/dist/postgresStore.js.map +1 -0
  42. package/dist/server.d.ts +37 -0
  43. package/dist/server.d.ts.map +1 -0
  44. package/dist/server.js +322 -0
  45. package/dist/server.js.map +1 -0
  46. package/dist/store.d.ts +131 -0
  47. package/dist/store.d.ts.map +1 -0
  48. package/dist/store.js +19 -0
  49. package/dist/store.js.map +1 -0
  50. package/migrations/001_modkit_v1.sql +168 -0
  51. package/package.json +55 -4
@@ -0,0 +1,168 @@
1
+ -- ModKit v1 Postgres Schema Migration
2
+ -- Creates the `modkit` schema, tables, indexes, Row Level Security (RLS),
3
+ -- and SECURITY DEFINER visibility helper functions for App Store Guideline 1.2.
4
+
5
+ CREATE SCHEMA IF NOT EXISTS modkit;
6
+
7
+ -- 1. EULA / Terms acceptances
8
+ CREATE TABLE IF NOT EXISTS modkit.terms_acceptances (
9
+ user_id text NOT NULL,
10
+ terms_version text NOT NULL,
11
+ accepted_at timestamptz NOT NULL DEFAULT now(),
12
+ PRIMARY KEY (user_id, terms_version)
13
+ );
14
+
15
+ -- 2. User-to-user blocks
16
+ CREATE TABLE IF NOT EXISTS modkit.blocks (
17
+ blocker_id text NOT NULL,
18
+ blocked_id text NOT NULL,
19
+ created_at timestamptz NOT NULL DEFAULT now(),
20
+ PRIMARY KEY (blocker_id, blocked_id),
21
+ CHECK (blocker_id <> blocked_id)
22
+ );
23
+
24
+ -- 3. User bans (enforced globally)
25
+ CREATE TABLE IF NOT EXISTS modkit.bans (
26
+ user_id text PRIMARY KEY,
27
+ reason text NOT NULL,
28
+ banned_by text,
29
+ created_at timestamptz NOT NULL DEFAULT now(),
30
+ expires_at timestamptz
31
+ );
32
+
33
+ -- 4. Content moderation status (populated by classifier webhook or reports)
34
+ CREATE TABLE IF NOT EXISTS modkit.items (
35
+ target_type text NOT NULL,
36
+ target_id text NOT NULL,
37
+ author_id text NOT NULL,
38
+ status text NOT NULL DEFAULT 'pending'
39
+ CHECK (status IN ('pending', 'approved', 'rejected', 'flagged')),
40
+ classifier_provider text,
41
+ classifier_categories jsonb NOT NULL DEFAULT '{}'::jsonb,
42
+ classifier_scores jsonb NOT NULL DEFAULT '{}'::jsonb,
43
+ created_at timestamptz NOT NULL DEFAULT now(),
44
+ updated_at timestamptz NOT NULL DEFAULT now(),
45
+ PRIMARY KEY (target_type, target_id)
46
+ );
47
+
48
+ -- 5. User-submitted content reports
49
+ CREATE TABLE IF NOT EXISTS modkit.reports (
50
+ id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
51
+ reporter_id text NOT NULL,
52
+ target_type text NOT NULL,
53
+ target_id text NOT NULL,
54
+ target_author_id text,
55
+ reason text NOT NULL
56
+ CHECK (reason IN ('objectionable', 'spam', 'harassment', 'unsafe', 'other')),
57
+ details text,
58
+ status text NOT NULL DEFAULT 'open'
59
+ CHECK (status IN ('open', 'actioned', 'dismissed')),
60
+ resolution_note text,
61
+ resolved_by text,
62
+ created_at timestamptz NOT NULL DEFAULT now(),
63
+ resolved_at timestamptz
64
+ );
65
+
66
+ -- Indexes for fast RLS visibility lookups and operator triage
67
+ CREATE INDEX IF NOT EXISTS idx_blocks_blocked
68
+ ON modkit.blocks (blocked_id);
69
+
70
+ CREATE INDEX IF NOT EXISTS idx_bans_user_expires
71
+ ON modkit.bans (user_id, expires_at);
72
+
73
+ CREATE INDEX IF NOT EXISTS idx_items_author
74
+ ON modkit.items (author_id, status);
75
+
76
+ CREATE INDEX IF NOT EXISTS idx_items_status_updated
77
+ ON modkit.items (status, updated_at DESC);
78
+
79
+ CREATE INDEX IF NOT EXISTS idx_reports_reporter_target
80
+ ON modkit.reports (reporter_id, target_type, target_id);
81
+
82
+ CREATE INDEX IF NOT EXISTS idx_reports_target
83
+ ON modkit.reports (target_type, target_id);
84
+
85
+ CREATE INDEX IF NOT EXISTS idx_reports_status_created
86
+ ON modkit.reports (status, created_at DESC);
87
+
88
+ -- Enable Row Level Security on every table in modkit (deny-by-default for public/anon/authenticated roles)
89
+ ALTER TABLE modkit.terms_acceptances ENABLE ROW LEVEL SECURITY;
90
+ ALTER TABLE modkit.blocks ENABLE ROW LEVEL SECURITY;
91
+ ALTER TABLE modkit.bans ENABLE ROW LEVEL SECURITY;
92
+ ALTER TABLE modkit.items ENABLE ROW LEVEL SECURITY;
93
+ ALTER TABLE modkit.reports ENABLE ROW LEVEL SECURITY;
94
+
95
+ -- SQL Helper Functions (SECURITY DEFINER) for Host App RLS policies
96
+
97
+ -- True if user_id has an active (non-expired) ban
98
+ CREATE OR REPLACE FUNCTION modkit.is_banned(check_user_id text)
99
+ RETURNS boolean
100
+ LANGUAGE sql STABLE SECURITY DEFINER SET search_path = modkit, public AS $$
101
+ SELECT CASE
102
+ WHEN check_user_id IS NULL THEN false
103
+ ELSE EXISTS (
104
+ SELECT 1 FROM modkit.bans b
105
+ WHERE b.user_id = check_user_id
106
+ AND (b.expires_at IS NULL OR b.expires_at > now())
107
+ )
108
+ END;
109
+ $$;
110
+
111
+ -- True if viewer_id has blocked author_id
112
+ CREATE OR REPLACE FUNCTION modkit.is_blocked(viewer_id text, author_id text)
113
+ RETURNS boolean
114
+ LANGUAGE sql STABLE SECURITY DEFINER SET search_path = modkit, public AS $$
115
+ SELECT CASE
116
+ WHEN viewer_id IS NULL OR author_id IS NULL THEN false
117
+ ELSE EXISTS (
118
+ SELECT 1 FROM modkit.blocks bl
119
+ WHERE bl.blocker_id = viewer_id AND bl.blocked_id = author_id
120
+ )
121
+ END;
122
+ $$;
123
+
124
+ -- Master visibility check for content rows.
125
+ -- mode = 'post': visible unless rejected/flagged (or viewer is author of pending item).
126
+ -- mode = 'pre': visible only if approved (or viewer is author and item is pending/approved).
127
+ CREATE OR REPLACE FUNCTION modkit.is_visible(
128
+ viewer_id text,
129
+ author_id text,
130
+ p_target_type text,
131
+ p_target_id text,
132
+ mode text DEFAULT 'post'
133
+ )
134
+ RETURNS boolean
135
+ LANGUAGE sql STABLE SECURITY DEFINER SET search_path = modkit, public AS $$
136
+ SELECT
137
+ NOT modkit.is_banned(author_id)
138
+ AND NOT modkit.is_blocked(viewer_id, author_id)
139
+ AND NOT EXISTS (
140
+ SELECT 1 FROM modkit.reports r
141
+ WHERE viewer_id IS NOT NULL
142
+ AND r.reporter_id = viewer_id
143
+ AND r.target_type = p_target_type
144
+ AND r.target_id = p_target_id
145
+ )
146
+ AND COALESCE(
147
+ (
148
+ SELECT CASE
149
+ WHEN i.status IN ('rejected', 'flagged') THEN false
150
+ WHEN i.status = 'approved' THEN true
151
+ WHEN i.status = 'pending' THEN (mode = 'post' OR (viewer_id IS NOT NULL AND viewer_id = author_id))
152
+ ELSE false
153
+ END
154
+ FROM modkit.items i
155
+ WHERE i.target_type = p_target_type AND i.target_id = p_target_id
156
+ ),
157
+ (mode = 'post' OR (viewer_id IS NOT NULL AND viewer_id = author_id))
158
+ );
159
+ $$;
160
+
161
+ -- Allow host table RLS policies executed by non-superuser roles (e.g. Supabase `authenticated`/`anon`)
162
+ -- to invoke the SECURITY DEFINER helper functions while keeping direct table access locked down.
163
+ GRANT USAGE ON SCHEMA modkit TO PUBLIC;
164
+ REVOKE ALL ON ALL TABLES IN SCHEMA modkit FROM PUBLIC;
165
+ GRANT EXECUTE ON FUNCTION modkit.is_banned(text) TO PUBLIC;
166
+ GRANT EXECUTE ON FUNCTION modkit.is_blocked(text, text) TO PUBLIC;
167
+ GRANT EXECUTE ON FUNCTION modkit.is_visible(text, text, text, text, text) TO PUBLIC;
168
+
package/package.json CHANGED
@@ -1,6 +1,57 @@
1
1
  {
2
2
  "name": "modkit-server",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "1.0.0-beta.1",
4
+ "description": "Self-hosted /v1 server handler, content moderation classifiers, notification sinks, Postgres store, and CLI for ModKit (App Store Guideline 1.2).",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "types": "./dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "default": "./dist/index.js"
12
+ }
13
+ },
14
+ "bin": {
15
+ "modkit": "dist/cli.js",
16
+ "modkit-server": "dist/cli.js"
17
+ },
18
+ "files": [
19
+ "dist",
20
+ "migrations"
21
+ ],
22
+ "scripts": {
23
+ "build": "tsc -p tsconfig.build.json",
24
+ "prepack": "npm run build",
25
+ "test": "npm run build && node --test --experimental-strip-types tests/*.test.ts",
26
+ "typecheck": "tsc --noEmit"
27
+ },
28
+ "engines": {
29
+ "node": ">=22"
30
+ },
31
+ "repository": {
32
+ "type": "git",
33
+ "url": "git+https://github.com/Liampronan/ModKit.git",
34
+ "directory": "server"
35
+ },
36
+ "homepage": "https://github.com/Liampronan/ModKit#readme",
37
+ "bugs": {
38
+ "url": "https://github.com/Liampronan/ModKit/issues"
39
+ },
40
+ "author": "Liam Ronan",
41
+ "keywords": [
42
+ "moderation",
43
+ "ugc",
44
+ "app-store-guideline-1-2",
45
+ "supabase",
46
+ "swift",
47
+ "modkit"
48
+ ],
49
+ "license": "MIT",
50
+ "devDependencies": {
51
+ "@types/node": "^22.15.3",
52
+ "typescript": "^5.8.3"
53
+ },
54
+ "dependencies": {
55
+ "postgres": "^3.4.9"
56
+ }
57
+ }