@pgpm/types 0.12.0 → 0.13.0

package/README.md

@@ -22,9 +22,10 @@ Core PostgreSQL data types with SQL scripts.
 
 - **email**: Case-insensitive email address validation
 - **url**: HTTP/HTTPS URL validation
+- **origin**: Origin URL validation (scheme + host)
 - **hostname**: Domain name validation
 - **image**: JSON-based image metadata with URL and MIME type
-- **attachment**: JSON-based file attachment metadata with URL and MIME type
+- **attachment**: File attachment metadata as a URL string or JSON with URL and MIME type
 - **upload**: File upload metadata
 - **single_select**: Single selection field
 - **multiple_select**: Multiple selection field
@@ -156,7 +157,8 @@ INSERT INTO customers (domain) VALUES
 
 ### Image and Attachment Domains
 
-The `image` and `attachment` domains store JSON objects with URL and MIME type information.
+The `image` domain stores JSON objects with URL and MIME type information. The `attachment` domain accepts either that JSON shape or a plain URL string.
+The `upload` domain uses the same JSON object shape as `image`, ensuring both the file URL and MIME type are present.
 
 ```sql
 -- Valid image
@@ -166,9 +168,12 @@ INSERT INTO customers (profile_image) VALUES
 -- Valid attachment
 INSERT INTO customers (document) VALUES
   ('{"url": "https://storage.example.com/file.pdf", "mime": "application/pdf"}'::json);
+
+-- Valid attachment as plain URL
+INSERT INTO customers (document) VALUES ('https://storage.example.com/favicon.ico');
 ```
 
-**Structure**: Both domains expect JSON objects with `url` and `mime` properties.
+**Structure**: Image values and JSON-form attachments expect `url` and `mime` properties; attachments also allow a bare URL string.
 
 ## Domain Types Reference
 
@@ -176,10 +181,11 @@ INSERT INTO customers (document) VALUES
 |--------|-----------|-------------|---------|
 | `email` | `citext` | Case-insensitive email address | `user@example.com` |
 | `url` | `text` | HTTP/HTTPS URL | `https://example.com/path` |
+| `origin` | `text` | Origin (scheme + host) | `https://example.com` |
 | `hostname` | `text` | Domain name without protocol | `example.com` |
 | `image` | `json` | Image metadata with URL and MIME | `{"url": "...", "mime": "image/jpeg"}` |
-| `attachment` | `json` | File attachment metadata | `{"url": "...", "mime": "application/pdf"}` |
-| `upload` | `text` | File upload identifier | Various formats |
+| `attachment` | `json` | File attachment URL or metadata | `{"url": "...", "mime": "application/pdf"}` or `https://example.com/favicon.ico` |
+| `upload` | `json` | File upload metadata (URL + MIME) | `{"url": "...", "mime": "application/pdf"}` |
 | `single_select` | `text` | Single selection value | Text value |
 | `multiple_select` | `text[]` | Multiple selection values | Array of text values |
 
@@ -207,7 +213,7 @@ The test suite validates:
 - Email format validation (valid and invalid cases)
 - URL format validation with extensive test cases
 - Hostname format validation
-- Image and attachment JSON structure validation
+- Image, upload, and attachment JSON structure validation
 
 ## Related Tooling
 

package/__tests__/domains.pgutils.test.ts

@@ -44,15 +44,37 @@ const invalidUrls = [
 ];
 
 const validAttachments = [
+  'http://www.foo.bar/some.jpg',
+  'https://foo.bar/some.PNG'
+];
+
+const invalidAttachments = [
+  'hi there',
+  'ftp://foo.bar/some.png',
+  'https:///foo.bar/some.png'
+];
+
+const validImages = [
   { url: 'http://www.foo.bar/some.jpg', mime: 'image/jpg' },
   { url: 'https://foo.bar/some.PNG', mime: 'image/jpg' }
 ];
 
-const invalidAttachments = [
+const invalidImages = [
   { url: 'hi there' },
   { url: 'https://foo.bar/some.png' }
 ];
 
+const validUploads = [
+  { url: 'http://www.foo.bar/some.jpg', mime: 'image/jpg' },
+  { url: 'https://foo.bar/some.PNG', mime: 'image/png' }
+];
+
+const invalidUploads = [
+  { url: 'hi there' },
+  { url: 'https://foo.bar/some.png' },
+  { url: 'ftp://foo.bar/some.png', mime: 'image/png' }
+];
+
 let pg: PgTestClient;
 let teardown:  () => Promise<void>;
 
@@ -68,7 +90,8 @@ CREATE TABLE customers (
   image image,
   attachment attachment,
   domain hostname,
-  email email
+  email email,
+  upload upload
 );
   `);
 });
@@ -87,24 +110,48 @@ afterAll(async () => {
 
 describe('types', () => {
   it('valid attachment and image', async () => {
-    for (const value of validAttachments) {
-      await pg.any(`INSERT INTO customers (image) VALUES ($1::json);`, [value]);
-      await pg.any(`INSERT INTO customers (attachment) VALUES ($1::json);`, [value]);
+    for (const attachment of validAttachments) {
+      await pg.any(`INSERT INTO customers (attachment) VALUES ($1);`, [attachment]);
+    }
+
+    for (const image of validImages) {
+      await pg.any(`INSERT INTO customers (image) VALUES ($1::json);`, [image]);
     }
   });
 
   it('invalid attachment and image', async () => {
-    for (const value of invalidAttachments) {
+    for (const attachment of invalidAttachments) {
       let failed = false;
       try {
-        await pg.any(`INSERT INTO customers (attachment) VALUES ($1);`, [value]);
+        await pg.any(`INSERT INTO customers (attachment) VALUES ($1);`, [attachment]);
       } catch (e) {
         failed = true;
       }
       expect(failed).toBe(true);
-      failed = false;
+    }
+
+    for (const image of invalidImages) {
+      let failed = false;
+      try {
+        await pg.any(`INSERT INTO customers (image) VALUES ($1::json);`, [image]);
+      } catch (e) {
+        failed = true;
+      }
+      expect(failed).toBe(true);
+    }
+  });
+
+  it('valid upload', async () => {
+    for (const upload of validUploads) {
+      await pg.any(`INSERT INTO customers (upload) VALUES ($1::json);`, [upload]);
+    }
+  });
+
+  it('invalid upload', async () => {
+    for (const upload of invalidUploads) {
+      let failed = false;
       try {
-        await pg.any(`INSERT INTO customers (image) VALUES ($1);`, [value]);
+        await pg.any(`INSERT INTO customers (upload) VALUES ($1::json);`, [upload]);
       } catch (e) {
         failed = true;
       }

package/__tests__/domains.test.ts

@@ -44,15 +44,37 @@ const invalidUrls = [
 ];
 
 const validAttachments = [
+  'http://www.foo.bar/some.jpg',
+  'https://foo.bar/some.PNG'
+];
+
+const invalidAttachments = [
+  'hi there',
+  'ftp://foo.bar/some.png',
+  'https:///foo.bar/some.png'
+];
+
+const validImages = [
   { url: 'http://www.foo.bar/some.jpg', mime: 'image/jpg' },
   { url: 'https://foo.bar/some.PNG', mime: 'image/jpg' }
 ];
 
-const invalidAttachments = [
+const invalidImages = [
   { url: 'hi there' },
   { url: 'https://foo.bar/some.png' }
 ];
 
+const validUploads = [
+  { url: 'http://www.foo.bar/some.jpg', mime: 'image/jpg' },
+  { url: 'https://foo.bar/some.PNG', mime: 'image/png' }
+];
+
+const invalidUploads = [
+  { url: 'hi there' },
+  { url: 'https://foo.bar/some.png' },
+  { url: 'ftp://foo.bar/some.png', mime: 'image/png' }
+];
+
 let pg: PgTestClient;
 let teardown:  () => Promise<void>;
 
@@ -68,7 +90,8 @@ CREATE TABLE customers (
   image image,
   attachment attachment,
   domain hostname,
-  email email
+  email email,
+  upload upload
 );
   `);
 });
@@ -87,24 +110,48 @@ afterAll(async () => {
 
 describe('types', () => {
   it('valid attachment and image', async () => {
-    for (const value of validAttachments) {
-      await pg.any(`INSERT INTO customers (image) VALUES ($1::json);`, [value]);
-      await pg.any(`INSERT INTO customers (attachment) VALUES ($1::json);`, [value]);
+    for (const attachment of validAttachments) {
+      await pg.any(`INSERT INTO customers (attachment) VALUES ($1);`, [attachment]);
+    }
+
+    for (const image of validImages) {
+      await pg.any(`INSERT INTO customers (image) VALUES ($1::json);`, [image]);
     }
   });
 
   it('invalid attachment and image', async () => {
-    for (const value of invalidAttachments) {
+    for (const attachment of invalidAttachments) {
       let failed = false;
       try {
-        await pg.any(`INSERT INTO customers (attachment) VALUES ($1);`, [value]);
+        await pg.any(`INSERT INTO customers (attachment) VALUES ($1);`, [attachment]);
       } catch (e) {
         failed = true;
       }
       expect(failed).toBe(true);
-      failed = false;
+    }
+
+    for (const image of invalidImages) {
+      let failed = false;
+      try {
+        await pg.any(`INSERT INTO customers (image) VALUES ($1::json);`, [image]);
+      } catch (e) {
+        failed = true;
+      }
+      expect(failed).toBe(true);
+    }
+  });
+
+  it('valid upload', async () => {
+    for (const upload of validUploads) {
+      await pg.any(`INSERT INTO customers (upload) VALUES ($1::json);`, [upload]);
+    }
+  });
+
+  it('invalid upload', async () => {
+    for (const upload of invalidUploads) {
+      let failed = false;
       try {
-        await pg.any(`INSERT INTO customers (image) VALUES ($1);`, [value]);
+        await pg.any(`INSERT INTO customers (upload) VALUES ($1::json);`, [upload]);
       } catch (e) {
         failed = true;
       }

package/deploy/schemas/public/domains/attachment.sql

@@ -2,11 +2,6 @@
 -- requires: schemas/public/schema
 
 BEGIN;
-CREATE DOMAIN attachment AS jsonb CHECK (
-  value ?& ARRAY['url', 'mime']
-  AND
-  value->>'url' ~ '^(https?)://[^\s/$.?#].[^\s]*$'
-);
+CREATE DOMAIN attachment AS text CHECK (VALUE ~ '^(https?)://[^\s/$.?#].[^\s]*$');
 COMMENT ON DOMAIN attachment IS E'@name launchqlInternalTypeAttachment';
 COMMIT;
-

package/deploy/schemas/public/domains/origin.sql

@@ -1,10 +1,8 @@
 -- Deploy schemas/public/domains/origin to pg
-
 -- requires: schemas/public/schema
 
 BEGIN;
-
-CREATE DOMAIN origin AS text CHECK (VALUE = substring(VALUE from '^(https?://[^/]*)') );
+CREATE DOMAIN origin AS text CHECK (VALUE = substring(VALUE from '^(https?://[^/]*)'));
 COMMENT ON DOMAIN origin IS E'@name launchqlInternalTypeOrigin';
-
 COMMIT;
+

package/deploy/schemas/public/domains/upload.sql

@@ -4,7 +4,11 @@
 
 BEGIN;
 
-CREATE DOMAIN upload AS text CHECK (VALUE ~ '^(https?)://[^\s/$.?#].[^\s]*$');
+CREATE DOMAIN upload AS jsonb CHECK (
+  value ?& ARRAY['url', 'mime']
+  AND
+  value->>'url' ~ '^(https?)://[^\s/$.?#].[^\s]*$'
+);
 COMMENT ON DOMAIN upload IS E'@name launchqlInternalTypeUpload';
 
 COMMIT;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpm/types",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Core PostgreSQL data types with deploy/verify/revert SQL scripts",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "contributors": [
@@ -21,7 +21,7 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@pgpm/verify": "0.12.0"
+    "@pgpm/verify": "0.13.0"
   },
   "devDependencies": {
     "pgpm": "^0.2.0"
@@ -34,5 +34,5 @@
   "bugs": {
     "url": "https://github.com/launchql/pgpm-modules/issues"
   },
-  "gitHead": "b106c3afcb5152f177f411bf89bbef392fbd2375"
+  "gitHead": "e7de11be3a2fd806929adf48acc556d812c75aa6"
 }

package/pgpm.plan

@@ -8,6 +8,7 @@ schemas/public/domains/email [schemas/public/schema] 2017-08-11T08:11:51Z skitch
 schemas/public/domains/hostname [schemas/public/schema] 2017-08-11T08:11:51Z skitch <skitch@5b0c196eeb62> # add schemas/public/domains/hostname
 schemas/public/domains/image [schemas/public/schema] 2017-08-11T08:11:51Z skitch <skitch@5b0c196eeb62> # add schemas/public/domains/image
 schemas/public/domains/multiple_select [schemas/public/schema] 2017-08-11T08:11:51Z skitch <skitch@5b0c196eeb62> # add schemas/public/domains/multiple_select
+schemas/public/domains/origin [schemas/public/schema] 2017-08-11T08:11:51Z skitch <skitch@5b0c196eeb62> # add schemas/public/domains/origin
 schemas/public/domains/single_select [schemas/public/schema] 2017-08-11T08:11:51Z skitch <skitch@5b0c196eeb62> # add schemas/public/domains/single_select
 schemas/public/domains/upload [schemas/public/schema] 2017-08-11T08:11:51Z skitch <skitch@5b0c196eeb62> # add schemas/public/domains/upload
 schemas/public/domains/url [schemas/public/schema] 2017-08-11T08:11:51Z skitch <skitch@5b0c196eeb62> # add schemas/public/domains/url

package/revert/schemas/public/domains/origin.sql

@@ -5,3 +5,4 @@ BEGIN;
 DROP TYPE public.origin;
 
 COMMIT;
+

package/sql/launchql-types--0.9.0.sql

@@ -35,12 +35,15 @@ CREATE DOMAIN single_select AS jsonb
 
 COMMENT ON DOMAIN single_select IS '@name launchqlInternalTypeSingleSelect';
 
-CREATE DOMAIN upload AS text 
-  CHECK (value ~ E'^(https?)://[^\\s/$.?#].[^\\s]*$');
+CREATE DOMAIN upload AS jsonb 
+  CHECK (
+  value ?& ARRAY['url', 'mime']
+    AND (value ->> 'url') ~ E'^(https?)://[^\\s/$.?#].[^\\s]*$'
+);
 
 COMMENT ON DOMAIN upload IS '@name launchqlInternalTypeUpload';
 
 CREATE DOMAIN url AS text 
   CHECK (value ~ E'^(https?)://[^\\s/$.?#].[^\\s]*$');
 
-COMMENT ON DOMAIN url IS '@name launchqlInternalTypeUrl';
+COMMENT ON DOMAIN url IS '@name launchqlInternalTypeUrl';

package/verify/schemas/public/domains/origin.sql

@@ -5,3 +5,4 @@ BEGIN;
 SELECT verify_type ('public.origin');
 
 ROLLBACK;
+