charming-circle

library4.1.3jsnpmunverified

Per-user database access library for the CCNQ4 platform, version 4.1.3. Provides a framework for creating and managing individual user provisioning and voicemail databases in CouchDB, including security setup and replication from a master provisioning database. Part of a broader CCNQ4 ecosystem, intended for use with zappajs. Release cadence is tied to CCNQ4 updates; no breaking changes documented in recent versions. Differentiators: tightly coupled with CCNQ4's architecture, leverages CouchDB features for user isolation.

database

npm install charming-circle

github ↗package ↗

INSTALL

IMPORT

SIG · CHARMING-CIRCLE

charming-circle

databasejavascriptv4.1.3

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

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

default

✓ import charmingCircle from 'charming-circle'

✗ const charmingCircle = require('charming-circle')

ESM-only since v4; no default export, use named imports instead

UserDatabase

✓ import { UserDatabase } from 'charming-circle'

✗ import UserDatabase from 'charming-circle'

Named export for the UserDatabase class

createUserDatabase

✓ import { createUserDatabase } from 'charming-circle'

Factory function for database creation

Shows how to create a per-user database instance using the createUserDatabase factory with zappajs integration.

import { createUserDatabase } from 'charming-circle'; import app from 'zappajs'; const db = createUserDB(app, { user: 'alice', password: process.env.DB_PASS ?? '' }); // Use db to access per-user provisioning or voicemail

Debug

Known issues

breakingVersion 4.x drops CommonJS support; ESM only.

fix

Use import syntax instead of require().

affects: >=4.0.0

deprecatedThe original user document creation API is deprecated in favor of monitor-based triggers.

fix

Upgrade to v4 and use the new monitoring pattern.

affects: <4.0.0

gotchaRequires CouchDB admin credentials to create databases.

fix

Ensure DB_PASS env var is set with admin password.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'charming-circle'

Node.js unable to locate the package in node_modules.

fix

Run 'npm install charming-circle' in your project directory.

The requested module 'charming-circle' is not a CommonJS module

Trying to require an ESM-only package.

fix

Use import syntax or set type: 'module' in package.json.

Zappa app not provided

createUserDatabase requires a valid zappajs app instance as first argument.

fix

Pass the app object from 'zappajs' import.

Upgrade

Version history

4.1.3latest on npm

Audit

Dependencies

zappajsrequiredpeer dependency for runtime integration

Agent activity

13 hits · last 30 days

node

Anthropic

OpenAI (training)

Resources

githubhttps://github.com/shimaore/charming-circle ↗

packagehttps://www.npmjs.com/package/charming-circle ↗