@pgpm/defaults 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-defaults
2
- DATA = sql/launchql-defaults--0.5.0.sql
2
+ DATA = sql/launchql-defaults--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/defaults
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/defaults"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/pgpm-modules?filename=packages%2Fsecurity%2Fdefaults%2Fpackage.json"/></a>
13
+ </p>
14
+
3
15
  Security defaults and baseline configurations.
4
16
 
5
17
  ## Overview
@@ -28,40 +40,42 @@ This is a quick way to get started. The sections below provide more detailed ins
28
40
  ### Prerequisites
29
41
 
30
42
  ```bash
31
- # Install pgpm globally
43
+ # Install pgpm CLI
32
44
  npm install -g pgpm
33
45
 
34
- # Start PostgreSQL
46
+ # Start local Postgres (via Docker) and export env vars
35
47
  pgpm docker start
36
-
37
- # Set environment variables
38
48
  eval "$(pgpm env)"
39
49
  ```
40
50
 
41
- ### Deploy
51
+ > **Tip:** Already running Postgres? Skip the Docker step and just export your `PG*` environment variables.
42
52
 
43
- #### Option 1: Deploy by installing with pgpm
53
+ ### **Add to an Existing Package**
44
54
 
45
55
  ```bash
56
+ # 1. Install the package
46
57
  pgpm install @pgpm/defaults
47
- pgpm deploy
58
+
59
+ # 2. Deploy locally
60
+ pgpm deploy
48
61
  ```
49
62
 
50
- #### Option 2: Deploy from Package Directory
63
+ ### **Add to a New Project**
51
64
 
52
65
  ```bash
53
- cd packages/security/defaults
54
- pgpm deploy --createdb
55
- ```
66
+ # 1. Create a workspace
67
+ pgpm init --workspace
68
+ cd my-app
56
69
 
57
- #### Option 3: Deploy from Workspace Root
70
+ # 2. Create your first module
71
+ pgpm init
72
+ cd packages/your-module
58
73
 
59
- ```bash
60
- # Install workspace dependencies
61
- pnpm install
74
+ # 3. Install a package
75
+ pgpm install @pgpm/defaults
62
76
 
63
- # Deploy with dependencies
64
- pgpm deploy mydb1 --yes --createdb
77
+ # 4. Deploy everything
78
+ pgpm deploy --createdb --database mydb1
65
79
  ```
66
80
 
67
81
  ## What It Does
@@ -251,76 +265,6 @@ GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public TO authenticated;
251
265
  pnpm test
252
266
  ```
253
267
 
254
- ## Development
255
-
256
- See the [Development](#development) section below for information on working with this package.
257
-
258
- ---
259
-
260
- ## Development
261
-
262
- ### **Before You Begin**
263
-
264
- ```bash
265
- # 1. Install pgpm
266
- npm install -g pgpm
267
-
268
- # 2. Start Postgres (Docker or local)
269
- pgpm docker start
270
-
271
- # 3. Load PG* environment variables (PGHOST, PGUSER, ...)
272
- eval "$(pgpm env)"
273
- ```
274
-
275
- ---
276
-
277
- ### **Starting a New Project**
278
-
279
- ```bash
280
- # 1. Create a workspace
281
- pgpm init --workspace
282
- cd my-app
283
-
284
- # 2. Create your first module
285
- pgpm init
286
-
287
- # 3. Add a migration
288
- pgpm add some_change
289
-
290
- # 4. Deploy (auto-creates database)
291
- pgpm deploy --createdb
292
- ```
293
-
294
- ---
295
-
296
- ### **Working With an Existing Project**
297
-
298
- ```bash
299
- # 1. Clone and enter the project
300
- git clone <repo> && cd <project>
301
-
302
- # 2. Install dependencies
303
- pnpm install
304
-
305
- # 3. Deploy locally
306
- pgpm deploy --createdb
307
- ```
308
-
309
- ---
310
-
311
- ### **Testing a Module Inside a Workspace**
312
-
313
- ```bash
314
- # 1. Install workspace deps
315
- pnpm install
316
-
317
- # 2. Enter the module directory
318
- cd packages/<some-module>
319
-
320
- # 3. Run tests in watch mode
321
- pnpm test:watch
322
- ```
323
-
324
268
  ## Related Tooling
325
269
 
326
270
  * [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-defaults extension
2
2
  comment = 'launchql-defaults extension'
3
- default_version = '0.5.0'
3
+ default_version = '0.6.0'
4
4
  module_pathname = '$libdir/launchql-defaults'
5
5
  requires = 'plpgsql,launchql-verify'
6
6
  relocatable = false
package/package.json CHANGED
@@ -1,7 +1,13 @@
1
1
  {
2
2
  "name": "@pgpm/defaults",
3
- "version": "0.6.0",
3
+ "version": "0.7.1",
4
4
  "description": "Security defaults and baseline configurations",
5
+ "keywords": [
6
+ "postgresql",
7
+ "pgpm",
8
+ "security",
9
+ "configuration"
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
  }