@happyvertical/directory 0.101.2 → 0.102.2

package/dist/adapters/aws.d.ts

@@ -1,4 +1,16 @@
-import { AwsAccessKey, AwsAccount, AwsAccountCreationStatus, AwsAccountCreationWaitOptions, AwsAccountParent, AwsAssumeRoleInput, AwsDirectoryAdapter, AwsIamRole, AwsIamUser, AwsOptions, AwsOrganizationalUnit, AwsTemporaryCredentials, CreateAwsAccountInput, CreateAwsIamUserInput, CreateAwsOuInput, CreateGroupInput, CreateUserInput, DirectoryGroup, DirectoryUser, EnsureAwsAccountInput, EnsureAwsIamRoleInput, EnsureAwsOuInput, PutAwsIamRolePolicyInput, UpdateGroupInput, UpdateUserInput } from '../shared/types.js';
+/**
+ * AWS directory adapter
+ *
+ * Implements AwsDirectoryAdapter using AWS SDK v3 for Organizations and IAM.
+ * Provides user/group CRUD (mapped to IAM), membership management,
+ * organizational unit operations, account management, and access key operations.
+ *
+ * Caveats:
+ * - Account creation is asynchronous; use getAccountCreationStatus to poll.
+ * - AWS accounts cannot be truly deleted via the API.
+ * - IAM CreateUser does not set passwords (use CreateLoginProfile separately).
+ */
+import type { AwsAccessKey, AwsAccount, AwsAccountCreationStatus, AwsAccountCreationWaitOptions, AwsAccountParent, AwsAssumeRoleInput, AwsDirectoryAdapter, AwsIamRole, AwsIamUser, AwsOptions, AwsOrganizationalUnit, AwsTemporaryCredentials, CreateAwsAccountInput, CreateAwsIamUserInput, CreateAwsOuInput, CreateGroupInput, CreateUserInput, DirectoryGroup, DirectoryUser, EnsureAwsAccountInput, EnsureAwsIamRoleInput, EnsureAwsOuInput, PutAwsIamRolePolicyInput, UpdateGroupInput, UpdateUserInput } from '../shared/types.js';
 export declare class AwsAdapter implements AwsDirectoryAdapter {
     readonly options: AwsOptions;
     private readonly orgs;

package/dist/adapters/kanidm.d.ts

@@ -1,4 +1,11 @@
-import { CreateGroupInput, CreateOAuth2ClientInput, CreateUserInput, CredentialResetIntent, DirectoryGroup, DirectoryUser, KanidmDirectoryAdapter, KanidmOptions, OAuth2Client, UpdateGroupInput, UpdateOAuth2ClientInput, UpdateUserInput } from '../shared/types.js';
+/**
+ * Kanidm directory adapter
+ *
+ * Implements KanidmDirectoryAdapter using the Kanidm REST API v1.
+ * Provides user/group CRUD, membership management, and OAuth2 client operations.
+ * Uses native fetch with AbortSignal.timeout() for all HTTP requests.
+ */
+import type { CreateGroupInput, CreateOAuth2ClientInput, CreateUserInput, CredentialResetIntent, DirectoryGroup, DirectoryUser, KanidmDirectoryAdapter, KanidmOptions, OAuth2Client, UpdateGroupInput, UpdateOAuth2ClientInput, UpdateUserInput } from '../shared/types.js';
 export declare class KanidmAdapter implements KanidmDirectoryAdapter {
     private readonly options;
     private readonly baseUrl;

package/dist/adapters/postgres.d.ts

@@ -1,4 +1,17 @@
-import { CreateGroupInput, CreatePgDatabaseInput, CreatePgRoleInput, CreateUserInput, DirectoryGroup, DirectoryUser, PgDatabase, PgRole, PostgresDirectoryAdapter, PostgresOptions, UpdateGroupInput, UpdateUserInput } from '../shared/types.js';
+/**
+ * PostgreSQL directory adapter for @happyvertical/directory
+ *
+ * Maps PostgreSQL roles and databases to the DirectoryAdapter interface.
+ * Uses the CNPG cluster admin role for provisioning operations.
+ *
+ * Concept mapping:
+ * - DirectoryUser -> PostgreSQL role WITH LOGIN
+ * - DirectoryGroup -> PostgreSQL role WITHOUT LOGIN (NOLOGIN)
+ * - Membership -> GRANT role TO role
+ * - PgDatabase -> PostgreSQL database
+ * - PgRole -> PostgreSQL role (any)
+ */
+import type { CreateGroupInput, CreatePgDatabaseInput, CreatePgRoleInput, CreateUserInput, DirectoryGroup, DirectoryUser, PgDatabase, PgRole, PostgresDirectoryAdapter, PostgresOptions, UpdateGroupInput, UpdateUserInput } from '../shared/types.js';
 export declare class PostgresAdapter implements PostgresDirectoryAdapter {
     private options;
     private client;

package/dist/adapters/stalwart.d.ts

@@ -1,4 +1,11 @@
-import { CreateDkimKeyInput, CreateGroupInput, CreateMailboxInput, CreateMailDomainInput, CreateUserInput, DirectoryGroup, DirectoryUser, DkimKey, DnsRecord, EnsureMailboxInput, EnsureMailboxResult, Mailbox, MailDomain, StalwartDirectoryAdapter, StalwartOptions, UpdateGroupInput, UpdateMailboxInput, UpdateUserInput } from '../shared/types.js';
+/**
+ * Stalwart mail server directory adapter
+ *
+ * Implements StalwartDirectoryAdapter using the Stalwart REST API
+ * with HTTP Basic authentication. Manages users, groups, domains,
+ * DKIM keys, DNS records, and mailboxes via the principals API.
+ */
+import type { CreateDkimKeyInput, CreateGroupInput, CreateMailboxInput, CreateMailDomainInput, CreateUserInput, DirectoryGroup, DirectoryUser, DkimKey, DnsRecord, EnsureMailboxInput, EnsureMailboxResult, Mailbox, MailDomain, StalwartDirectoryAdapter, StalwartOptions, UpdateGroupInput, UpdateMailboxInput, UpdateUserInput } from '../shared/types.js';
 export declare class StalwartAdapter implements StalwartDirectoryAdapter {
     private readonly options;
     private readonly authHeader;

package/dist/shared/factory.d.ts

@@ -1,4 +1,7 @@
-import { AwsDirectoryAdapter, AwsOptions, DirectoryAdapter, GetDirectoryAdapterOptions, KanidmDirectoryAdapter, KanidmOptions, PostgresDirectoryAdapter, PostgresOptions, StalwartDirectoryAdapter, StalwartOptions } from './types.js';
+/**
+ * Factory functions and type guards for @happyvertical/directory package
+ */
+import type { AwsDirectoryAdapter, AwsOptions, DirectoryAdapter, GetDirectoryAdapterOptions, KanidmDirectoryAdapter, KanidmOptions, PostgresDirectoryAdapter, PostgresOptions, StalwartDirectoryAdapter, StalwartOptions } from './types.js';
 export declare function isKanidmOptions(opts: GetDirectoryAdapterOptions): opts is KanidmOptions;
 export declare function isStalwartOptions(opts: GetDirectoryAdapterOptions): opts is StalwartOptions;
 export declare function isPostgresOptions(opts: GetDirectoryAdapterOptions): opts is PostgresOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@happyvertical/directory",
-  "version": "0.101.2",
+  "version": "0.102.2",
   "description": "Unified directory services with adapter-based architecture (Kanidm, Stalwart, PostgreSQL, AWS)",
   "type": "module",
   "main": "./dist/index.js",
@@ -24,7 +24,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@happyvertical/utils": "0.101.2",
+    "@happyvertical/utils": "0.102.2",
     "@aws-sdk/client-iam": "^3.1034.0",
     "@aws-sdk/client-organizations": "^3.1034.0",
     "@aws-sdk/client-sts": "^3.1034.0",