dominus-sdk-nodejs 1.24.0 → 1.24.2
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/README.md +68 -47
- package/dist/namespaces/db.d.ts +18 -4
- package/dist/namespaces/db.d.ts.map +1 -1
- package/dist/namespaces/db.js +20 -12
- package/dist/namespaces/db.js.map +1 -1
- package/dist/namespaces/workflow.d.ts +35 -30
- package/dist/namespaces/workflow.d.ts.map +1 -1
- package/dist/namespaces/workflow.js +38 -36
- package/dist/namespaces/workflow.js.map +1 -1
- package/docs/architecture.md +105 -34
- package/docs/routes-services.md +67 -0
- package/docs/usage-reference.md +550 -0
- package/package.json +1 -1
- package/docs/development.md +0 -30
- package/docs/namespaces.md +0 -38
|
@@ -0,0 +1,550 @@
|
|
|
1
|
+
# SDK Usage Reference
|
|
2
|
+
|
|
3
|
+
Generated from `src/namespaces/**/*.ts` method signatures and JSDoc comments.
|
|
4
|
+
|
|
5
|
+
Total namespaced commands: **367**.
|
|
6
|
+
|
|
7
|
+
Columns: `Command` is the method path on the singleton, `Params` is the expected parameter signature, `Returns` is the declared TypeScript return type, `Route` is the backend endpoint (or local behavior), and `What it does` is the method summary.
|
|
8
|
+
|
|
9
|
+
## dominus.secrets
|
|
10
|
+
|
|
11
|
+
Source: `src/namespaces/secrets.ts` (SecretsNamespace)
|
|
12
|
+
|
|
13
|
+
| Command | Params | Returns | Route | What it does |
|
|
14
|
+
|---|---|---|---|---|
|
|
15
|
+
| `dominus.secrets.get` | `key: string` | `Promise<string \| undefined>` | `POST /api/warden/secrets` | Get a secret value. |
|
|
16
|
+
| `dominus.secrets.upsert` | `key: string, value: string, comment?: string` | `Promise<UpsertResult>` | `POST /api/warden/secrets` | Create or update a secret. |
|
|
17
|
+
| `dominus.secrets.list` | `prefix?: string` | `Promise<Array<Record<string, unknown>>>` | `POST /api/warden/secrets` | List secrets, optionally filtered by prefix. |
|
|
18
|
+
| `dominus.secrets.delete` | `key: string` | `Promise<Record<string, unknown>>` | `POST /api/warden/secrets` | Delete a secret. |
|
|
19
|
+
|
|
20
|
+
## dominus.db
|
|
21
|
+
|
|
22
|
+
Source: `src/namespaces/db.ts` (DbNamespace)
|
|
23
|
+
|
|
24
|
+
| Command | Params | Returns | Route | What it does |
|
|
25
|
+
|---|---|---|---|---|
|
|
26
|
+
| `dominus.db.schemas` | `options?: { open?: boolean }` | `Promise<string[]>` | `POST /api/database/schemas` | List accessible schemas. |
|
|
27
|
+
| `dominus.db.tables` | `schema?: string, options?: { open?: boolean }` | `Promise<TableInfo[]>` | `POST /api/database/tables` | List tables in a schema. |
|
|
28
|
+
| `dominus.db.columns` | `table: string, schema?: string, options?: { open?: boolean }` | `Promise<ColumnInfo[]>` | `POST /api/database/columns` | List columns in a table. |
|
|
29
|
+
| `dominus.db.query` | `table: string, options?: QueryOptions` | `Promise<QueryResult>` | `POST /api/database/select` | Query table data with filtering, sorting, and pagination. |
|
|
30
|
+
| `dominus.db.insert` | `table: string, data: Record<string, unknown>, options?: { schema?: string; open?: boolean; reason?: string; actor?: string }` | `Promise<Record<string, unknown>>` | `POST /api/database/insert` | Insert a row into a table. |
|
|
31
|
+
| `dominus.db.update` | `table: string, data: Record<string, unknown>, filters: Record<string, unknown>, options?: { schema?: string; open?: boolean; reason?: string; actor?: string }` | `Promise<{ affected_rows: number }>` | `POST /api/database/update` | Update rows matching filters. |
|
|
32
|
+
| `dominus.db.delete` | `table: string, filters: Record<string, unknown>, options?: { schema?: string; open?: boolean; reason?: string; actor?: string }` | `Promise<{ affected_rows: number }>` | `POST /api/database/delete` | Delete rows matching filters. |
|
|
33
|
+
| `dominus.db.raw` | `sql: string, params?: unknown[], options?: { schema?: string; open?: boolean; reason?: string; actor?: string; use_shared?: boolean }` | `Promise<QueryResult>` | `POST /api/database/raw` | Execute raw SQL queries. |
|
|
34
|
+
| `dominus.db.bulkInsert` | `table: string, rows: Array<Record<string, unknown>>, options?: { schema?: string; reason?: string; actor?: string }` | `Promise<{ inserted_count: number; rows?: Array<Record<string, unknown>> }>` | `POST /api/database/raw` | Insert multiple rows at once using a transaction. |
|
|
35
|
+
| `dominus.db.syncSchema` | `none` | `Promise<{ success: boolean; schemas_synced: string[]; tables_created: string[]; indexes_created: string[]; errors: string[]; seeding?: { success: boolean; seeded_entities: string[]; }; }>` | `POST /api/provision/sync` | Sync protected schemas to factory default. |
|
|
36
|
+
|
|
37
|
+
## dominus.secure
|
|
38
|
+
|
|
39
|
+
Source: `src/namespaces/secure.ts` (SecureNamespace)
|
|
40
|
+
|
|
41
|
+
| Command | Params | Returns | Route | What it does |
|
|
42
|
+
|---|---|---|---|---|
|
|
43
|
+
| `dominus.secure.tables` | `schema?: string` | `Promise<TableInfo[]>` | `GET /api/scribe/data/${schema}/tables` | List tables in a schema. |
|
|
44
|
+
| `dominus.secure.columns` | `table: string, schema?: string` | `Promise<ColumnInfo[]>` | `GET /api/scribe/data/${schema}/${table}/columns` | List columns in a table. |
|
|
45
|
+
| `dominus.secure.query` | `table: string, context: SecureAccessContext, options?: SecureQueryOptions` | `Promise<QueryResult>` | `POST /api/scribe/data/${schema}/${table}/query` | Query secure table data with audit logging. |
|
|
46
|
+
| `dominus.secure.insert` | `table: string, data: Record<string, unknown>, context: SecureAccessContext, schema?: string` | `Promise<Record<string, unknown>>` | `POST /api/scribe/data/${schema}/${table}/insert` | Insert a row into a secure table with audit logging. |
|
|
47
|
+
| `dominus.secure.update` | `table: string, data: Record<string, unknown>, filters: Record<string, unknown>, context: SecureAccessContext, schema?: string` | `Promise<{ affected_rows: number }>` | `POST /api/scribe/data/${schema}/${table}/update` | Update rows in a secure table with audit logging. |
|
|
48
|
+
| `dominus.secure.delete` | `table: string, filters: Record<string, unknown>, context: SecureAccessContext, schema?: string` | `Promise<{ affected_rows: number }>` | `POST /api/scribe/data/${schema}/${table}/delete` | Delete rows from a secure table with audit logging. |
|
|
49
|
+
| `dominus.secure.bulkInsert` | `table: string, rows: Array<Record<string, unknown>>, context: SecureAccessContext, schema?: string` | `Promise<{ inserted_count: number; rows?: Array<Record<string, unknown>> }>` | `POST /api/scribe/data/${schema}/${table}/bulk-insert` | Insert multiple rows into a secure table with audit logging. |
|
|
50
|
+
|
|
51
|
+
## dominus.redis
|
|
52
|
+
|
|
53
|
+
Source: `src/namespaces/redis.ts` (RedisNamespace)
|
|
54
|
+
|
|
55
|
+
| Command | Params | Returns | Route | What it does |
|
|
56
|
+
|---|---|---|---|---|
|
|
57
|
+
| `dominus.redis.set` | `key: string, value: unknown, ttl?: number, category?: string` | `Promise<SetResult>` | `POST /api/whisperer/set` | Set a value with TTL. |
|
|
58
|
+
| `dominus.redis.get` | `key: string, options?: { category?: string; nudge?: boolean; ttl?: number }` | `Promise<GetResult>` | `POST /api/whisperer/get` | Get a value, optionally refreshing TTL. |
|
|
59
|
+
| `dominus.redis.delete` | `key: string, category?: string` | `Promise<{ deleted: boolean }>` | `POST /api/whisperer/delete` | Delete a key. |
|
|
60
|
+
| `dominus.redis.list` | `options?: { prefix?: string; category?: string; limit?: number; cursor?: string; }` | `Promise<ListResult>` | `POST /api/whisperer/list` | List keys by prefix with pagination. |
|
|
61
|
+
| `dominus.redis.mget` | `keys: Array<{ logical_path: string; category?: string }>` | `Promise<{ results: Array<GetResult> }>` | `POST /api/whisperer/mget` | Get multiple keys at once. |
|
|
62
|
+
| `dominus.redis.setnx` | `key: string, value: unknown, ttl?: number, category?: string` | `Promise<SetnxResult>` | `POST /api/whisperer/setnx` | Set if not exists (for distributed locks). |
|
|
63
|
+
| `dominus.redis.incr` | `key: string, delta?: number, ttl?: number, category?: string` | `Promise<IncrResult>` | `POST /api/whisperer/incr` | Increment counter (creates if not exists). |
|
|
64
|
+
| `dominus.redis.hset` | `key: string, field: string, value: unknown, ttl?: number, category?: string` | `Promise<HsetResult>` | `POST /api/whisperer/hset` | Set a hash field. |
|
|
65
|
+
| `dominus.redis.hget` | `key: string, field: string, category?: string` | `Promise<GetResult>` | `POST /api/whisperer/hget` | Get a hash field. |
|
|
66
|
+
| `dominus.redis.hgetall` | `key: string, category?: string` | `Promise<HgetallResult>` | `POST /api/whisperer/hgetall` | Get all fields from a hash. |
|
|
67
|
+
| `dominus.redis.hdel` | `key: string, field: string, category?: string` | `Promise<{ deleted: boolean }>` | `POST /api/whisperer/hdel` | Delete a hash field. |
|
|
68
|
+
| `dominus.redis.type` | `key: string, category?: string` | `Promise<TypeResult>` | `POST /api/whisperer/type` | Get the Redis data type of a key. |
|
|
69
|
+
| `dominus.redis.smembers` | `key: string, category?: string` | `Promise<SmembersResult>` | `POST /api/whisperer/smembers` | Get all members of a Redis set. |
|
|
70
|
+
| `dominus.redis.lrange` | `key: string, options?: { start?: number; stop?: number; category?: string }` | `Promise<LrangeResult>` | `POST /api/whisperer/lrange` | Get a range of items from a Redis list. |
|
|
71
|
+
|
|
72
|
+
## dominus.files
|
|
73
|
+
|
|
74
|
+
Source: `src/namespaces/files.ts` (FilesNamespace)
|
|
75
|
+
|
|
76
|
+
| Command | Params | Returns | Route | What it does |
|
|
77
|
+
|---|---|---|---|---|
|
|
78
|
+
| `dominus.files.upload` | `data: Buffer, filename: string, options?: { contentType?: string; category?: string; path?: string; tags?: Record<string, string>; compliance?: boolean; actor?: string; retentionDays?: number; }` | `Promise<UploadResult>` | `POST /api/archivist/upload` | Upload a file to object storage. |
|
|
79
|
+
| `dominus.files.download` | `options: FileInfo & { expiresSeconds?: number }` | `Promise<DownloadResult>` | `POST /api/archivist/download` | Get a presigned download URL for a file. |
|
|
80
|
+
| `dominus.files.fetch` | `options: FileInfo` | `Promise<FetchResult>` | `POST /api/archivist/fetch` | Fetch file content directly. |
|
|
81
|
+
| `dominus.files.list` | `options?: { category?: string; prefix?: string; limit?: number; cursor?: string; }` | `Promise<ListResult>` | `POST /api/archivist/list` | List files with optional filtering. |
|
|
82
|
+
| `dominus.files.delete` | `options: FileInfo` | `Promise<{ deleted: boolean }>` | `POST /api/archivist/delete` | Delete a file. |
|
|
83
|
+
| `dominus.files.move` | `fileId: string, options: { newCategory?: string; newPath?: string }` | `Promise<Record<string, unknown>>` | `POST /api/archivist/move` | Move or rename a file. |
|
|
84
|
+
| `dominus.files.updateMeta` | `fileId: string, options: { tags?: Record<string, string>; description?: string }` | `Promise<Record<string, unknown>>` | `POST /api/archivist/update` | Update file metadata. |
|
|
85
|
+
| `dominus.files.browse` | `options: { category: string; path?: string; includeSubfolders?: boolean; limit?: number; cursor?: string; }` | `Promise<BrowseResult>` | `POST /api/archivist/browse` | Browse storage with hierarchical navigation. |
|
|
86
|
+
| `dominus.files.getStorageStats` | `none` | `Promise<StorageStats>` | `POST /api/archivist/stats` | Get storage statistics. |
|
|
87
|
+
| `dominus.files.listCategories` | `none` | `Promise<CategoriesResponse>` | `POST /api/archivist/categories` | List all categories (root folders) in storage. |
|
|
88
|
+
| `dominus.files.listViews` | `options?: { userScopes?: string[]; activeTenant?: string; }` | `Promise<ViewsResult>` | `POST /api/archivist/views` | List storage views filtered by user access. |
|
|
89
|
+
| `dominus.files.listCategoriesInView` | `view: string` | `Promise<CategoriesResponse>` | `POST /api/archivist/view-categories` | List categories within a specific view (scope). |
|
|
90
|
+
| `dominus.files.createFolder` | `options: { category: string; path: string; }` | `Promise<CreateFolderResult>` | `POST /api/archivist/folder` | Create a virtual folder. |
|
|
91
|
+
| `dominus.files.deleteFolder` | `options: { category: string; path: string; force?: boolean; }` | `Promise<DeleteFolderResult>` | `DELETE /api/archivist/folder` | Delete a virtual folder and all its contents. |
|
|
92
|
+
| `dominus.files.factoryReset` | `options?: { force?: boolean; reinitializeStructure?: boolean; }` | `Promise<FactoryResetResult>` | `POST /api/admin/factory-reset-storage` | Factory reset - delete ALL objects in the project/environment. |
|
|
93
|
+
|
|
94
|
+
## dominus.auth
|
|
95
|
+
|
|
96
|
+
Source: `src/namespaces/auth.ts` (AuthNamespace)
|
|
97
|
+
|
|
98
|
+
| Command | Params | Returns | Route | What it does |
|
|
99
|
+
|---|---|---|---|---|
|
|
100
|
+
| `dominus.auth.createUser` | `params: { username: string; email: string; password?: string; passwordHash?: string; status?: string; emailVerified?: boolean; isSystem?: boolean; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/users` | Execute create user. |
|
|
101
|
+
| `dominus.auth.getUser` | `userId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/users/${userId}` | Execute get user. |
|
|
102
|
+
| `dominus.auth.listUsers` | `params?: { status?: string; limit?: number; offset?: number; orderBy?: string; orderDesc?: boolean; includeSystem?: boolean; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/users${queryParams}` | Execute list users. |
|
|
103
|
+
| `dominus.auth.updateUser` | `userId: string, data: { username?: string; email?: string; status?: string; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/users/${userId}` | Execute update user. |
|
|
104
|
+
| `dominus.auth.deleteUser` | `userId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/users/${userId}` | Execute delete user. |
|
|
105
|
+
| `dominus.auth.updatePassword` | `userId: string, password: string` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/users/${userId}/password` | Execute update password. |
|
|
106
|
+
| `dominus.auth.verifyPassword` | `userId: string, password: string` | `Promise<Record<string, unknown>>` | `POST /api/guardian/users/${userId}/verify-password` | Execute verify password. |
|
|
107
|
+
| `dominus.auth.getUserProfile` | `userId: string` | `Promise<Record<string, unknown> \| null>` | `GET /api/guardian/user-profiles?user_id=${userId}&limit=1` | Execute get user profile. |
|
|
108
|
+
| `dominus.auth.createUserProfile` | `data: { user_id: string; first_name?: string; last_name?: string; display_name?: string; avatar_url?: string; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/user-profiles` | Execute create user profile. |
|
|
109
|
+
| `dominus.auth.updateUserProfile` | `profileId: string, data: { first_name?: string; last_name?: string; display_name?: string; avatar_url?: string; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/user-profiles/${profileId}` | Execute update user profile. |
|
|
110
|
+
| `dominus.auth.getUserRoles` | `userId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/users/${userId}/roles` | Execute get user roles. |
|
|
111
|
+
| `dominus.auth.addUserRoles` | `userId: string, roleIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/users/${userId}/roles` | Execute add user roles. |
|
|
112
|
+
| `dominus.auth.removeUserRoles` | `userId: string, roleIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/users/${userId}/roles` | Execute remove user roles. |
|
|
113
|
+
| `dominus.auth.getUserScopes` | `userId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/users/${userId}/scopes` | Execute get user scopes. |
|
|
114
|
+
| `dominus.auth.addUserScopes` | `userId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/users/${userId}/scopes` | Execute add user scopes. |
|
|
115
|
+
| `dominus.auth.removeUserScopes` | `userId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/users/${userId}/scopes` | Execute remove user scopes. |
|
|
116
|
+
| `dominus.auth.getUserTenants` | `userId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/users/${userId}/tenants` | Execute get user tenants. |
|
|
117
|
+
| `dominus.auth.addUserTenants` | `userId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/users/${userId}/tenants` | Execute add user tenants. |
|
|
118
|
+
| `dominus.auth.removeUserTenants` | `userId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/users/${userId}/tenants` | Execute remove user tenants. |
|
|
119
|
+
| `dominus.auth.getUserSubtypes` | `userId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/users/${userId}/subtypes` | Execute get user subtypes. |
|
|
120
|
+
| `dominus.auth.addUserSubtypes` | `userId: string, subtypeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/users/${userId}/subtypes` | Execute add user subtypes. |
|
|
121
|
+
| `dominus.auth.removeUserSubtypes` | `userId: string, subtypeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/users/${userId}/subtypes` | Execute remove user subtypes. |
|
|
122
|
+
| `dominus.auth.createRole` | `params: { name: string; description?: string; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/roles` | Execute create role. |
|
|
123
|
+
| `dominus.auth.getRole` | `roleId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/roles/${roleId}` | Execute get role. |
|
|
124
|
+
| `dominus.auth.listRoles` | `params?: { limit?: number; offset?: number; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/roles?limit=${limit}&offset=${offset}` | Execute list roles. |
|
|
125
|
+
| `dominus.auth.updateRole` | `roleId: string, data: { name?: string; description?: string; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/roles/${roleId}` | Execute update role. |
|
|
126
|
+
| `dominus.auth.deleteRole` | `roleId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/roles/${roleId}` | Execute delete role. |
|
|
127
|
+
| `dominus.auth.getRoleScopes` | `roleId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/roles/${roleId}/scopes` | Execute get role scopes. |
|
|
128
|
+
| `dominus.auth.addRoleScopes` | `roleId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/roles/${roleId}/scopes` | Execute add role scopes. |
|
|
129
|
+
| `dominus.auth.removeRoleScopes` | `roleId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/roles/${roleId}/scopes` | Execute remove role scopes. |
|
|
130
|
+
| `dominus.auth.getRoleTenants` | `roleId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/roles/${roleId}/tenants` | Execute get role tenants. |
|
|
131
|
+
| `dominus.auth.addRoleTenants` | `roleId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/roles/${roleId}/tenants` | Execute add role tenants. |
|
|
132
|
+
| `dominus.auth.removeRoleTenants` | `roleId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/roles/${roleId}/tenants` | Execute remove role tenants. |
|
|
133
|
+
| `dominus.auth.getRoleCategories` | `roleId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/roles/${roleId}/categories` | Execute get role categories. |
|
|
134
|
+
| `dominus.auth.addRoleCategories` | `roleId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/roles/${roleId}/categories` | Execute add role categories. |
|
|
135
|
+
| `dominus.auth.removeRoleCategories` | `roleId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/roles/${roleId}/categories` | Execute remove role categories. |
|
|
136
|
+
| `dominus.auth.getRoleSubtypes` | `roleId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/roles/${roleId}/subtypes` | Execute get role subtypes. |
|
|
137
|
+
| `dominus.auth.addRoleSubtypes` | `roleId: string, subtypeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/roles/${roleId}/subtypes` | Execute add role subtypes. |
|
|
138
|
+
| `dominus.auth.removeRoleSubtypes` | `roleId: string, subtypeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/roles/${roleId}/subtypes` | Execute remove role subtypes. |
|
|
139
|
+
| `dominus.auth.createScope` | `params: { slug: string; displayName: string; description?: string; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/scopes` | Execute create scope. |
|
|
140
|
+
| `dominus.auth.getScope` | `scopeId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/scopes/${scopeId}` | Execute get scope. |
|
|
141
|
+
| `dominus.auth.listScopes` | `params?: { limit?: number; offset?: number; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/scopes?limit=${limit}&offset=${offset}` | Execute list scopes. |
|
|
142
|
+
| `dominus.auth.updateScope` | `scopeId: string, data: { slug?: string; displayName?: string; description?: string; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/scopes/${scopeId}` | Execute update scope. |
|
|
143
|
+
| `dominus.auth.deleteScope` | `scopeId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/scopes/${scopeId}` | Execute delete scope. |
|
|
144
|
+
| `dominus.auth.getScopeTenants` | `scopeId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/scopes/${scopeId}/tenants` | Execute get scope tenants. |
|
|
145
|
+
| `dominus.auth.addScopeTenants` | `scopeId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/scopes/${scopeId}/tenants` | Execute add scope tenants. |
|
|
146
|
+
| `dominus.auth.removeScopeTenants` | `scopeId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/scopes/${scopeId}/tenants` | Execute remove scope tenants. |
|
|
147
|
+
| `dominus.auth.getScopeCategories` | `scopeId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/scopes/${scopeId}/categories` | Execute get scope categories. |
|
|
148
|
+
| `dominus.auth.addScopeCategories` | `scopeId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/scopes/${scopeId}/categories` | Execute add scope categories. |
|
|
149
|
+
| `dominus.auth.removeScopeCategories` | `scopeId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/scopes/${scopeId}/categories` | Execute remove scope categories. |
|
|
150
|
+
| `dominus.auth.createClient` | `params: { label: string; description?: string; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/clients` | Execute create client. |
|
|
151
|
+
| `dominus.auth.getClient` | `clientId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/clients/${clientId}` | Execute get client. |
|
|
152
|
+
| `dominus.auth.listClients` | `params?: { limit?: number; offset?: number; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/clients?limit=${limit}&offset=${offset}` | Execute list clients. |
|
|
153
|
+
| `dominus.auth.updateClient` | `clientId: string, data: { label?: string; description?: string; status?: string; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/clients/${clientId}` | Execute update client. |
|
|
154
|
+
| `dominus.auth.deleteClient` | `clientId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/clients/${clientId}` | Execute delete client. |
|
|
155
|
+
| `dominus.auth.regeneratePsk` | `clientId: string` | `Promise<Record<string, unknown>>` | `POST /api/guardian/clients/${clientId}/regenerate-psk` | Execute regenerate psk. |
|
|
156
|
+
| `dominus.auth.verifyPsk` | `clientId: string, psk: string` | `Promise<Record<string, unknown>>` | `POST /api/guardian/clients/${clientId}/verify-psk` | Execute verify psk. |
|
|
157
|
+
| `dominus.auth.getClientTenants` | `clientId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/clients/${clientId}/tenants` | Execute get client tenants. |
|
|
158
|
+
| `dominus.auth.addClientTenants` | `clientId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/clients/${clientId}/tenants` | Execute add client tenants. |
|
|
159
|
+
| `dominus.auth.removeClientTenants` | `clientId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/clients/${clientId}/tenants` | Execute remove client tenants. |
|
|
160
|
+
| `dominus.auth.getClientRoles` | `clientId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/clients/${clientId}/roles` | Execute get client roles. |
|
|
161
|
+
| `dominus.auth.addClientRoles` | `clientId: string, roleIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/clients/${clientId}/roles` | Execute add client roles. |
|
|
162
|
+
| `dominus.auth.removeClientRoles` | `clientId: string, roleIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/clients/${clientId}/roles` | Execute remove client roles. |
|
|
163
|
+
| `dominus.auth.getClientScopes` | `clientId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/clients/${clientId}/scopes` | Execute get client scopes. |
|
|
164
|
+
| `dominus.auth.addClientScopes` | `clientId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/clients/${clientId}/scopes` | Execute add client scopes. |
|
|
165
|
+
| `dominus.auth.removeClientScopes` | `clientId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/clients/${clientId}/scopes` | Execute remove client scopes. |
|
|
166
|
+
| `dominus.auth.getClientSubtypes` | `clientId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/clients/${clientId}/subtypes` | Execute get client subtypes. |
|
|
167
|
+
| `dominus.auth.addClientSubtypes` | `clientId: string, subtypeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/clients/${clientId}/subtypes` | Execute add client subtypes. |
|
|
168
|
+
| `dominus.auth.removeClientSubtypes` | `clientId: string, subtypeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/clients/${clientId}/subtypes` | Execute remove client subtypes. |
|
|
169
|
+
| `dominus.auth.createTenant` | `params: { name: string; slug: string; categoryId?: string; shortname?: string; description?: string; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/tenants` | Execute create tenant. |
|
|
170
|
+
| `dominus.auth.getTenant` | `tenantId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/tenants/${tenantId}` | Execute get tenant. |
|
|
171
|
+
| `dominus.auth.listTenants` | `params?: { status?: string; categoryId?: string; includeSystem?: boolean; limit?: number; offset?: number; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/tenants${queryParams}` | Execute list tenants. |
|
|
172
|
+
| `dominus.auth.updateTenant` | `tenantId: string, data: { name?: string; shortname?: string; description?: string; status?: string; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/tenants/${tenantId}` | Execute update tenant. |
|
|
173
|
+
| `dominus.auth.deleteTenant` | `tenantId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/tenants/${tenantId}` | Execute delete tenant. |
|
|
174
|
+
| `dominus.auth.createTenantCategory` | `params: { name: string; slug: string; description?: string; color?: string; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/tenant-categories` | Execute create tenant category. |
|
|
175
|
+
| `dominus.auth.getTenantCategory` | `categoryId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/tenant-categories/${categoryId}` | Execute get tenant category. |
|
|
176
|
+
| `dominus.auth.listTenantCategories` | `params?: { includeSystem?: boolean; limit?: number; offset?: number; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/tenant-categories${queryParams}` | Execute list tenant categories. |
|
|
177
|
+
| `dominus.auth.updateTenantCategory` | `categoryId: string, data: { name?: string; description?: string; color?: string; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/tenant-categories/${categoryId}` | Execute update tenant category. |
|
|
178
|
+
| `dominus.auth.deleteTenantCategory` | `categoryId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/tenant-categories/${categoryId}` | Execute delete tenant category. |
|
|
179
|
+
| `dominus.auth.createSubtype` | `params: { name: string; slug: string; description?: string; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/subtypes` | Execute create subtype. |
|
|
180
|
+
| `dominus.auth.getSubtype` | `subtypeId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/subtypes/${subtypeId}` | Execute get subtype. |
|
|
181
|
+
| `dominus.auth.listSubtypes` | `params?: { limit?: number; offset?: number; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/subtypes?limit=${limit}&offset=${offset}` | Execute list subtypes. |
|
|
182
|
+
| `dominus.auth.updateSubtype` | `subtypeId: string, data: { name?: string; description?: string; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/subtypes/${subtypeId}` | Execute update subtype. |
|
|
183
|
+
| `dominus.auth.deleteSubtype` | `subtypeId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/subtypes/${subtypeId}` | Execute delete subtype. |
|
|
184
|
+
| `dominus.auth.getSubtypeTenants` | `subtypeId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/subtypes/${subtypeId}/tenants` | Execute get subtype tenants. |
|
|
185
|
+
| `dominus.auth.addSubtypeTenants` | `subtypeId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/subtypes/${subtypeId}/tenants` | Execute add subtype tenants. |
|
|
186
|
+
| `dominus.auth.removeSubtypeTenants` | `subtypeId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/subtypes/${subtypeId}/tenants` | Execute remove subtype tenants. |
|
|
187
|
+
| `dominus.auth.getSubtypeCategories` | `subtypeId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/subtypes/${subtypeId}/categories` | Execute get subtype categories. |
|
|
188
|
+
| `dominus.auth.addSubtypeCategories` | `subtypeId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/subtypes/${subtypeId}/categories` | Execute add subtype categories. |
|
|
189
|
+
| `dominus.auth.removeSubtypeCategories` | `subtypeId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/subtypes/${subtypeId}/categories` | Execute remove subtype categories. |
|
|
190
|
+
| `dominus.auth.getSubtypeScopes` | `subtypeId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/subtypes/${subtypeId}/scopes` | Execute get subtype scopes. |
|
|
191
|
+
| `dominus.auth.addSubtypeScopes` | `subtypeId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/subtypes/${subtypeId}/scopes` | Execute add subtype scopes. |
|
|
192
|
+
| `dominus.auth.removeSubtypeScopes` | `subtypeId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/subtypes/${subtypeId}/scopes` | Execute remove subtype scopes. |
|
|
193
|
+
| `dominus.auth.createPage` | `params: { path: string; name: string; description?: string; isActive?: boolean; showInNav?: boolean; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/pages` | Execute create page. |
|
|
194
|
+
| `dominus.auth.getPage` | `pageId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/pages/${pageId}` | Execute get page. |
|
|
195
|
+
| `dominus.auth.listPages` | `params?: { isActive?: boolean; limit?: number; offset?: number; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/pages${queryParams}` | Execute list pages. |
|
|
196
|
+
| `dominus.auth.updatePage` | `pageId: string, data: { path?: string; name?: string; description?: string; isActive?: boolean; showInNav?: boolean; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/pages/${pageId}` | Execute update page. |
|
|
197
|
+
| `dominus.auth.deletePage` | `pageId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/pages/${pageId}` | Execute delete page. |
|
|
198
|
+
| `dominus.auth.getPageTenants` | `pageId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/pages/${pageId}/tenants` | Execute get page tenants. |
|
|
199
|
+
| `dominus.auth.addPageTenants` | `pageId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/pages/${pageId}/tenants` | Execute add page tenants. |
|
|
200
|
+
| `dominus.auth.removePageTenants` | `pageId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/pages/${pageId}/tenants` | Execute remove page tenants. |
|
|
201
|
+
| `dominus.auth.setPageTenants` | `pageId: string, tenantIds: string[]` | `Promise<Array<Record<string, unknown>>>` | `PUT /api/guardian/pages/${pageId}/tenants` | Execute set page tenants. |
|
|
202
|
+
| `dominus.auth.getPageScopes` | `pageId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/pages/${pageId}/scopes` | Execute get page scopes. |
|
|
203
|
+
| `dominus.auth.addPageScopes` | `pageId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/pages/${pageId}/scopes` | Execute add page scopes. |
|
|
204
|
+
| `dominus.auth.removePageScopes` | `pageId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/pages/${pageId}/scopes` | Execute remove page scopes. |
|
|
205
|
+
| `dominus.auth.setPageScopes` | `pageId: string, scopeIds: string[]` | `Promise<Array<Record<string, unknown>>>` | `PUT /api/guardian/pages/${pageId}/scopes` | Execute set page scopes. |
|
|
206
|
+
| `dominus.auth.getPageCategories` | `pageId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/pages/${pageId}/categories` | Execute get page categories. |
|
|
207
|
+
| `dominus.auth.addPageCategories` | `pageId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/pages/${pageId}/categories` | Execute add page categories. |
|
|
208
|
+
| `dominus.auth.removePageCategories` | `pageId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/pages/${pageId}/categories` | Execute remove page categories. |
|
|
209
|
+
| `dominus.auth.setPageCategories` | `pageId: string, categoryIds: string[]` | `Promise<Array<Record<string, unknown>>>` | `PUT /api/guardian/pages/${pageId}/categories` | Execute set page categories. |
|
|
210
|
+
| `dominus.auth.getPageExcludedScopes` | `pageId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/pages/${pageId}/excluded-scopes` | Execute get page excluded scopes. |
|
|
211
|
+
| `dominus.auth.addPageExcludedScopes` | `pageId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/pages/${pageId}/excluded-scopes` | Execute add page excluded scopes. |
|
|
212
|
+
| `dominus.auth.removePageExcludedScopes` | `pageId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/pages/${pageId}/excluded-scopes` | Execute remove page excluded scopes. |
|
|
213
|
+
| `dominus.auth.setPageExcludedScopes` | `pageId: string, scopeIds: string[]` | `Promise<Array<Record<string, unknown>>>` | `PUT /api/guardian/pages/${pageId}/excluded-scopes` | Execute set page excluded scopes. |
|
|
214
|
+
| `dominus.auth.getPageExcludedRoles` | `pageId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/pages/${pageId}/excluded-roles` | Execute get page excluded roles. |
|
|
215
|
+
| `dominus.auth.addPageExcludedRoles` | `pageId: string, roleIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/pages/${pageId}/excluded-roles` | Execute add page excluded roles. |
|
|
216
|
+
| `dominus.auth.removePageExcludedRoles` | `pageId: string, roleIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/pages/${pageId}/excluded-roles` | Execute remove page excluded roles. |
|
|
217
|
+
| `dominus.auth.setPageExcludedRoles` | `pageId: string, roleIds: string[]` | `Promise<Array<Record<string, unknown>>>` | `PUT /api/guardian/pages/${pageId}/excluded-roles` | Execute set page excluded roles. |
|
|
218
|
+
| `dominus.auth.getBatchJunctions` | `entity: string, junctions: string[]` | `Promise<Record<string, unknown>>` | `GET /api/guardian/${entity}/batch-junctions?junctions=${encodeURIComponent(junctionsParam)}` | Batch-fetch all junction data for an entity type. |
|
|
219
|
+
| `dominus.auth.createNavItem` | `params: { title: string; icon?: string; description?: string; pageId?: string; parentId?: string; itemType?: 'link' \| 'header' \| 'group_label'; isActive?: boolean; sortOrder?: number; isExpandedDefault?: boolean; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/nav-items` | Execute create nav item. |
|
|
220
|
+
| `dominus.auth.getNavItem` | `navId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/nav-items/${navId}` | Execute get nav item. |
|
|
221
|
+
| `dominus.auth.listNavItems` | `params?: { tenantId?: string; parentId?: string; isActive?: boolean; limit?: number; offset?: number; orderBy?: string; orderDesc?: boolean; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/nav-items?${queryParams.toString()}` | Execute list nav items. |
|
|
222
|
+
| `dominus.auth.updateNavItem` | `navId: string, data: { title?: string; icon?: string \| null; description?: string \| null; pageId?: string \| null; parentId?: string \| null; itemType?: 'link' \| 'header' \| 'group_label'; isActive?: boolean; sortOrder?: number; isExpandedDefault?: boolean; }` | `Promise<Record<string, unknown>>` | `PUT /api/guardian/nav-items/${navId}` | Execute update nav item. |
|
|
223
|
+
| `dominus.auth.deleteNavItem` | `navId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/nav-items/${navId}` | Execute delete nav item. |
|
|
224
|
+
| `dominus.auth.getNavScopes` | `navId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/nav-items/${navId}/scopes` | Execute get nav scopes. |
|
|
225
|
+
| `dominus.auth.addNavScopes` | `navId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/nav-items/${navId}/scopes` | Execute add nav scopes. |
|
|
226
|
+
| `dominus.auth.removeNavScopes` | `navId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/nav-items/${navId}/scopes` | Execute remove nav scopes. |
|
|
227
|
+
| `dominus.auth.getNavRoles` | `navId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/nav-items/${navId}/roles` | Execute get nav roles. |
|
|
228
|
+
| `dominus.auth.addNavRoles` | `navId: string, roleIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/nav-items/${navId}/roles` | Execute add nav roles. |
|
|
229
|
+
| `dominus.auth.removeNavRoles` | `navId: string, roleIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/nav-items/${navId}/roles` | Execute remove nav roles. |
|
|
230
|
+
| `dominus.auth.getNavSubtypes` | `navId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/nav-items/${navId}/subtypes` | Execute get nav subtypes. |
|
|
231
|
+
| `dominus.auth.addNavSubtypes` | `navId: string, subtypeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/nav-items/${navId}/subtypes` | Execute add nav subtypes. |
|
|
232
|
+
| `dominus.auth.removeNavSubtypes` | `navId: string, subtypeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/nav-items/${navId}/subtypes` | Execute remove nav subtypes. |
|
|
233
|
+
| `dominus.auth.getNavTenants` | `navId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/nav-items/${navId}/tenants` | Execute get nav tenants. |
|
|
234
|
+
| `dominus.auth.addNavTenants` | `navId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/nav-items/${navId}/tenants` | Execute add nav tenants. |
|
|
235
|
+
| `dominus.auth.removeNavTenants` | `navId: string, tenantIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/nav-items/${navId}/tenants` | Execute remove nav tenants. |
|
|
236
|
+
| `dominus.auth.getNavCategories` | `navId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/nav-items/${navId}/categories` | Execute get nav categories. |
|
|
237
|
+
| `dominus.auth.addNavCategories` | `navId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/nav-items/${navId}/categories` | Execute add nav categories. |
|
|
238
|
+
| `dominus.auth.removeNavCategories` | `navId: string, categoryIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/nav-items/${navId}/categories` | Execute remove nav categories. |
|
|
239
|
+
| `dominus.auth.createSecureTable` | `params: { tableName: string; schemaName?: string; }` | `Promise<Record<string, unknown>>` | `POST /api/guardian/secure-tables` | Execute create secure table. |
|
|
240
|
+
| `dominus.auth.getSecureTable` | `secureTableId: string` | `Promise<Record<string, unknown>>` | `GET /api/guardian/secure-tables/${secureTableId}` | Execute get secure table. |
|
|
241
|
+
| `dominus.auth.listSecureTables` | `params?: { limit?: number; offset?: number; }` | `Promise<Record<string, unknown>>` | `GET /api/guardian/secure-tables?limit=${limit}&offset=${offset}` | Execute list secure tables. |
|
|
242
|
+
| `dominus.auth.deleteSecureTable` | `secureTableId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/secure-tables/${secureTableId}` | Execute delete secure table. |
|
|
243
|
+
| `dominus.auth.getSecureTableScopes` | `secureTableId: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/guardian/secure-tables/${secureTableId}/scopes` | Execute get secure table scopes. |
|
|
244
|
+
| `dominus.auth.addSecureTableScopes` | `secureTableId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `POST /api/guardian/secure-tables/${secureTableId}/scopes` | Execute add secure table scopes. |
|
|
245
|
+
| `dominus.auth.removeSecureTableScopes` | `secureTableId: string, scopeIds: string[]` | `Promise<Record<string, unknown>>` | `DELETE /api/guardian/secure-tables/${secureTableId}/scopes` | Execute remove secure table scopes. |
|
|
246
|
+
| `dominus.auth.getJwks` | `none` | `Promise<Record<string, unknown>>` | `GET /api/warden/jwks (direct fetch; public endpoint)` | Get JWKS (JSON Web Key Set) for token verification. |
|
|
247
|
+
| `dominus.auth.validateJwt` | `token: string` | `Promise<Record<string, unknown>>` | `local verification (invokes getJwks cache when needed)` | Execute validate jwt. |
|
|
248
|
+
|
|
249
|
+
## dominus.ddl
|
|
250
|
+
|
|
251
|
+
Source: `src/namespaces/ddl.ts` (DdlNamespace)
|
|
252
|
+
|
|
253
|
+
| Command | Params | Returns | Route | What it does |
|
|
254
|
+
|---|---|---|---|---|
|
|
255
|
+
| `dominus.ddl.createTable` | `tableName: string, columns: ColumnDefinition[], schema?: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/schema/create-table` | Create a table in a schema. |
|
|
256
|
+
| `dominus.ddl.dropTable` | `tableName: string, schema?: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/schema/drop-table` | Drop a table from a schema. |
|
|
257
|
+
| `dominus.ddl.addColumn` | `tableName: string, column: ColumnDefinition, schema?: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/schema/add-column` | Add a column to a table. |
|
|
258
|
+
| `dominus.ddl.dropColumn` | `tableName: string, columnName: string, schema?: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/schema/drop-column` | Drop a column from a table. |
|
|
259
|
+
| `dominus.ddl.alterColumn` | `tableName: string, columnName: string, changes: { newType?: string; newDefault?: string; nullable?: boolean; }, schema?: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/schema/alter-column` | Alter a column in a table. |
|
|
260
|
+
| `dominus.ddl.createIndex` | `tableName: string, indexName: string, columns: string[], options?: { unique?: boolean; schema?: string }` | `Promise<Record<string, unknown>>` | `POST /api/smith/schema/create-index` | Create an index on a table. |
|
|
261
|
+
| `dominus.ddl.dropIndex` | `indexName: string, schema?: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/schema/drop-index` | Drop an index. |
|
|
262
|
+
| `dominus.ddl.categoryCreateTable` | `categorySlug: string, tableName: string, columns: ColumnDefinition[]` | `Promise<Record<string, unknown>>` | `POST /api/smith/category/create-table` | Create a table across all schemas in a category. |
|
|
263
|
+
| `dominus.ddl.categoryAddColumn` | `categorySlug: string, tableName: string, column: ColumnDefinition` | `Promise<Record<string, unknown>>` | `POST /api/smith/category/add-column` | Add a column across all schemas in a category. |
|
|
264
|
+
| `dominus.ddl.listMigrations` | `schema: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/smith/migrations/list/${schema}` | List migrations for a schema. |
|
|
265
|
+
| `dominus.ddl.listCategoryMigrations` | `categorySlug: string` | `Promise<Array<Record<string, unknown>>>` | `GET /api/smith/migrations/category/${categorySlug}/list` | List migrations for a category. |
|
|
266
|
+
| `dominus.ddl.applyMigration` | `schema: string, migrationId: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/migrations/apply` | Apply a specific migration to a schema. |
|
|
267
|
+
| `dominus.ddl.rollbackMigration` | `schema: string, migrationId: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/migrations/rollback` | Rollback a migration from a schema. |
|
|
268
|
+
| `dominus.ddl.provisionTenantSchema` | `tenantSlug: string, categorySlug?: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/provision/tenant-schema` | Provision a new tenant schema. |
|
|
269
|
+
| `dominus.ddl.provisionTenantFromCategory` | `tenantSlug: string, categorySlug: string` | `Promise<Record<string, unknown>>` | `POST /api/smith/provision/tenant-from-category` | Provision a tenant from a category template. |
|
|
270
|
+
| `dominus.ddl.getCategoryStructure` | `categorySlug: string` | `Promise<SchemaStructure>` | `GET /api/database/builder/category/${categorySlug}/structure` | Get schema structure for a category (for Schema Builder UI). |
|
|
271
|
+
| `dominus.ddl.getCategoryMigrationHistory` | `categorySlug: string` | `Promise<MigrationHistoryResponse>` | `GET /api/database/builder/category/${categorySlug}/migrations` | Get migration history for a category. |
|
|
272
|
+
| `dominus.ddl.previewMigration` | `categorySlug: string, operation: string, params: Record<string, unknown>, migrationName: string` | `Promise<MigrationPreview>` | `POST /api/database/builder/category/${categorySlug}/preview-migration` | Preview a migration before applying. |
|
|
273
|
+
| `dominus.ddl.applyBuilderMigration` | `categorySlug: string, operation: string, params: Record<string, unknown>, migrationName: string` | `Promise<MigrationResult>` | `POST /api/database/builder/category/${categorySlug}/apply-migration` | Apply a migration from Schema Builder. |
|
|
274
|
+
| `dominus.ddl.getMigrationFile` | `categorySlug: string, versionId: string` | `Promise<MigrationFileResponse>` | `GET /api/database/builder/category/${categorySlug}/migrations/${versionId}` | Get a specific migration file content from B2 storage. |
|
|
275
|
+
| `dominus.ddl.getTenantSyncStatus` | `categorySlug: string` | `Promise<SyncStatusResponse>` | `GET /api/database/builder/category/${categorySlug}/sync-status` | Get sync status for all tenants in a category. |
|
|
276
|
+
| `dominus.ddl.syncTenantsToLatest` | `categorySlug: string` | `Promise<SyncTenantsResult>` | `POST /api/database/builder/category/${categorySlug}/sync-tenants` | Sync all tenants in a category to the latest migration version. |
|
|
277
|
+
| `dominus.ddl.resetCategorySchema` | `categorySlug: string` | `Promise<ResetCategoryResult>` | `DELETE /api/database/builder/category/${categorySlug}/reset` | Factory reset a category's schema. |
|
|
278
|
+
| `dominus.ddl.resetTenantSchema` | `categorySlug: string, tenantSlug: string` | `Promise<ResetTenantResult>` | `DELETE /api/database/builder/category/${categorySlug}/tenants/${tenantSlug}/reset` | Reset a single tenant's schema to blank. |
|
|
279
|
+
| `dominus.ddl.deleteMigration` | `categorySlug: string, versionId: string` | `Promise<DeleteMigrationResult>` | `DELETE /api/database/builder/category/${categorySlug}/migrations/${versionId}` | Delete a single migration file from B2 storage. |
|
|
280
|
+
|
|
281
|
+
## dominus.logs
|
|
282
|
+
|
|
283
|
+
Source: `src/namespaces/logs.ts` (LogsNamespace)
|
|
284
|
+
|
|
285
|
+
| Command | Params | Returns | Route | What it does |
|
|
286
|
+
|---|---|---|---|---|
|
|
287
|
+
| `dominus.logs.debug` | `message: string, context?: LogContext, category?: string` | `Promise<boolean>` | `POST /api/logs/ingest (delegates to _log)` | Log debug message. |
|
|
288
|
+
| `dominus.logs.info` | `message: string, context?: LogContext, category?: string` | `Promise<boolean>` | `POST /api/logs/ingest (delegates to _log)` | Log info message. |
|
|
289
|
+
| `dominus.logs.notice` | `message: string, context?: LogContext, category?: string` | `Promise<boolean>` | `POST /api/logs/ingest (delegates to _log)` | Log notice message. |
|
|
290
|
+
| `dominus.logs.warn` | `message: string, context?: LogContext, category?: string` | `Promise<boolean>` | `POST /api/logs/ingest (delegates to _log)` | Log warning message. |
|
|
291
|
+
| `dominus.logs.error` | `message: string, context?: LogContext, options?: { category?: string; exception?: Error }` | `Promise<boolean>` | `POST /api/logs/ingest (delegates to _log)` | Log error message. |
|
|
292
|
+
| `dominus.logs.critical` | `message: string, context?: LogContext, options?: { category?: string; exception?: Error }` | `Promise<boolean>` | `POST /api/logs/ingest (delegates to _log)` | Log critical message. |
|
|
293
|
+
| `dominus.logs.tail` | `options?: { minutes?: number; limit?: number; }` | `Promise<LogEvent[]>` | `GET /api/logs/tail${qs}` | Tail recent logs from the Logs Worker. |
|
|
294
|
+
| `dominus.logs.query` | `options?: { minutes?: number; limit?: number; }` | `Promise<LogEvent[]>` | `GET /api/logs/tail (alias of logs.tail)` | Query logs — alias for tail(). |
|
|
295
|
+
| `dominus.logs.batch` | `events: Array<{ level: string; message: string; context?: LogContext; category?: string; }>` | `Promise<BatchResult>` | `POST /api/logs/ingest` | Send multiple log events in one request. |
|
|
296
|
+
|
|
297
|
+
## dominus.portal
|
|
298
|
+
|
|
299
|
+
Source: `src/namespaces/portal.ts` (PortalNamespace)
|
|
300
|
+
|
|
301
|
+
| Command | Params | Returns | Route | What it does |
|
|
302
|
+
|---|---|---|---|---|
|
|
303
|
+
| `dominus.portal.login` | `username: string, password: string, tenantId?: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/auth/login` | Login user with password. |
|
|
304
|
+
| `dominus.portal.loginClient` | `psk: string, tenantId?: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/auth/login-client` | Login service client with PSK. |
|
|
305
|
+
| `dominus.portal.logout` | `userToken?: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/auth/logout` | End session and clear cookie. |
|
|
306
|
+
| `dominus.portal.refresh` | `userToken?: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/auth/refresh` | Refresh JWT token using existing session. |
|
|
307
|
+
| `dominus.portal.me` | `userToken?: string` | `Promise<Record<string, unknown>>` | `GET /api/portal/auth/me` | Get current user/client info. |
|
|
308
|
+
| `dominus.portal.switchTenant` | `tenantId: string, userToken?: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/auth/switch-tenant` | Switch active tenant context. |
|
|
309
|
+
| `dominus.portal.changePassword` | `currentPassword: string, newPassword: string, userToken?: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/security/change-password` | Change current user's password. |
|
|
310
|
+
| `dominus.portal.requestPasswordReset` | `email: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/security/request-reset` | Request password reset email. |
|
|
311
|
+
| `dominus.portal.confirmPasswordReset` | `token: string, newPassword: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/security/confirm-reset` | Confirm password reset with token. |
|
|
312
|
+
| `dominus.portal.listSessions` | `userToken?: string` | `Promise<Session[]>` | `GET /api/portal/security/sessions` | List all active sessions for current user. |
|
|
313
|
+
| `dominus.portal.revokeSession` | `sessionId: string, userToken?: string` | `Promise<Record<string, unknown>>` | `DELETE /api/portal/security/sessions/${sessionId}` | Revoke a specific session. |
|
|
314
|
+
| `dominus.portal.revokeAllSessions` | `userToken?: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/security/sessions/revoke-all` | Revoke all sessions except current. |
|
|
315
|
+
| `dominus.portal.getProfile` | `userToken?: string` | `Promise<Record<string, unknown>>` | `GET /api/portal/profile` | Get current user's profile. |
|
|
316
|
+
| `dominus.portal.updateProfile` | `params: { displayName?: string; avatarUrl?: string; bio?: string; phone?: string; extra?: Record<string, unknown>; }, userToken?: string` | `Promise<Record<string, unknown>>` | `PUT /api/portal/profile` | Update user profile. |
|
|
317
|
+
| `dominus.portal.getPreferences` | `userToken?: string` | `Promise<Record<string, unknown>>` | `GET /api/portal/profile/preferences` | Get current user's preferences. |
|
|
318
|
+
| `dominus.portal.updatePreferences` | `params: { theme?: string; language?: string; timezone?: string; sidebarCollapsed?: boolean; notificationsEnabled?: boolean; emailNotifications?: boolean; extra?: Record<string, unknown>; }, userToken?: string` | `Promise<Record<string, unknown>>` | `PUT /api/portal/profile/preferences` | Update user preferences. |
|
|
319
|
+
| `dominus.portal.getNavigation` | `userToken?: string, options?: { forceRefresh?: boolean }` | `Promise<NavigationResponse>` | `GET /api/portal/nav` | Get navigation tree for current user's tenant. |
|
|
320
|
+
| `dominus.portal.checkPageAccess` | `pagePath: string, userToken?: string` | `Promise<{ allowed: boolean; reason?: string }>` | `POST /api/portal/nav/check-access` | Check if current user can access a page. |
|
|
321
|
+
| `dominus.portal.register` | `username: string, email: string, password: string, tenantId: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/register` | Self-register new user. |
|
|
322
|
+
| `dominus.portal.verifyEmail` | `token: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/register/verify` | Verify email with token. |
|
|
323
|
+
| `dominus.portal.resendVerification` | `email: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/register/resend-verification` | Resend verification email. |
|
|
324
|
+
| `dominus.portal.acceptInvitation` | `token: string, password: string` | `Promise<Record<string, unknown>>` | `POST /api/portal/register/accept-invitation` | Accept admin invitation and set password. |
|
|
325
|
+
|
|
326
|
+
## dominus.courier
|
|
327
|
+
|
|
328
|
+
Source: `src/namespaces/courier.ts` (CourierNamespace)
|
|
329
|
+
|
|
330
|
+
| Command | Params | Returns | Route | What it does |
|
|
331
|
+
|---|---|---|---|---|
|
|
332
|
+
| `dominus.courier.send` | `templateAlias: string, to: string, fromEmail: string, model: Record<string, unknown>, options?: { tag?: string; replyTo?: string }` | `Promise<SendResult>` | `POST /api/courier/send` | Send email using Postmark template. |
|
|
333
|
+
| `dominus.courier.sendWelcome` | `to: string, fromEmail: string, params: { name: string; productName: string; actionUrl?: string; [key: string]: unknown; }` | `Promise<SendResult>` | `POST /api/courier/send (delegates to send)` | Send welcome email. |
|
|
334
|
+
| `dominus.courier.sendPasswordReset` | `to: string, fromEmail: string, params: { name: string; resetUrl: string; productName: string; [key: string]: unknown; }` | `Promise<SendResult>` | `POST /api/courier/send (delegates to send)` | Send password reset email. |
|
|
335
|
+
| `dominus.courier.sendEmailVerification` | `to: string, fromEmail: string, params: { name: string; verifyUrl: string; productName: string; [key: string]: unknown; }` | `Promise<SendResult>` | `POST /api/courier/send (delegates to send)` | Send email verification email. |
|
|
336
|
+
| `dominus.courier.sendInvitation` | `to: string, fromEmail: string, params: { name: string; inviteUrl: string; inviterName: string; productName: string; [key: string]: unknown; }` | `Promise<SendResult>` | `POST /api/courier/send (delegates to send)` | Send user invitation email. |
|
|
337
|
+
|
|
338
|
+
## dominus.open
|
|
339
|
+
|
|
340
|
+
Source: `src/namespaces/open.ts` (OpenNamespace)
|
|
341
|
+
|
|
342
|
+
| Command | Params | Returns | Route | What it does |
|
|
343
|
+
|---|---|---|---|---|
|
|
344
|
+
| `dominus.open.dsn` | `none` | `Promise<string>` | `GET /api/scribe/open/dsn` | Get the PostgreSQL connection DSN. |
|
|
345
|
+
| `dominus.open.execute` | `sql: string, params?: Record<string, unknown>` | `Promise<Record<string, unknown>>` | `POST /api/scribe/open/execute` | Execute raw SQL query. |
|
|
346
|
+
|
|
347
|
+
## dominus.health
|
|
348
|
+
|
|
349
|
+
Source: `src/namespaces/health.ts` (HealthNamespace)
|
|
350
|
+
|
|
351
|
+
| Command | Params | Returns | Route | What it does |
|
|
352
|
+
|---|---|---|---|---|
|
|
353
|
+
| `dominus.health.check` | `none` | `Promise<HealthStatus>` | `GET /api/health (direct fetch)` | Perform comprehensive health check of orchestrator and dependencies. |
|
|
354
|
+
| `dominus.health.ping` | `none` | `Promise<{ status: string }>` | `GET /api/health/ping` | Simple ping check (fastest response). |
|
|
355
|
+
| `dominus.health.warmup` | `none` | `Promise<Record<string, unknown>>` | `GET /api/health/warmup` | Warmup request (triggers cold start if needed). |
|
|
356
|
+
|
|
357
|
+
## dominus.stt
|
|
358
|
+
|
|
359
|
+
Source: `src/namespaces/oracle/index.ts` (OracleNamespace)
|
|
360
|
+
|
|
361
|
+
| Command | Params | Returns | Route | What it does |
|
|
362
|
+
|---|---|---|---|---|
|
|
363
|
+
| `dominus.stt.createSession` | `userToken: string, options?: OracleSessionOptions` | `OracleSession` | `WebSocket /api/oracle/stream (created by OracleSession)` | Create a streaming transcription session. |
|
|
364
|
+
|
|
365
|
+
## dominus.admin
|
|
366
|
+
|
|
367
|
+
Source: `src/namespaces/admin.ts` (AdminNamespace)
|
|
368
|
+
|
|
369
|
+
| Command | Params | Returns | Route | What it does |
|
|
370
|
+
|---|---|---|---|---|
|
|
371
|
+
| `dominus.admin.reseedAdminCategory` | `none` | `Promise<ReseedResult>` | `POST /api/admin/reseed-admin-category` | Reseed the Admin category baseline data. |
|
|
372
|
+
| `dominus.admin.resetAdminCategory` | `none` | `Promise<ResetResult>` | `DELETE /api/admin/reset-admin-category` | Factory reset the Admin category schema and reseed baseline data. |
|
|
373
|
+
| `dominus.admin.exportTokens` | `none` | `Promise<ExportTokensResult>` | `GET /api/admin/tokens/export` | Export hashed tokens from the platform database. |
|
|
374
|
+
| `dominus.admin.seedKV` | `none` | `Promise<SeedKVResult>` | `POST /api/admin/kv/seed` | Seed KV store with tokens and project metadata from the database. |
|
|
375
|
+
|
|
376
|
+
## dominus.ai
|
|
377
|
+
|
|
378
|
+
Source: `src/namespaces/ai.ts` (AiNamespace)
|
|
379
|
+
|
|
380
|
+
| Command | Params | Returns | Route | What it does |
|
|
381
|
+
|---|---|---|---|---|
|
|
382
|
+
| `dominus.ai.runAgent` | `options: AgentRunOptions` | `Promise<AgentResult>` | `POST /api/agent/run` | Execute agent with blocking wait |
|
|
383
|
+
| `dominus.ai.streamAgent` | `options: AgentRunOptions & { onChunk?: (chunk: StreamChunk) => void }` | `AsyncGenerator<StreamChunk>` | `POST /api/agent/stream` | Execute agent with SSE streaming |
|
|
384
|
+
| `dominus.ai.runAgentAsync` | `options: AgentRunAsyncOptions` | `Promise<{ resultKey: string }>` | `POST /api/agent/run-async` | Fire-and-forget async execution |
|
|
385
|
+
| `dominus.ai.history` | `conversationId: string, limit?: number` | `Promise<Message[]>` | `GET /api/agent/history/${conversationId}?limit=${limit}` | Get conversation history |
|
|
386
|
+
| `dominus.ai.complete` | `options: CompleteOptions` | `Promise<CompleteResult>` | `POST /api/llm/complete` | Blocking LLM completion |
|
|
387
|
+
| `dominus.ai.completeStream` | `options: CompleteOptions & { onChunk?: (chunk: StreamChunk) => void }` | `AsyncGenerator<StreamChunk>` | `POST /api/llm/stream` | Streaming LLM completion |
|
|
388
|
+
| `dominus.ai.stt` | `audio: Buffer, options?: SttOptions` | `Promise<SttResult>` | `POST /api/agent/stt` | Speech-to-text conversion |
|
|
389
|
+
| `dominus.ai.tts` | `text: string, options?: TtsOptions` | `Promise<Buffer>` | `POST /api/agent/tts` | Text-to-speech conversion |
|
|
390
|
+
| `dominus.ai.setup` | `options: SetupOptions` | `Promise<SetupResult>` | `POST /api/session/setup` | Pre-flight session setup |
|
|
391
|
+
|
|
392
|
+
## dominus.ai.rag
|
|
393
|
+
|
|
394
|
+
Source: `src/namespaces/ai.ts` (RagSubNamespace)
|
|
395
|
+
|
|
396
|
+
| Command | Params | Returns | Route | What it does |
|
|
397
|
+
|---|---|---|---|---|
|
|
398
|
+
| `dominus.ai.rag.list` | `none` | `Promise<CorpusInfo[]>` | `GET /api/rag` | List all corpora |
|
|
399
|
+
| `dominus.ai.rag.ensure` | `slug: string, options?: { description?: string; embeddingModel?: string }` | `Promise<Record<string, unknown>>` | `POST /api/rag/${slug}/ensure` | Ensure corpus exists (create if not) |
|
|
400
|
+
| `dominus.ai.rag.stats` | `slug: string` | `Promise<Record<string, unknown>>` | `GET /api/rag/${slug}/stats` | Get corpus statistics |
|
|
401
|
+
| `dominus.ai.rag.drop` | `slug: string` | `Promise<Record<string, unknown>>` | `DELETE /api/rag/${slug}` | Drop/delete a corpus |
|
|
402
|
+
| `dominus.ai.rag.entries` | `slug: string, options?: { category?: string; limit?: number; offset?: number }` | `Promise<Record<string, unknown>>` | `POST /api/rag/${slug}/entries` | List entries in a corpus |
|
|
403
|
+
| `dominus.ai.rag.upsert` | `slug: string, identifier: string, options: RagUpsertOptions` | `Promise<Record<string, unknown>>` | `PUT /api/rag/${slug}/${identifier}` | Upsert a single entry |
|
|
404
|
+
| `dominus.ai.rag.get` | `slug: string, identifier: string` | `Promise<RagEntry>` | `GET /api/rag/${slug}/${identifier}` | Get a specific entry |
|
|
405
|
+
| `dominus.ai.rag.delete` | `slug: string, identifier: string` | `Promise<Record<string, unknown>>` | `DELETE /api/rag/${slug}/${identifier}` | Delete an entry |
|
|
406
|
+
| `dominus.ai.rag.bulkUpsert` | `slug: string, entries: Array<RagUpsertOptions & { identifier: string }>` | `Promise<{ processed: number; failed: number; errors?: string[] }>` | `POST /api/rag/${slug}/bulk` | Bulk upsert entries |
|
|
407
|
+
| `dominus.ai.rag.search` | `slug: string, query: string, options?: RagSearchOptions` | `Promise<RagEntry[]>` | `POST /api/rag/${slug}/search` | Semantic search |
|
|
408
|
+
| `dominus.ai.rag.searchRerank` | `slug: string, query: string, options?: { limit?: number; rerankModel?: string }` | `Promise<RagEntry[]>` | `POST /api/rag/${slug}/search/rerank` | Semantic search with reranking |
|
|
409
|
+
| `dominus.ai.rag.ingest` | `slug: string, content: Buffer, filename: string, options?: { contentType?: string; chunkSize?: number; chunkOverlap?: number; }` | `Promise<Record<string, unknown>>` | `POST /api/rag/${slug}/ingest` | Ingest a document (PDF, DOCX, etc.) |
|
|
410
|
+
| `dominus.ai.rag.deleteDocument` | `slug: string, documentId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/rag/${slug}/document/${documentId}` | Delete a document and all its chunks |
|
|
411
|
+
|
|
412
|
+
## dominus.ai.artifacts
|
|
413
|
+
|
|
414
|
+
Source: `src/namespaces/ai.ts` (ArtifactsSubNamespace)
|
|
415
|
+
|
|
416
|
+
| Command | Params | Returns | Route | What it does |
|
|
417
|
+
|---|---|---|---|---|
|
|
418
|
+
| `dominus.ai.artifacts.get` | `artifactId: string, conversationId: string` | `Promise<Artifact>` | `GET /api/agent/artifacts/${artifactId}?conversation_id=${conversationId}` | Get artifact by ID |
|
|
419
|
+
| `dominus.ai.artifacts.create` | `options: CreateArtifactOptions` | `Promise<Artifact>` | `POST /api/agent/artifacts` | Create a new artifact |
|
|
420
|
+
| `dominus.ai.artifacts.list` | `conversationId: string` | `Promise<Artifact[]>` | `GET /api/agent/artifacts?conversation_id=${conversationId}` | List artifacts for a conversation |
|
|
421
|
+
| `dominus.ai.artifacts.delete` | `artifactId: string, conversationId: string` | `Promise<Record<string, unknown>>` | `DELETE /api/agent/artifacts/${artifactId}?conversation_id=${conversationId}` | Delete an artifact |
|
|
422
|
+
|
|
423
|
+
## dominus.ai.results
|
|
424
|
+
|
|
425
|
+
Source: `src/namespaces/ai.ts` (ResultsSubNamespace)
|
|
426
|
+
|
|
427
|
+
| Command | Params | Returns | Route | What it does |
|
|
428
|
+
|---|---|---|---|---|
|
|
429
|
+
| `dominus.ai.results.get` | `resultKey: string` | `Promise<AsyncResult>` | `GET /api/results/${resultKey}` | Get async result by key |
|
|
430
|
+
| `dominus.ai.results.poll` | `resultKey: string, options?: PollOptions` | `Promise<AsyncResult>` | `GET /api/results/${resultKey} (polling loop via results.get)` | Poll for result until completion or timeout |
|
|
431
|
+
|
|
432
|
+
## dominus.ai.tools
|
|
433
|
+
|
|
434
|
+
Source: `src/namespaces/ai.ts` (ToolsSubNamespace)
|
|
435
|
+
|
|
436
|
+
| Command | Params | Returns | Route | What it does |
|
|
437
|
+
|---|---|---|---|---|
|
|
438
|
+
| `dominus.ai.tools.list` | `options?: ToolListOptions` | `Promise<ToolDefinition[]>` | `GET /api/agent/tools[?category=...&enabled_only=...]` | List all tools in the registry. |
|
|
439
|
+
| `dominus.ai.tools.get` | `toolName: string` | `Promise<ToolDefinition>` | `GET /api/agent/tools/${toolName}` | Get a specific tool by name. |
|
|
440
|
+
| `dominus.ai.tools.create` | `options: ToolCreateOptions` | `Promise<ToolDefinition>` | `POST /api/agent/tools` | Register a new tool in the registry. |
|
|
441
|
+
| `dominus.ai.tools.update` | `toolName: string, updates: Partial<ToolCreateOptions>` | `Promise<ToolDefinition>` | `PUT /api/agent/tools/${toolName}` | Update an existing tool. |
|
|
442
|
+
| `dominus.ai.tools.delete` | `toolName: string` | `Promise<{ deleted: boolean }>` | `DELETE /api/agent/tools/${toolName}` | Delete a tool from the registry. |
|
|
443
|
+
| `dominus.ai.tools.enable` | `toolName: string` | `Promise<{ enabled: boolean; toolName: string }>` | `POST /api/agent/tools/${toolName}/enable` | Enable a tool (explicit opt-in for default-deny). |
|
|
444
|
+
| `dominus.ai.tools.disable` | `toolName: string` | `Promise<{ disabled: boolean; toolName: string }>` | `POST /api/agent/tools/${toolName}/disable` | Disable a tool. |
|
|
445
|
+
| `dominus.ai.tools.bulkEnable` | `toolNames: string[]` | `Promise<{ enabled: string[]; failed: string[] }>` | `POST /api/agent/tools/bulk/enable` | Bulk enable multiple tools. |
|
|
446
|
+
| `dominus.ai.tools.bulkDisable` | `toolNames: string[]` | `Promise<{ disabled: string[]; failed: string[] }>` | `POST /api/agent/tools/bulk/disable` | Bulk disable multiple tools. |
|
|
447
|
+
| `dominus.ai.tools.test` | `toolName: string, inputs: Record<string, unknown>` | `Promise<{ success: boolean; output?: unknown; error?: string; }>` | `POST /api/agent/tools/${toolName}/test` | Test an HTTP tool execution. |
|
|
448
|
+
|
|
449
|
+
## dominus.ai.workflow
|
|
450
|
+
|
|
451
|
+
Source: `src/namespaces/ai.ts` (WorkflowSubNamespace)
|
|
452
|
+
|
|
453
|
+
| Command | Params | Returns | Route | What it does |
|
|
454
|
+
|---|---|---|---|---|
|
|
455
|
+
| `dominus.ai.workflow.execute` | `options: WorkflowExecuteOptions` | `Promise<WorkflowResult>` | `POST /api/orchestration/execute` | Execute a multi-agent workflow. |
|
|
456
|
+
| `dominus.ai.workflow.streamExecute` | `options: Omit<WorkflowExecuteOptions, 'mode'>` | `AsyncGenerator<Record<string, unknown>, void, unknown>` | `POST /api/orchestration/execute` | Execute a workflow with SSE streaming. |
|
|
457
|
+
| `dominus.ai.workflow.validate` | `workflowDefinition: WorkflowDefinition \| Record<string, unknown>` | `Promise<WorkflowValidationResult>` | `POST /api/orchestration/validate` | Validate a workflow definition without executing. |
|
|
458
|
+
| `dominus.ai.workflow.messages` | `executionId: string, options?: { count?: number }` | `Promise<Message[]>` | `GET /api/orchestration/messages/${executionId}?count=${count}` | Get agent messages from an execution. |
|
|
459
|
+
| `dominus.ai.workflow.events` | `executionId: string, fromId?: string` | `Promise<Record<string, unknown>[]>` | `GET /api/orchestration/events/${executionId}[?from_id=...]` | Replay events from an execution (for reconnection). |
|
|
460
|
+
| `dominus.ai.workflow.status` | `executionId: string` | `Promise<WorkflowExecutionStatus>` | `GET /api/orchestration/status/${executionId}` | Get async execution status (for polling). |
|
|
461
|
+
| `dominus.ai.workflow.output` | `executionId: string` | `Promise<WorkflowExecutionOutput>` | `GET /api/orchestration/output/${executionId}` | Get final execution output (for async mode). |
|
|
462
|
+
| `dominus.ai.workflow.cancel` | `executionId: string` | `Promise<WorkflowCancelResult>` | `POST /api/orchestration/cancel/${executionId}` | Cancel a running workflow execution. |
|
|
463
|
+
| `dominus.ai.workflow.createRun` | `options: CreateRunOptions` | `Promise<WorkflowRun>` | `POST /api/orchestration/runs` | Phase 1: Create a workflow run and get the run_id. |
|
|
464
|
+
| `dominus.ai.workflow.startRun` | `runId: string, options?: StartRunOptions` | `Promise<WorkflowResult>` | `POST /api/orchestration/runs/${runId}/start` | Phase 2: Start a workflow run after artifacts are uploaded. |
|
|
465
|
+
| `dominus.ai.workflow.getRun` | `runId: string` | `Promise<WorkflowRun>` | `GET /api/orchestration/runs/${runId}` | Get the run status and details. |
|
|
466
|
+
| `dominus.ai.workflow.getManifest` | `runId: string` | `Promise<RunManifest>` | `GET /api/orchestration/runs/${runId}/manifest` | Get the initialization manifest for a run. |
|
|
467
|
+
| `dominus.ai.workflow.registerArtifact` | `runId: string, artifactKey: string, artifactId: string` | `Promise<{ registered: boolean; runId: string; artifactKey: string }>` | `POST /api/orchestration/runs/${runId}/artifacts` | Register an uploaded artifact with a run. |
|
|
468
|
+
| `dominus.ai.workflow.validateRun` | `runId: string` | `Promise<{ ready: boolean; runId: string; status: WorkflowRunStatus; missingArtifacts: string[]; }>` | `POST /api/orchestration/runs/${runId}/validate` | Validate that a run is ready to start. |
|
|
469
|
+
| `dominus.ai.workflow.streamStartRun` | `runId: string, options?: Omit<StartRunOptions, 'mode'>` | `AsyncGenerator<Record<string, unknown>, void, unknown>` | `POST /api/orchestration/runs/${runId}/start` | Start a workflow run with SSE streaming. |
|
|
470
|
+
|
|
471
|
+
## dominus.workflow
|
|
472
|
+
|
|
473
|
+
Source: `src/namespaces/workflow.ts` (WorkflowNamespace)
|
|
474
|
+
|
|
475
|
+
| Command | Params | Returns | Route | What it does |
|
|
476
|
+
|---|---|---|---|---|
|
|
477
|
+
| `dominus.workflow.save` | `options: SaveWorkflowOptions` | `Promise<WorkflowMetadata>` | `POST /api/workflow/workflows` | Save a workflow (create or update). |
|
|
478
|
+
| `dominus.workflow.get` | `workflowId: string, options?: { includeContent?: boolean }` | `Promise<WorkflowWithContent>` | `GET /api/workflow/workflows/${workflowId}[?include_content=true]` | Get a workflow by ID. |
|
|
479
|
+
| `dominus.workflow.list` | `options?: ListWorkflowsOptions` | `Promise<WorkflowMetadata[]>` | `GET /api/workflow/workflows?{filters}` | List workflows. |
|
|
480
|
+
| `dominus.workflow.delete` | `workflowId: string` | `Promise<{ success: boolean }>` | `DELETE /api/workflow/workflows/${workflowId}` | Delete a workflow. |
|
|
481
|
+
| `dominus.workflow.createPipeline` | `options: CreatePipelineOptions` | `Promise<PipelineMetadata>` | `POST /api/workflow/pipelines` | Create a pipeline (execution group). |
|
|
482
|
+
| `dominus.workflow.getPipeline` | `pipelineId: string, options?: { includeWorkflows?: boolean }` | `Promise<PipelineWithWorkflows>` | `GET /api/workflow/pipelines/${pipelineId}[?include_workflows=true]` | Get a pipeline by ID. |
|
|
483
|
+
| `dominus.workflow.listPipelines` | `options?: ListPipelinesOptions` | `Promise<PipelineMetadata[]>` | `GET /api/workflow/pipelines?{filters}` | List pipelines. |
|
|
484
|
+
| `dominus.workflow.deletePipeline` | `pipelineId: string` | `Promise<{ success: boolean }>` | `DELETE /api/workflow/pipelines/${pipelineId}` | Delete a pipeline. |
|
|
485
|
+
| `dominus.workflow.addToPipeline` | `pipelineId: string, workflowId: string, position?: number` | `Promise<{ success: boolean }>` | `POST /api/workflow/pipelines/${pipelineId}/workflows` | Add a workflow to a pipeline. |
|
|
486
|
+
| `dominus.workflow.removeFromPipeline` | `pipelineId: string, workflowId: string` | `Promise<{ success: boolean }>` | `DELETE /api/workflow/pipelines/${pipelineId}/workflows/${workflowId}` | Remove a workflow from a pipeline. |
|
|
487
|
+
| `dominus.workflow.reorderPipeline` | `pipelineId: string, workflowOrder: string[]` | `Promise<{ success: boolean }>` | `PUT /api/workflow/pipelines/${pipelineId}/workflows/order` | Reorder workflows in a pipeline. |
|
|
488
|
+
| `dominus.workflow.listTemplates` | `none` | `Promise<WorkflowMetadata[]>` | `GET /api/workflow/templates` | List available templates. |
|
|
489
|
+
| `dominus.workflow.getTemplate` | `templateId: string, options?: { includeContent?: boolean }` | `Promise<WorkflowWithContent>` | `GET /api/workflow/templates/${templateId}[?include_content=true]` | Get a template by ID. |
|
|
490
|
+
| `dominus.workflow.copyTemplate` | `templateId: string, options?: { name?: string; tenantSlug?: string }` | `Promise<WorkflowMetadata>` | `POST /api/workflow/templates/${templateId}/copy` | Copy a template to create a new workflow. |
|
|
491
|
+
| `dominus.workflow.execute` | `workflowId: string, context?: Record<string, unknown>` | `Promise<ExecutionResult>` | `POST /api/workflow/execute/workflow` | Execute a workflow synchronously. |
|
|
492
|
+
| `dominus.workflow.executeAsync` | `workflowId: string, options?: { context?: Record<string, unknown>; callbackUrl?: string }` | `Promise<AsyncExecutionResult>` | `POST /api/workflow/execute/workflow` | Execute a workflow asynchronously. |
|
|
493
|
+
| `dominus.workflow.executePipeline` | `pipelineId: string, options?: { context?: Record<string, unknown>; callbackUrl?: string }` | `Promise<AsyncExecutionResult>` | `POST /api/workflow/execute/pipeline` | Execute a pipeline (all workflows in sequence). |
|
|
494
|
+
| `dominus.workflow.seed` | `options?: SeedOptions` | `Promise<SeedResult>` | `POST /api/workflow/admin/seed` | Seed workflow storage with base templates and builtin tools. |
|
|
495
|
+
| `dominus.workflow.factoryReset` | `options: FactoryResetOptions` | `Promise<FactoryResetResult>` | `POST /api/workflow/admin/factory-reset` | Factory reset all workflow data - deletes workflows, tools, and B2 objects. |
|
|
496
|
+
| `dominus.workflow.listTools` | `options?: ListToolsOptions` | `Promise<Tool[]>` | `GET /api/workflow/tools?{filters}` | List tools in the registry. |
|
|
497
|
+
| `dominus.workflow.getTool` | `toolId: string` | `Promise<Tool>` | `GET /api/workflow/tools/${toolId}` | Get a tool by ID. |
|
|
498
|
+
| `dominus.workflow.registerTool` | `options: RegisterToolOptions` | `Promise<Tool>` | `POST /api/workflow/tools` | Register a new tool. |
|
|
499
|
+
| `dominus.workflow.updateTool` | `toolId: string, options: UpdateToolOptions` | `Promise<Tool>` | `PUT /api/workflow/tools/${toolId}` | Update a tool. |
|
|
500
|
+
| `dominus.workflow.deleteTool` | `toolId: string` | `Promise<{ success: boolean; deleted: string }>` | `DELETE /api/workflow/tools/${toolId}` | Delete a tool. |
|
|
501
|
+
| `dominus.workflow.enableTool` | `toolId: string` | `Promise<{ success: boolean; tool_id: string; is_enabled: boolean }>` | `POST /api/workflow/tools/${toolId}/enable` | Enable a tool. |
|
|
502
|
+
| `dominus.workflow.disableTool` | `toolId: string` | `Promise<{ success: boolean; tool_id: string; is_enabled: boolean }>` | `POST /api/workflow/tools/${toolId}/disable` | Disable a tool. |
|
|
503
|
+
|
|
504
|
+
## dominus.sync
|
|
505
|
+
|
|
506
|
+
Source: `src/namespaces/sync.ts` (SyncNamespace)
|
|
507
|
+
|
|
508
|
+
| Command | Params | Returns | Route | What it does |
|
|
509
|
+
|---|---|---|---|---|
|
|
510
|
+
| `dominus.sync.triggerSync` | `none` | `Promise<SyncResult>` | `POST /api/sync/` | Trigger a manual KV sync. |
|
|
511
|
+
| `dominus.sync.getHealth` | `none` | `Promise<SyncHealth>` | `GET /api/sync/health` | Check sync worker health. |
|
|
512
|
+
|
|
513
|
+
## dominus.jobs
|
|
514
|
+
|
|
515
|
+
Source: `src/namespaces/jobs.ts` (JobsNamespace)
|
|
516
|
+
|
|
517
|
+
| Command | Params | Returns | Route | What it does |
|
|
518
|
+
|---|---|---|---|---|
|
|
519
|
+
| `dominus.jobs.enqueue` | `jobType: JobType, payload: unknown` | `Promise<EnqueueResult>` | `POST /api/job/enqueue` | Enqueue a new job for asynchronous processing. |
|
|
520
|
+
| `dominus.jobs.getStatus` | `jobId: string` | `Promise<JobStatusResult>` | `POST /api/job/status` | Check the status of a job. |
|
|
521
|
+
| `dominus.jobs.getResult` | `jobId: string, timeoutMs?: number` | `Promise<JobResultResponse>` | `POST /api/job/result` | Poll for a job result (blocks until complete or timeout). |
|
|
522
|
+
| `dominus.jobs.listDeadLetterJobs` | `jobType?: JobType` | `Promise<DeadLetterListResult>` | `POST /api/job/dead-letter` | List dead-lettered jobs, optionally filtered by type. |
|
|
523
|
+
| `dominus.jobs.retryJob` | `jobId: string` | `Promise<{ retried: boolean; job_id: string }>` | `POST /api/job/dead-letter` | Retry a dead-lettered job (re-queues it). |
|
|
524
|
+
| `dominus.jobs.discardJob` | `jobId: string` | `Promise<{ discarded: boolean; job_id: string }>` | `POST /api/job/dead-letter` | Permanently discard a dead-lettered job. |
|
|
525
|
+
| `dominus.jobs.list` | `options?: { status?: JobStatus; job_type?: JobType; limit?: number }` | `Promise<ListJobsResult>` | `POST /api/job/list` | List jobs with optional filters. |
|
|
526
|
+
| `dominus.jobs.getHealth` | `none` | `Promise<JobHealthResult>` | `GET /api/job/health` | Check job worker health. |
|
|
527
|
+
|
|
528
|
+
## dominus.processor
|
|
529
|
+
|
|
530
|
+
Source: `src/namespaces/processor.ts` (ProcessorNamespace)
|
|
531
|
+
|
|
532
|
+
| Command | Params | Returns | Route | What it does |
|
|
533
|
+
|---|---|---|---|---|
|
|
534
|
+
| `dominus.processor.getHealth` | `none` | `Promise<ProcessorHealth>` | `GET /api/processor/health` | Check processor health. |
|
|
535
|
+
| `dominus.processor.processAll` | `jobType?: ProcessorJobType` | `Promise<ProcessAllResult>` | `POST /api/processor/process` | Process all queued jobs for the current project/environment. |
|
|
536
|
+
| `dominus.processor.processOne` | `jobType?: ProcessorJobType` | `Promise<ProcessOneResult>` | `POST /api/processor/process-one` | Process a single job from the queue (debug/testing). |
|
|
537
|
+
|
|
538
|
+
## dominus.artifacts
|
|
539
|
+
|
|
540
|
+
Source: `src/namespaces/artifacts.ts` (ArtifactsNamespace)
|
|
541
|
+
|
|
542
|
+
| Command | Params | Returns | Route | What it does |
|
|
543
|
+
|---|---|---|---|---|
|
|
544
|
+
| `dominus.artifacts.list` | `options?: ArtifactListOptions` | `Promise<ArtifactListResult>` | `POST /api/artifact/list` | List artifacts for the current project/environment. |
|
|
545
|
+
| `dominus.artifacts.getHealth` | `none` | `Promise<ArtifactHealth>` | `GET /api/artifact/health` | Check artifact worker health. |
|
|
546
|
+
| `dominus.artifacts.store` | `options: StoreArtifactOptions` | `Promise<StoreArtifactResult>` | `POST /api/artifact/store` | Store an artifact. |
|
|
547
|
+
| `dominus.artifacts.retrieve` | `key: string` | `Promise<RetrieveArtifactResult>` | `POST /api/artifact/retrieve` | Retrieve an artifact by key. |
|
|
548
|
+
| `dominus.artifacts.delete` | `key: string` | `Promise<DeleteArtifactResult>` | `POST /api/artifact/delete` | Delete an artifact by key. |
|
|
549
|
+
| `dominus.artifacts.cleanup` | `options?: CleanupArtifactOptions` | `Promise<CleanupArtifactResult>` | `POST /api/artifact/cleanup` | Cleanup expired artifacts (admin only). |
|
|
550
|
+
|