@pgpm/reserved-names 0.0.0-stage → 0.47.5

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Constructive
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Makefile

@@ -0,0 +1,6 @@
+EXTENSION = pgpm-reserved-names
+DATA = sql/pgpm-reserved-names--0.47.5.sql
+
+PG_CONFIG = pg_config
+PGXS := $(shell $(PG_CONFIG) --pgxs)
+include $(PGXS)

package/README.md

@@ -1,3 +1,82 @@
-# Temporary Holding Version
+# @pgpm/reserved-names
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/constructive-io/pgpm-modules/actions/workflows/ci.yml">
+    <img height="20" src="https://github.com/constructive-io/pgpm-modules/actions/workflows/ci.yml/badge.svg" />
+  </a>
+   <a href="https://github.com/constructive-io/pgpm-modules/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+   <a href="https://www.npmjs.com/package/@pgpm/reserved-names"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/pgpm-modules?filename=packages%2Freserved-names%2Fpackage.json"/></a>
+</p>
+
+Reserved names that nobody may claim — subdomains, usernames, slugs, or any other kind — kept as rows and checked live by one function.
+
+## Overview
+
+`@pgpm/reserved-names` keeps one shared list, as tables, and callers check it live at the moment someone claims a name. A new entry takes effect at once for every caller, with no regeneration or redeploy of the callers.
+
+| table | what it holds |
+| --- | --- |
+| `reserved_names.kinds` | categories of name: `subdomain`, `username`, `domain`, `slug` (add more with a migration) |
+| `reserved_names.reasons` | why a name is reserved: `platform`, `brand`, `lookalike`, `abuse` |
+| `reserved_names.names` | the entries: `kind`, `name` (lowercase), `match` (`exact` / `prefix` / `suffix`), `reason` |
+
+Every entry must point at a real kind and reason (foreign keys), so a typo cannot quietly create an empty category. The primary key is `(kind, name, match)`.
+
+The starter data, in fixtures, is the four kinds and four reasons plus a `subdomain` list: hostnames a visitor would read as the platform's own under a shared domain (`login`, `admin`, `www`, `mail`, `ns1`, …), and a `xn--` prefix entry that blocks punycode lookalikes (`аpple` with a Cyrillic `а`). The other kinds start empty.
+
+## Installation
+
+```bash
+pgpm install @pgpm/reserved-names
+pgpm deploy
+```
+
+## Usage
+
+```sql
+SELECT reserved_names.is_reserved('subdomain', 'login');        -- true
+SELECT reserved_names.is_reserved('subdomain', 'LOGIN');        -- true (case-insensitive)
+SELECT reserved_names.is_reserved('subdomain', 'xn--pple-43d'); -- true (prefix entry)
+SELECT reserved_names.is_reserved('subdomain', 'mystore');      -- false
+SELECT reserved_names.is_reserved('username', 'login');         -- false (kinds are separate)
+
+SELECT name, match, reason FROM reserved_names.reserved_by('subdomain', 'xn--pple-43d');
+--  xn-- | prefix | lookalike
+```
+
+- `is_reserved(kind, name) RETURNS boolean`: true when any entry matches.
+- `reserved_by(kind, name) RETURNS SETOF reserved_names.names`: the matching entries, so an error can say why.
+
+Both are `STABLE` SQL, lowercase `kind` and `name` before comparing, and treat `NULL` as not reserved. Matching:
+
+- `exact`: the name itself.
+- `prefix`: every name starting with it (`xn--`, `staff-`).
+- `suffix`: every name ending with it. `.example.com` blocks `shop.example.com`, but not `example.com` itself (add an `exact` entry for that) and not `notexample.com`.
+
+### Adding names
+
+The list changes only through migrations. Add a pgpm fixture change that inserts rows:
+
+```sql
+INSERT INTO reserved_names.names (kind, name, match, reason) VALUES
+  ('subdomain', 'www2', 'exact', 'platform'),
+  ('subdomain', 'staff-', 'prefix', 'platform'),
+  ('domain', '.example.com', 'suffix', 'brand'),
+  ('username', 'support', 'exact', 'platform');
+```
+
+A new category or reason is a row in `kinds` or `reasons` first.
+
+## Access
+
+Everyone can read the three tables and call both functions, so a UI can say "that name is reserved" before submitting. The list is public, so there is no row-level security. No role is granted `INSERT`, `UPDATE` or `DELETE`: only the owner (migrations, or a `SECURITY DEFINER` function it owns) can change it.
+
+## Testing
+
+```bash
+pnpm test
+```

package/deploy/schemas/reserved_names/procedures/is_reserved.sql

@@ -0,0 +1,16 @@
+-- Deploy schemas/reserved_names/procedures/is_reserved to pg
+
+-- requires: schemas/reserved_names/schema
+-- requires: schemas/reserved_names/procedures/reserved_by
+
+BEGIN;
+
+CREATE FUNCTION reserved_names.is_reserved(kind text, name text) RETURNS boolean AS $$
+  SELECT EXISTS (SELECT 1 FROM reserved_names.reserved_by(is_reserved.kind, is_reserved.name));
+$$ LANGUAGE sql STABLE;
+
+COMMENT ON FUNCTION reserved_names.is_reserved(text, text) IS 'True when name (any case) is reserved for kind';
+
+GRANT EXECUTE ON FUNCTION reserved_names.is_reserved(text, text) TO public;
+
+COMMIT;

package/deploy/schemas/reserved_names/procedures/reserved_by.sql

@@ -0,0 +1,23 @@
+-- Deploy schemas/reserved_names/procedures/reserved_by to pg
+
+-- requires: schemas/reserved_names/schema
+-- requires: schemas/reserved_names/tables/names/table
+
+BEGIN;
+
+CREATE FUNCTION reserved_names.reserved_by(kind text, name text) RETURNS SETOF reserved_names.names AS $$
+  SELECT n.*
+    FROM reserved_names.names n
+   WHERE n.kind = pg_catalog.lower(reserved_by.kind)
+     AND CASE n.match
+           WHEN 'exact'  THEN n.name = pg_catalog.lower(reserved_by.name)
+           WHEN 'prefix' THEN pg_catalog.starts_with(pg_catalog.lower(reserved_by.name), n.name)
+           WHEN 'suffix' THEN pg_catalog.right(pg_catalog.lower(reserved_by.name), pg_catalog.length(n.name)) = n.name
+         END;
+$$ LANGUAGE sql STABLE;
+
+COMMENT ON FUNCTION reserved_names.reserved_by(text, text) IS 'The entries (with their reason) that reserve name for kind; empty when it is free';
+
+GRANT EXECUTE ON FUNCTION reserved_names.reserved_by(text, text) TO public;
+
+COMMIT;

package/deploy/schemas/reserved_names/schema.sql

@@ -0,0 +1,9 @@
+-- Deploy schemas/reserved_names/schema to pg
+
+BEGIN;
+
+CREATE SCHEMA reserved_names;
+
+GRANT USAGE ON SCHEMA reserved_names TO public;
+
+COMMIT;

package/deploy/schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture.sql

@@ -0,0 +1,14 @@
+-- Deploy schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture to pg
+
+-- requires: schemas/reserved_names/schema
+-- requires: schemas/reserved_names/tables/kinds/table
+
+BEGIN;
+
+INSERT INTO reserved_names.kinds (kind, description) VALUES
+  ('subdomain', 'A label under a shared domain, like login in login.example.com'),
+  ('username', 'A person''s handle'),
+  ('domain', 'A whole domain name, like example.com'),
+  ('slug', 'A name in a URL path, like an organization or app slug');
+
+COMMIT;

package/deploy/schemas/reserved_names/tables/kinds/table.sql

@@ -0,0 +1,16 @@
+-- Deploy schemas/reserved_names/tables/kinds/table to pg
+
+-- requires: schemas/reserved_names/schema
+
+BEGIN;
+
+CREATE TABLE reserved_names.kinds (
+  kind text PRIMARY KEY CHECK (kind ~ '^[a-z][a-z0-9_]*$'),
+  description text NOT NULL
+);
+
+COMMENT ON TABLE reserved_names.kinds IS 'Categories of names that can be reserved: subdomain, username, domain, slug, ...';
+
+GRANT SELECT ON TABLE reserved_names.kinds TO public;
+
+COMMIT;

package/deploy/schemas/reserved_names/tables/names/fixtures/1792800000002_fixture.sql

@@ -0,0 +1,72 @@
+-- Deploy schemas/reserved_names/tables/names/fixtures/1792800000002_fixture to pg
+
+-- requires: schemas/reserved_names/schema
+-- requires: schemas/reserved_names/tables/names/table
+-- requires: schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture
+-- requires: schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture
+
+BEGIN;
+
+INSERT INTO reserved_names.names (kind, name, match, reason) VALUES
+  ('subdomain', 'www', 'exact', 'platform'),
+  ('subdomain', 'api', 'exact', 'platform'),
+  ('subdomain', 'auth', 'exact', 'platform'),
+  ('subdomain', 'login', 'exact', 'platform'),
+  ('subdomain', 'logout', 'exact', 'platform'),
+  ('subdomain', 'signin', 'exact', 'platform'),
+  ('subdomain', 'signup', 'exact', 'platform'),
+  ('subdomain', 'register', 'exact', 'platform'),
+  ('subdomain', 'admin', 'exact', 'platform'),
+  ('subdomain', 'administrator', 'exact', 'platform'),
+  ('subdomain', 'root', 'exact', 'platform'),
+  ('subdomain', 'app', 'exact', 'platform'),
+  ('subdomain', 'apps', 'exact', 'platform'),
+  ('subdomain', 'dashboard', 'exact', 'platform'),
+  ('subdomain', 'console', 'exact', 'platform'),
+  ('subdomain', 'account', 'exact', 'platform'),
+  ('subdomain', 'accounts', 'exact', 'platform'),
+  ('subdomain', 'billing', 'exact', 'platform'),
+  ('subdomain', 'pay', 'exact', 'platform'),
+  ('subdomain', 'payments', 'exact', 'platform'),
+  ('subdomain', 'checkout', 'exact', 'platform'),
+  ('subdomain', 'support', 'exact', 'platform'),
+  ('subdomain', 'help', 'exact', 'platform'),
+  ('subdomain', 'status', 'exact', 'platform'),
+  ('subdomain', 'docs', 'exact', 'platform'),
+  ('subdomain', 'mail', 'exact', 'platform'),
+  ('subdomain', 'email', 'exact', 'platform'),
+  ('subdomain', 'smtp', 'exact', 'platform'),
+  ('subdomain', 'imap', 'exact', 'platform'),
+  ('subdomain', 'ftp', 'exact', 'platform'),
+  ('subdomain', 'ns', 'exact', 'platform'),
+  ('subdomain', 'ns1', 'exact', 'platform'),
+  ('subdomain', 'ns2', 'exact', 'platform'),
+  ('subdomain', 'mx', 'exact', 'platform'),
+  ('subdomain', 'cdn', 'exact', 'platform'),
+  ('subdomain', 'static', 'exact', 'platform'),
+  ('subdomain', 'assets', 'exact', 'platform'),
+  ('subdomain', 'files', 'exact', 'platform'),
+  ('subdomain', 'storage', 'exact', 'platform'),
+  ('subdomain', 'media', 'exact', 'platform'),
+  ('subdomain', 'ws', 'exact', 'platform'),
+  ('subdomain', 'wss', 'exact', 'platform'),
+  ('subdomain', 'graphql', 'exact', 'platform'),
+  ('subdomain', 'modules', 'exact', 'platform'),
+  ('subdomain', 'agent', 'exact', 'platform'),
+  ('subdomain', 'compute', 'exact', 'platform'),
+  ('subdomain', 'machines', 'exact', 'platform'),
+  ('subdomain', 'cluster', 'exact', 'platform'),
+  ('subdomain', 'migrate', 'exact', 'platform'),
+  ('subdomain', 'internal', 'exact', 'platform'),
+  ('subdomain', 'system', 'exact', 'platform'),
+  ('subdomain', 'platform', 'exact', 'platform'),
+  ('subdomain', 'security', 'exact', 'platform'),
+  ('subdomain', 'sso', 'exact', 'platform'),
+  ('subdomain', 'oauth', 'exact', 'platform'),
+  ('subdomain', 'id', 'exact', 'platform'),
+  ('subdomain', 'identity', 'exact', 'platform'),
+  ('subdomain', 'verify', 'exact', 'platform'),
+  ('subdomain', 'secure', 'exact', 'platform'),
+  ('subdomain', 'xn--', 'prefix', 'lookalike');
+
+COMMIT;

package/deploy/schemas/reserved_names/tables/names/indexes/names_reason_idx.sql

@@ -0,0 +1,10 @@
+-- Deploy schemas/reserved_names/tables/names/indexes/names_reason_idx to pg
+
+-- requires: schemas/reserved_names/schema
+-- requires: schemas/reserved_names/tables/names/table
+
+BEGIN;
+
+CREATE INDEX names_reason_idx ON reserved_names.names (reason);
+
+COMMIT;

package/deploy/schemas/reserved_names/tables/names/table.sql

@@ -0,0 +1,23 @@
+-- Deploy schemas/reserved_names/tables/names/table to pg
+
+-- requires: schemas/reserved_names/schema
+-- requires: schemas/reserved_names/tables/kinds/table
+-- requires: schemas/reserved_names/tables/reasons/table
+
+BEGIN;
+
+CREATE TABLE reserved_names.names (
+  kind text NOT NULL REFERENCES reserved_names.kinds (kind),
+  name text NOT NULL CHECK (name <> '' AND name = lower(name)),
+  match text NOT NULL DEFAULT 'exact' CHECK (match IN ('exact', 'prefix', 'suffix')),
+  reason text NOT NULL REFERENCES reserved_names.reasons (reason),
+  PRIMARY KEY (kind, name, match)
+);
+
+COMMENT ON TABLE reserved_names.names IS 'Names nobody may claim, by kind. Changed only by migrations.';
+COMMENT ON COLUMN reserved_names.names.name IS 'The reserved name, lowercase';
+COMMENT ON COLUMN reserved_names.names.match IS 'exact: the name itself; prefix: every name starting with it; suffix: every name ending with it';
+
+GRANT SELECT ON TABLE reserved_names.names TO public;
+
+COMMIT;

package/deploy/schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture.sql

@@ -0,0 +1,14 @@
+-- Deploy schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture to pg
+
+-- requires: schemas/reserved_names/schema
+-- requires: schemas/reserved_names/tables/reasons/table
+
+BEGIN;
+
+INSERT INTO reserved_names.reasons (reason, description) VALUES
+  ('platform', 'Reads as the platform''s own (login, admin, status, ...)'),
+  ('brand', 'Our brand or product names'),
+  ('lookalike', 'Can be made to look like another name, e.g. punycode'),
+  ('abuse', 'Offensive or used for abuse');
+
+COMMIT;

package/deploy/schemas/reserved_names/tables/reasons/table.sql

@@ -0,0 +1,16 @@
+-- Deploy schemas/reserved_names/tables/reasons/table to pg
+
+-- requires: schemas/reserved_names/schema
+
+BEGIN;
+
+CREATE TABLE reserved_names.reasons (
+  reason text PRIMARY KEY CHECK (reason ~ '^[a-z][a-z0-9_]*$'),
+  description text NOT NULL
+);
+
+COMMENT ON TABLE reserved_names.reasons IS 'Why a name is reserved: platform, brand, lookalike, abuse, ...';
+
+GRANT SELECT ON TABLE reserved_names.reasons TO public;
+
+COMMIT;

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@pgpm/reserved-names",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.47.5",
+  "description": "Reserved names (subdomains, usernames, domains, slugs, ...) that nobody may claim, as tables checked live by reserved_names.is_reserved(kind, name)",
+  "author": "Dan Lynch <pyramation@gmail.com>",
+  "contributors": [
+    "Constructive <developers@constructive.io>"
+  ],
+  "keywords": [
+    "postgresql",
+    "pgpm",
+    "reserved",
+    "names",
+    "subdomains"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "bundle": "pgpm package",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@pgpm/verify": "0.47.1"
+  },
+  "devDependencies": {
+    "pgpm": "^5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/constructive-io/pgpm-modules"
+  },
+  "homepage": "https://github.com/constructive-io/pgpm-modules",
+  "bugs": {
+    "url": "https://github.com/constructive-io/pgpm-modules/issues"
+  },
+  "gitHead": "6b16b597af00c20dc2ca9b21c15bda69b4ce1186"
+}

package/pgpm-reserved-names.control

@@ -0,0 +1,7 @@
+# pgpm-reserved-names extension
+comment = 'pgpm-reserved-names extension'
+default_version = '0.47.5'
+module_pathname = '$libdir/pgpm-reserved-names'
+requires = 'plpgsql,pgpm-verify'
+relocatable = false
+superuser = false

package/pgpm.plan

@@ -0,0 +1,14 @@
+%syntax-version=1.0.0
+%project=pgpm-reserved-names
+%uri=pgpm-reserved-names
+
+schemas/reserved_names/schema [pgpm-verify:procedures/assert_function] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/schema
+schemas/reserved_names/tables/kinds/table [schemas/reserved_names/schema] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/tables/kinds/table
+schemas/reserved_names/tables/reasons/table [schemas/reserved_names/schema] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/tables/reasons/table
+schemas/reserved_names/tables/names/table [schemas/reserved_names/schema schemas/reserved_names/tables/kinds/table schemas/reserved_names/tables/reasons/table] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/tables/names/table
+schemas/reserved_names/tables/names/indexes/names_reason_idx [schemas/reserved_names/schema schemas/reserved_names/tables/names/table] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/tables/names/indexes/names_reason_idx
+schemas/reserved_names/procedures/reserved_by [schemas/reserved_names/schema schemas/reserved_names/tables/names/table] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/procedures/reserved_by
+schemas/reserved_names/procedures/is_reserved [schemas/reserved_names/schema schemas/reserved_names/procedures/reserved_by] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/procedures/is_reserved
+schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture [schemas/reserved_names/schema schemas/reserved_names/tables/kinds/table] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture
+schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture [schemas/reserved_names/schema schemas/reserved_names/tables/reasons/table] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture
+schemas/reserved_names/tables/names/fixtures/1792800000002_fixture [schemas/reserved_names/schema schemas/reserved_names/tables/names/table schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture] 2026-10-22T19:40:00Z devin <devin@cognition.ai> # add schemas/reserved_names/tables/names/fixtures/1792800000002_fixture

package/revert/schemas/reserved_names/procedures/is_reserved.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/procedures/is_reserved from pg
+
+BEGIN;
+
+DROP FUNCTION reserved_names.is_reserved(text, text);
+
+COMMIT;

package/revert/schemas/reserved_names/procedures/reserved_by.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/procedures/reserved_by from pg
+
+BEGIN;
+
+DROP FUNCTION reserved_names.reserved_by(text, text);
+
+COMMIT;

package/revert/schemas/reserved_names/schema.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/schema from pg
+
+BEGIN;
+
+DROP SCHEMA reserved_names;
+
+COMMIT;

package/revert/schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture from pg
+
+BEGIN;
+
+DELETE FROM reserved_names.kinds WHERE kind IN ('subdomain', 'username', 'domain', 'slug');
+
+COMMIT;

package/revert/schemas/reserved_names/tables/kinds/table.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/tables/kinds/table from pg
+
+BEGIN;
+
+DROP TABLE reserved_names.kinds;
+
+COMMIT;

package/revert/schemas/reserved_names/tables/names/fixtures/1792800000002_fixture.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/tables/names/fixtures/1792800000002_fixture from pg
+
+BEGIN;
+
+DELETE FROM reserved_names.names WHERE kind = 'subdomain';
+
+COMMIT;

package/revert/schemas/reserved_names/tables/names/indexes/names_reason_idx.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/tables/names/indexes/names_reason_idx from pg
+
+BEGIN;
+
+DROP INDEX reserved_names.names_reason_idx;
+
+COMMIT;

package/revert/schemas/reserved_names/tables/names/table.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/tables/names/table from pg
+
+BEGIN;
+
+DROP TABLE reserved_names.names;
+
+COMMIT;

package/revert/schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture from pg
+
+BEGIN;
+
+DELETE FROM reserved_names.reasons WHERE reason IN ('platform', 'brand', 'lookalike', 'abuse');
+
+COMMIT;

package/revert/schemas/reserved_names/tables/reasons/table.sql

@@ -0,0 +1,7 @@
+-- Revert schemas/reserved_names/tables/reasons/table from pg
+
+BEGIN;
+
+DROP TABLE reserved_names.reasons;
+
+COMMIT;

package/sql/pgpm-reserved-names--0.47.5.sql

@@ -0,0 +1,157 @@
+\echo Use "CREATE EXTENSION pgpm-reserved-names" to load this file. \quit
+CREATE SCHEMA reserved_names;
+
+GRANT USAGE ON SCHEMA reserved_names TO PUBLIC;
+
+CREATE TABLE reserved_names.kinds (
+  kind text PRIMARY KEY CHECK (kind ~ '^[a-z][a-z0-9_]*$'),
+  description text NOT NULL
+);
+
+COMMENT ON TABLE reserved_names.kinds IS 'Categories of names that can be reserved: subdomain, username, domain, slug, ...';
+
+GRANT SELECT ON reserved_names.kinds TO PUBLIC;
+
+CREATE TABLE reserved_names.reasons (
+  reason text PRIMARY KEY CHECK (reason ~ '^[a-z][a-z0-9_]*$'),
+  description text NOT NULL
+);
+
+COMMENT ON TABLE reserved_names.reasons IS 'Why a name is reserved: platform, brand, lookalike, abuse, ...';
+
+GRANT SELECT ON reserved_names.reasons TO PUBLIC;
+
+CREATE TABLE reserved_names.names (
+  kind text NOT NULL REFERENCES reserved_names.kinds (kind),
+  name text NOT NULL CHECK (
+    name <> ''
+      AND name = lower(name)
+  ),
+  match text NOT NULL DEFAULT 'exact' CHECK (match IN ('exact', 'prefix', 'suffix')),
+  reason text NOT NULL REFERENCES reserved_names.reasons (reason),
+  PRIMARY KEY (kind, name, match)
+);
+
+COMMENT ON TABLE reserved_names.names IS 'Names nobody may claim, by kind. Changed only by migrations.';
+
+COMMENT ON COLUMN reserved_names.names.name IS 'The reserved name, lowercase';
+
+COMMENT ON COLUMN reserved_names.names.match IS 'exact: the name itself; prefix: every name starting with it; suffix: every name ending with it';
+
+GRANT SELECT ON reserved_names.names TO PUBLIC;
+
+CREATE INDEX names_reason_idx ON reserved_names.names (reason);
+
+CREATE FUNCTION reserved_names.reserved_by(
+  kind text,
+  name text
+) RETURNS SETOF reserved_names.names AS $EOFCODE$
+  SELECT n.*
+    FROM reserved_names.names n
+   WHERE n.kind = pg_catalog.lower(reserved_by.kind)
+     AND CASE n.match
+           WHEN 'exact'  THEN n.name = pg_catalog.lower(reserved_by.name)
+           WHEN 'prefix' THEN pg_catalog.starts_with(pg_catalog.lower(reserved_by.name), n.name)
+           WHEN 'suffix' THEN pg_catalog.right(pg_catalog.lower(reserved_by.name), pg_catalog.length(n.name)) = n.name
+         END;
+$EOFCODE$ LANGUAGE sql STABLE;
+
+COMMENT ON FUNCTION reserved_names.reserved_by(text, text) IS 'The entries (with their reason) that reserve name for kind; empty when it is free';
+
+GRANT EXECUTE ON FUNCTION reserved_names.reserved_by(text, text) TO PUBLIC;
+
+CREATE FUNCTION reserved_names.is_reserved(
+  kind text,
+  name text
+) RETURNS boolean AS $EOFCODE$
+  SELECT EXISTS (SELECT 1 FROM reserved_names.reserved_by(is_reserved.kind, is_reserved.name));
+$EOFCODE$ LANGUAGE sql STABLE;
+
+COMMENT ON FUNCTION reserved_names.is_reserved(text, text) IS 'True when name (any case) is reserved for kind';
+
+GRANT EXECUTE ON FUNCTION reserved_names.is_reserved(text, text) TO PUBLIC;
+
+INSERT INTO reserved_names.kinds (
+  kind,
+  description
+) VALUES
+  ('subdomain', 'A label under a shared domain, like login in login.example.com'),
+  ('username', 'A person''s handle'),
+  ('domain', 'A whole domain name, like example.com'),
+  ('slug', 'A name in a URL path, like an organization or app slug');
+
+INSERT INTO reserved_names.reasons (
+  reason,
+  description
+) VALUES
+  ('platform', 'Reads as the platform''s own (login, admin, status, ...)'),
+  ('brand', 'Our brand or product names'),
+  ('lookalike', 'Can be made to look like another name, e.g. punycode'),
+  ('abuse', 'Offensive or used for abuse');
+
+INSERT INTO reserved_names.names (
+  kind,
+  name,
+  match,
+  reason
+) VALUES
+  ('subdomain', 'www', 'exact', 'platform'),
+  ('subdomain', 'api', 'exact', 'platform'),
+  ('subdomain', 'auth', 'exact', 'platform'),
+  ('subdomain', 'login', 'exact', 'platform'),
+  ('subdomain', 'logout', 'exact', 'platform'),
+  ('subdomain', 'signin', 'exact', 'platform'),
+  ('subdomain', 'signup', 'exact', 'platform'),
+  ('subdomain', 'register', 'exact', 'platform'),
+  ('subdomain', 'admin', 'exact', 'platform'),
+  ('subdomain', 'administrator', 'exact', 'platform'),
+  ('subdomain', 'root', 'exact', 'platform'),
+  ('subdomain', 'app', 'exact', 'platform'),
+  ('subdomain', 'apps', 'exact', 'platform'),
+  ('subdomain', 'dashboard', 'exact', 'platform'),
+  ('subdomain', 'console', 'exact', 'platform'),
+  ('subdomain', 'account', 'exact', 'platform'),
+  ('subdomain', 'accounts', 'exact', 'platform'),
+  ('subdomain', 'billing', 'exact', 'platform'),
+  ('subdomain', 'pay', 'exact', 'platform'),
+  ('subdomain', 'payments', 'exact', 'platform'),
+  ('subdomain', 'checkout', 'exact', 'platform'),
+  ('subdomain', 'support', 'exact', 'platform'),
+  ('subdomain', 'help', 'exact', 'platform'),
+  ('subdomain', 'status', 'exact', 'platform'),
+  ('subdomain', 'docs', 'exact', 'platform'),
+  ('subdomain', 'mail', 'exact', 'platform'),
+  ('subdomain', 'email', 'exact', 'platform'),
+  ('subdomain', 'smtp', 'exact', 'platform'),
+  ('subdomain', 'imap', 'exact', 'platform'),
+  ('subdomain', 'ftp', 'exact', 'platform'),
+  ('subdomain', 'ns', 'exact', 'platform'),
+  ('subdomain', 'ns1', 'exact', 'platform'),
+  ('subdomain', 'ns2', 'exact', 'platform'),
+  ('subdomain', 'mx', 'exact', 'platform'),
+  ('subdomain', 'cdn', 'exact', 'platform'),
+  ('subdomain', 'static', 'exact', 'platform'),
+  ('subdomain', 'assets', 'exact', 'platform'),
+  ('subdomain', 'files', 'exact', 'platform'),
+  ('subdomain', 'storage', 'exact', 'platform'),
+  ('subdomain', 'media', 'exact', 'platform'),
+  ('subdomain', 'ws', 'exact', 'platform'),
+  ('subdomain', 'wss', 'exact', 'platform'),
+  ('subdomain', 'graphql', 'exact', 'platform'),
+  ('subdomain', 'modules', 'exact', 'platform'),
+  ('subdomain', 'agent', 'exact', 'platform'),
+  ('subdomain', 'compute', 'exact', 'platform'),
+  ('subdomain', 'machines', 'exact', 'platform'),
+  ('subdomain', 'cluster', 'exact', 'platform'),
+  ('subdomain', 'migrate', 'exact', 'platform'),
+  ('subdomain', 'internal', 'exact', 'platform'),
+  ('subdomain', 'system', 'exact', 'platform'),
+  ('subdomain', 'platform', 'exact', 'platform'),
+  ('subdomain', 'security', 'exact', 'platform'),
+  ('subdomain', 'sso', 'exact', 'platform'),
+  ('subdomain', 'oauth', 'exact', 'platform'),
+  ('subdomain', 'id', 'exact', 'platform'),
+  ('subdomain', 'identity', 'exact', 'platform'),
+  ('subdomain', 'verify', 'exact', 'platform'),
+  ('subdomain', 'secure', 'exact', 'platform'),
+  ('subdomain', 'xn--', 'prefix', 'lookalike');

package/verify/schemas/reserved_names/procedures/is_reserved.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/procedures/is_reserved on pg
+
+BEGIN;
+
+SELECT assert_function('reserved_names.is_reserved(text, text)'::regprocedure);
+
+ROLLBACK;

package/verify/schemas/reserved_names/procedures/reserved_by.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/procedures/reserved_by on pg
+
+BEGIN;
+
+SELECT assert_function('reserved_names.reserved_by(text, text)'::regprocedure);
+
+ROLLBACK;

package/verify/schemas/reserved_names/schema.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/schema on pg
+
+BEGIN;
+
+SELECT assert_schema('reserved_names'::regnamespace);
+
+ROLLBACK;

package/verify/schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/tables/kinds/fixtures/1792800000000_fixture on pg
+
+BEGIN;
+
+SELECT 1/count(*) FROM reserved_names.kinds WHERE kind = 'subdomain';
+
+ROLLBACK;

package/verify/schemas/reserved_names/tables/kinds/table.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/tables/kinds/table on pg
+
+BEGIN;
+
+SELECT assert_table('reserved_names.kinds'::regclass);
+
+ROLLBACK;

package/verify/schemas/reserved_names/tables/names/fixtures/1792800000002_fixture.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/tables/names/fixtures/1792800000002_fixture on pg
+
+BEGIN;
+
+SELECT 1/count(*) FROM reserved_names.names WHERE kind = 'subdomain' AND name = 'login';
+
+ROLLBACK;

package/verify/schemas/reserved_names/tables/names/indexes/names_reason_idx.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/tables/names/indexes/names_reason_idx on pg
+
+BEGIN;
+
+SELECT assert_index('reserved_names.names_reason_idx'::regclass, 'reserved_names.names'::regclass);
+
+ROLLBACK;

package/verify/schemas/reserved_names/tables/names/table.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/tables/names/table on pg
+
+BEGIN;
+
+SELECT assert_table('reserved_names.names'::regclass);
+
+ROLLBACK;

package/verify/schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/tables/reasons/fixtures/1792800000001_fixture on pg
+
+BEGIN;
+
+SELECT 1/count(*) FROM reserved_names.reasons WHERE reason = 'platform';
+
+ROLLBACK;

package/verify/schemas/reserved_names/tables/reasons/table.sql

@@ -0,0 +1,7 @@
+-- Verify schemas/reserved_names/tables/reasons/table on pg
+
+BEGIN;
+
+SELECT assert_table('reserved_names.reasons'::regclass);
+
+ROLLBACK;