@pgpm/types 0.6.0 → 0.7.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.
package/Makefile CHANGED
@@ -1,5 +1,5 @@
1
1
  EXTENSION = launchql-types
2
- DATA = sql/launchql-types--0.5.0.sql
2
+ DATA = sql/launchql-types--0.6.0.sql
3
3
 
4
4
  PG_CONFIG = pg_config
5
5
  PGXS := $(shell $(PG_CONFIG) --pgxs)
package/README.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @pgpm/types
2
2
 
3
+ <p align="center" width="100%">
4
+ <img height="250" src="https://raw.githubusercontent.com/launchql/launchql/refs/heads/main/assets/outline-logo.svg" />
5
+ </p>
6
+
7
+ <p align="center" width="100%">
8
+ <a href="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml">
9
+ <img height="20" src="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml/badge.svg" />
10
+ </a>
11
+ <a href="https://github.com/launchql/pgpm-modules/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
12
+ <a href="https://www.npmjs.com/package/@pgpm/types"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/pgpm-modules?filename=packages%2Fdata-types%2Ftypes%2Fpackage.json"/></a>
13
+ </p>
14
+
3
15
  Core PostgreSQL data types with SQL scripts.
4
16
 
5
17
  ## Overview
@@ -31,40 +43,42 @@ This is a quick way to get started. The sections below provide more detailed ins
31
43
  ### Prerequisites
32
44
 
33
45
  ```bash
34
- # Install pgpm globally
46
+ # Install pgpm CLI
35
47
  npm install -g pgpm
36
48
 
37
- # Start PostgreSQL
49
+ # Start local Postgres (via Docker) and export env vars
38
50
  pgpm docker start
39
-
40
- # Set environment variables
41
51
  eval "$(pgpm env)"
42
52
  ```
43
53
 
44
- ### Deploy
54
+ > **Tip:** Already running Postgres? Skip the Docker step and just export your `PG*` environment variables.
45
55
 
46
- #### Option 1: Deploy by installing with pgpm
56
+ ### **Add to an Existing Package**
47
57
 
48
58
  ```bash
59
+ # 1. Install the package
49
60
  pgpm install @pgpm/types
50
- pgpm deploy
61
+
62
+ # 2. Deploy locally
63
+ pgpm deploy
51
64
  ```
52
65
 
53
- #### Option 2: Deploy from Package Directory
66
+ ### **Add to a New Project**
54
67
 
55
68
  ```bash
56
- cd packages/data-types/types
57
- pgpm deploy --createdb
58
- ```
69
+ # 1. Create a workspace
70
+ pgpm init --workspace
71
+ cd my-app
59
72
 
60
- #### Option 3: Deploy from Workspace Root
73
+ # 2. Create your first module
74
+ pgpm init
75
+ cd packages/your-module
61
76
 
62
- ```bash
63
- # Install workspace dependencies
64
- pnpm install
77
+ # 3. Install a package
78
+ pgpm install @pgpm/types
65
79
 
66
- # Deploy with dependencies
67
- pgpm deploy mydb1 --yes --createdb
80
+ # 4. Deploy everything
81
+ pgpm deploy --createdb --database mydb1
68
82
  ```
69
83
 
70
84
  ## Usage
@@ -195,76 +209,6 @@ The test suite validates:
195
209
  - Hostname format validation
196
210
  - Image and attachment JSON structure validation
197
211
 
198
- ## Development
199
-
200
- See the [Development](#development) section below for information on working with this package.
201
-
202
- ---
203
-
204
- ## Development
205
-
206
- ### **Before You Begin**
207
-
208
- ```bash
209
- # 1. Install pgpm
210
- npm install -g pgpm
211
-
212
- # 2. Start Postgres (Docker or local)
213
- pgpm docker start
214
-
215
- # 3. Load PG* environment variables (PGHOST, PGUSER, ...)
216
- eval "$(pgpm env)"
217
- ```
218
-
219
- ---
220
-
221
- ### **Starting a New Project**
222
-
223
- ```bash
224
- # 1. Create a workspace
225
- pgpm init --workspace
226
- cd my-app
227
-
228
- # 2. Create your first module
229
- pgpm init
230
-
231
- # 3. Add a migration
232
- pgpm add some_change
233
-
234
- # 4. Deploy (auto-creates database)
235
- pgpm deploy --createdb
236
- ```
237
-
238
- ---
239
-
240
- ### **Working With an Existing Project**
241
-
242
- ```bash
243
- # 1. Clone and enter the project
244
- git clone <repo> && cd <project>
245
-
246
- # 2. Install dependencies
247
- pnpm install
248
-
249
- # 3. Deploy locally
250
- pgpm deploy --createdb
251
- ```
252
-
253
- ---
254
-
255
- ### **Testing a Module Inside a Workspace**
256
-
257
- ```bash
258
- # 1. Install workspace deps
259
- pnpm install
260
-
261
- # 2. Enter the module directory
262
- cd packages/<some-module>
263
-
264
- # 3. Run tests in watch mode
265
- pnpm test:watch
266
- ```
267
-
268
212
  ## Related Tooling
269
213
 
270
214
  * [pgpm](https://github.com/launchql/launchql/tree/main/packages/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
@@ -1,6 +1,6 @@
1
1
  # launchql-types extension
2
2
  comment = 'launchql-types extension'
3
- default_version = '0.5.0'
3
+ default_version = '0.6.0'
4
4
  module_pathname = '$libdir/launchql-types'
5
5
  requires = 'plpgsql,citext,launchql-verify'
6
6
  relocatable = false
package/package.json CHANGED
@@ -1,7 +1,13 @@
1
1
  {
2
2
  "name": "@pgpm/types",
3
- "version": "0.6.0",
3
+ "version": "0.7.1",
4
4
  "description": "Core PostgreSQL data types with deploy/verify/revert SQL scripts",
5
+ "keywords": [
6
+ "postgresql",
7
+ "pgpm",
8
+ "data-types",
9
+ "sql"
10
+ ],
5
11
  "publishConfig": {
6
12
  "access": "public"
7
13
  },
@@ -11,7 +17,7 @@
11
17
  "test:watch": "jest --watch"
12
18
  },
13
19
  "dependencies": {
14
- "@pgpm/verify": "0.6.0"
20
+ "@pgpm/verify": "0.7.1"
15
21
  },
16
22
  "devDependencies": {
17
23
  "pgpm": "^0.2.0"
@@ -24,5 +30,5 @@
24
30
  "bugs": {
25
31
  "url": "https://github.com/launchql/pgpm-modules/issues"
26
32
  },
27
- "gitHead": "c7d0eae588d7a764b382a330c8b853b341b13fb2"
33
+ "gitHead": "f3156553b409bd27b66ac03562151d439d779f53"
28
34
  }