@pgpm/totp 0.6.0 → 0.7.1

package/Makefile

@@ -1,5 +1,5 @@
 EXTENSION = launchql-totp
-DATA = sql/launchql-totp--0.5.0.sql
+DATA = sql/launchql-totp--0.6.0.sql
 
 PG_CONFIG = pg_config
 PGXS := $(shell $(PG_CONFIG) --pgxs)

package/README.md

@@ -1,5 +1,17 @@
 # @pgpm/totp
 
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/launchql/launchql/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml">
+    <img height="20" src="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml/badge.svg" />
+  </a>
+   <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>
+   <a href="https://www.npmjs.com/package/@pgpm/totp"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/pgpm-modules?filename=packages%2Fsecurity%2Ftotp%2Fpackage.json"/></a>
+</p>
+
 TOTP implementation in pure PostgreSQL plpgsql
 
 This extension provides the HMAC Time-Based One-Time Password Algorithm (TOTP) as specified in RFC 4226 as pure plpgsql functions.
@@ -32,40 +44,42 @@ This is a quick way to get started. The sections below provide more detailed ins
 ### Prerequisites
 
 ```bash
-# Install pgpm globally
+# Install pgpm CLI 
 npm install -g pgpm
 
-# Start PostgreSQL
+# Start local Postgres (via Docker) and export env vars
 pgpm docker start
-
-# Set environment variables
 eval "$(pgpm env)"
 ```
 
-### Deploy
+> **Tip:** Already running Postgres? Skip the Docker step and just export your `PG*` environment variables.
 
-#### Option 1: Deploy by installing with pgpm
+### **Add to an Existing Package**
 
 ```bash
+# 1. Install the package
 pgpm install @pgpm/totp
-pgpm deploy
+
+# 2. Deploy locally
+pgpm deploy 
 ```
 
-#### Option 2: Deploy from Package Directory
+### **Add to a New Project**
 
 ```bash
-cd packages/security/totp
-pgpm deploy --createdb
-```
+# 1. Create a workspace
+pgpm init --workspace
+cd my-app
 
-#### Option 3: Deploy from Workspace Root
+# 2. Create your first module
+pgpm init
+cd packages/your-module
 
-```bash
-# Install workspace dependencies
-pnpm install
+# 3. Install a package 
+pgpm install @pgpm/totp
 
-# Deploy with dependencies
-pgpm deploy mydb1 --yes --createdb
+# 4. Deploy everything
+pgpm deploy --createdb --database mydb1
 ```
 
 ## Usage
@@ -241,139 +255,6 @@ https://gist.github.com/bwbroersma/676d0de32263ed554584ab132434ebd9
 
 ---
 
-## Development
-
-## start the postgres db process
-
-First you'll want to start the postgres docker (you can also just use `docker-compose up -d`):
-
-```sh
-make up
-```
-
-## install modules
-
-Install modules
-
-```sh
-yarn install
-```
-
-## install the Postgres extensions
-
-Now that the postgres process is running, install the extensions:
-
-```sh
-make install
-```
-
-This basically `ssh`s into the postgres instance with the `packages/` folder mounted as a volume, and installs the bundled sql code as pgxn extensions.
-
-## testing
-
-Testing will load all your latest sql changes and create fresh, populated databases for each sqitch module in `packages/`.
-
-```sh
-yarn test:watch
-```
-
-## building new modules
-
-Create a new folder in `packages/`
-
-```sh
-pgpm init
-```
-
-Then, run a generator:
-
-```sh
-pgpm generate
-```
-
-You can also add arguments if you already know what you want to do:
-
-```sh
-pgpm generate schema --schema myschema
-pgpm generate table --schema myschema --table mytable
-```
-
-## deploy code as extensions
-
-`cd` into `packages/<module>`, and run `pgpm package`. This will make an sql file in `packages/<module>/sql/` used for `CREATE EXTENSION` calls to install your sqitch module as an extension.
-
-## recursive deploy
-
-You can also deploy all modules utilizing versioning as sqtich modules. Remove `--createdb` if you already created your db:
-
-```sh
-pgpm deploy mydb1 --yes --createdb
-```
-
----
-
-### **Before You Begin**
-
-```bash
-# 1. Install pgpm
-npm install -g pgpm
-
-# 2. Start Postgres (Docker or local)
-pgpm docker start
-
-# 3. Load PG* environment variables (PGHOST, PGUSER, ...)
-eval "$(pgpm env)"
-```
-
----
-
-### **Starting a New Project**
-
-```bash
-# 1. Create a workspace
-pgpm init --workspace
-cd my-app
-
-# 2. Create your first module
-pgpm init
-
-# 3. Add a migration
-pgpm add some_change
-
-# 4. Deploy (auto-creates database)
-pgpm deploy --createdb
-```
-
----
-
-### **Working With an Existing Project**
-
-```bash
-# 1. Clone and enter the project
-git clone <repo> && cd <project>
-
-# 2. Install dependencies
-pnpm install
-
-# 3. Deploy locally
-pgpm deploy --createdb
-```
-
----
-
-### **Testing a Module Inside a Workspace**
-
-```bash
-# 1. Install workspace deps
-pnpm install
-
-# 2. Enter the module directory
-cd packages/<some-module>
-
-# 3. Run tests in watch mode
-pnpm test:watch
-```
-
 ## Related Tooling
 
 * [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.

package/launchql-totp.control

@@ -1,6 +1,6 @@
 # launchql-totp extension
 comment = 'launchql-totp extension'
-default_version = '0.5.0'
+default_version = '0.6.0'
 module_pathname = '$libdir/launchql-totp'
 requires = 'pgcrypto,plpgsql,launchql-base32,launchql-verify'
 relocatable = false

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "@pgpm/totp",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "description": "Time-based One-Time Password (TOTP) authentication",
+  "keywords": [
+    "postgresql",
+    "pgpm",
+    "totp",
+    "2fa"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -11,8 +17,8 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@pgpm/base32": "0.6.0",
-    "@pgpm/verify": "0.6.0"
+    "@pgpm/base32": "0.7.1",
+    "@pgpm/verify": "0.7.1"
   },
   "devDependencies": {
     "pgpm": "^0.2.0"
@@ -25,5 +31,5 @@
   "bugs": {
     "url": "https://github.com/launchql/pgpm-modules/issues"
   },
-  "gitHead": "c7d0eae588d7a764b382a330c8b853b341b13fb2"
+  "gitHead": "f3156553b409bd27b66ac03562151d439d779f53"
 }