Registry / security / imes-aurora-postgres-store

imes-aurora-postgres-store

library0.7.0jsnpmunverified

Imes Aurora Postgres Store (v0.7.0) is a store implementation for the Imes identity and access management framework, optimized for Amazon Aurora PostgreSQL. It provides scalable, durable storage for Imes resources such as users, roles, and permissions. The store leverages Aurora's high availability and read replicas for performance. This package is part of the Imes ecosystem, which offers a modular approach to identity management. It requires the core `imes` package and `@aws-sdk/client-aurora-data-api` for direct Aurora Data API access. Release cadence follows Imes releases, with a focus on PostgreSQL compatibility.

security database

npm install imes-aurora-postgres-store

package ↗

INSTALL

IMPORT

SIG · IMES-AURORA-POSTGR

imes-aurora-postgres-store

securityjavascriptv0.7.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

AuroraPostgresStore

✓ import { AuroraPostgresStore } from 'imes-aurora-postgres-store'

✗ const AuroraPostgresStore = require('imes-aurora-postgres-store')

ESM-only; CommonJS require not supported. TypeScript types included.

AuroraPostgresStoreConfig

✓

✗ import { AuroraPostgresStoreConfig } from 'imes-aurora-postgres-store'

Type not exported. Use inline type or import from 'imes' package.

createStore

✓ import { createStore } from 'imes-aurora-postgres-store'

✗ import createStore from 'imes-aurora-postgres-store'

Default export is not available; use named export.

Initializes an AuroraPostgresStore with AWS Secrets Manager credentials and creates a user via Imes.

import { AuroraPostgresStore } from 'imes-aurora-postgres-store'; import { Imes } from 'imes'; const store = new AuroraPostgresStore({ secretArn: process.env.AURORA_SECRET_ARN ?? '', resourceArn: process.env.AURORA_RESOURCE_ARN ?? '', database: process.env.AURORA_DATABASE ?? 'imes', region: 'us-east-1', }); const imes = new Imes({ store }); async function main() { const user = await imes.users.create({ username: 'alice', attributes: { email: 'alice@example.com' } }); console.log('Created user:', user.id); } main().catch(console.error);

Debug

Known issues

breakingRequired `region` configuration was added in v0.6.0; prior versions defaulted to 'us-east-1' but now must be explicitly set.

fix

Add `region` to the configuration object when constructing AuroraPostgresStore.

affects: <0.6.0

gotchaStore expects `secretArn` and `resourceArn` to be valid ARNs for AWS Secrets Manager and Aurora cluster. Invalid ARNs will cause silent failures with 'BadRequestException'.

fix

Ensure ARNs are correct and the associated secret has the necessary permissions for the Aurora Data API.

affects: >=0.0.0

deprecatedThe `connectionString` option is deprecated since v0.5.0; use `secretArn` and `resourceArn` instead.

fix

Migrate to using `secretArn` + `resourceArn` + `database` configuration.

affects: >=0.5.0

breakingSupport for plain PostgreSQL (non-Aurora) via `pg` client was removed in v0.7.0. Only Aurora Data API is supported now.

fix

Use 'imes-postgres-store' package for standard PostgreSQL; or upgrade to Aurora.

affects: >=0.7.0

Errors

Common errors & fixes

Error: Cannot find module 'imes-aurora-postgres-store'

Package not installed or wrong import path.

fix

Run `npm install imes-aurora-postgres-store` and ensure import path is correct.

TypeError: AuroraPostgresStore is not a constructor

Using default import instead of named import.

fix

Change `import AuroraPostgresStore from ...` to `import { AuroraPostgresStore } from ...`.

Error: AuroraPostgresStore requires `secretArn` and `resourceArn` options

Missing required configuration fields.

fix

Provide `secretArn` and `resourceArn` in the constructor options.

Upgrade

Version history

0.7.0latest on npm

Audit

Dependencies

imesrequiredCore Imes framework required for store integration

@aws-sdk/client-aurora-data-apirequiredAurora Data API client for database operations

pgoptionalPostgreSQL client for traditional connection pool (fallback)

Agent activity

13 hits · last 30 days

node

OpenAI (training)

Resources

packageimes-aurora-postgres-store ↗