@owlmeans/server-auth-identity 0.1.16-rc.0 → 0.1.17
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 +3 -4
- package/agent-meta/manifest.json +4 -11
- package/agent-meta/skills/server-auth-identity/SKILL.md +1 -1
- package/build/helper.d.ts.map +1 -1
- package/build/resource.d.ts.map +1 -1
- package/package.json +9 -9
- package/agent-meta/instructions/server-auth-identity.instructions.md +0 -120
package/README.md
CHANGED
|
@@ -96,10 +96,9 @@ const { items } = await profiles.list({ entityId, profileId } as any)
|
|
|
96
96
|
<!-- owlmeans:agent-guidance:start -->
|
|
97
97
|
## Agent guidance
|
|
98
98
|
|
|
99
|
-
This package ships embedded
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
(`.claude/skills/` and `.github/instructions/`):
|
|
99
|
+
This package ships embedded agent skills under `agent-meta/`. After installing your
|
|
100
|
+
`@owlmeans/*` packages, run the OwlMeans agent-skills installer to place them into
|
|
101
|
+
your project's skill store (`.agents/skills/`):
|
|
103
102
|
|
|
104
103
|
```sh
|
|
105
104
|
npx @owlmeans/agent-skills
|
package/agent-meta/manifest.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
|
-
"schemaVersion":
|
|
2
|
+
"schemaVersion": 2,
|
|
3
3
|
"package": "@owlmeans/server-auth-identity",
|
|
4
|
-
"version": "0.1.
|
|
5
|
-
"generatedAt": "2026-08-
|
|
4
|
+
"version": "0.1.17",
|
|
5
|
+
"generatedAt": "2026-08-15T13:01:19.927Z",
|
|
6
6
|
"canonicalRepo": "https://github.com/owlmeans/common",
|
|
7
7
|
"entries": [
|
|
8
8
|
{
|
|
@@ -10,14 +10,7 @@
|
|
|
10
10
|
"name": "server-auth-identity",
|
|
11
11
|
"category": "package-specific",
|
|
12
12
|
"file": "skills/server-auth-identity/SKILL.md",
|
|
13
|
-
"canonicalPath": ".
|
|
14
|
-
},
|
|
15
|
-
{
|
|
16
|
-
"kind": "instruction",
|
|
17
|
-
"name": "server-auth-identity",
|
|
18
|
-
"category": "package-specific",
|
|
19
|
-
"file": "instructions/server-auth-identity.instructions.md",
|
|
20
|
-
"canonicalPath": ".github/instructions/server-auth-identity.instructions.md"
|
|
13
|
+
"canonicalPath": ".agents/skills/server-auth-identity/SKILL.md"
|
|
21
14
|
}
|
|
22
15
|
]
|
|
23
16
|
}
|
|
@@ -8,7 +8,7 @@ user-invocable: false
|
|
|
8
8
|
# @owlmeans/server-auth-identity
|
|
9
9
|
|
|
10
10
|
**Layer:** Server
|
|
11
|
-
**Install:** `"@owlmeans/server-auth-identity": "^0.1.
|
|
11
|
+
**Install:** `"@owlmeans/server-auth-identity": "^0.1.17"` in `dependencies`
|
|
12
12
|
|
|
13
13
|
## Key Exports
|
|
14
14
|
|
package/build/helper.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAIrD,eAAO,MAAM,2BAA2B,
|
|
1
|
+
{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAIrD,eAAO,MAAM,2BAA2B,YAC7B,YAAY,CAAC,GAAG,CAAC,YAChB,MAAM,KACf,IAKF,CAAA"}
|
package/build/resource.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAmB,uBAAuB,EAAmB,uBAAuB,EAAuB,2BAA2B,EAAE,MAAM,YAAY,CAAA;AAMtK,eAAO,MAAM,2BAA2B,
|
|
1
|
+
{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAmB,uBAAuB,EAAmB,uBAAuB,EAAuB,2BAA2B,EAAE,MAAM,YAAY,CAAA;AAMtK,eAAO,MAAM,2BAA2B,aAAc,MAAM,KAAG,uBAQ9D,CAAA;AAED,eAAO,MAAM,2BAA2B,aAAc,MAAM,KAAG,uBAe9D,CAAA;AAED,eAAO,MAAM,+BAA+B,aAAc,MAAM,KAAG,2BAOlE,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@owlmeans/server-auth-identity",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.17",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"scripts": {
|
|
@@ -22,13 +22,13 @@
|
|
|
22
22
|
}
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@owlmeans/auth": "^0.1.
|
|
26
|
-
"@owlmeans/basic-ids": "^0.1.
|
|
27
|
-
"@owlmeans/context": "^0.1.
|
|
28
|
-
"@owlmeans/mongo-resource": "^0.1.
|
|
29
|
-
"@owlmeans/oidc": "^0.1.
|
|
30
|
-
"@owlmeans/resource": "^0.1.
|
|
31
|
-
"@owlmeans/server-context": "^0.1.
|
|
25
|
+
"@owlmeans/auth": "^0.1.17",
|
|
26
|
+
"@owlmeans/basic-ids": "^0.1.17",
|
|
27
|
+
"@owlmeans/context": "^0.1.17",
|
|
28
|
+
"@owlmeans/mongo-resource": "^0.1.17",
|
|
29
|
+
"@owlmeans/oidc": "^0.1.17",
|
|
30
|
+
"@owlmeans/resource": "^0.1.17",
|
|
31
|
+
"@owlmeans/server-context": "^0.1.17"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
34
|
"mongodb": "*"
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"@owlmeans/dep-config": "workspace:*",
|
|
38
38
|
"@types/bun": "^1.3.14",
|
|
39
39
|
"nodemon": "^3.1.14",
|
|
40
|
-
"typescript": "^
|
|
40
|
+
"typescript": "^7.0.2"
|
|
41
41
|
},
|
|
42
42
|
"publishConfig": {
|
|
43
43
|
"access": "public"
|
|
@@ -1,120 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: "How to use @owlmeans/server-auth-identity — Mongo-backed local identity resources (account, profile, credentials) and IdentityLinkingService for provider account linking. Use when importing appendAuthIdentityResources, makeIdentityLinkingService, or identity resource aliases."
|
|
3
|
-
applyTo: "**/context.ts, **/services/**/*.ts, **/*.ts, **/*.tsx"
|
|
4
|
-
---
|
|
5
|
-
<!-- AUTO-GENERATED — do not edit. Regenerate via sync-agent-meta. -->
|
|
6
|
-
|
|
7
|
-
# @owlmeans/server-auth-identity
|
|
8
|
-
|
|
9
|
-
**Layer:** Server
|
|
10
|
-
**Install:** `"@owlmeans/server-auth-identity": "^0.1.16-rc.0"` in `dependencies`
|
|
11
|
-
|
|
12
|
-
## Key Exports
|
|
13
|
-
|
|
14
|
-
| Export | Description |
|
|
15
|
-
|--------|-------------|
|
|
16
|
-
| `appendAuthIdentityResources(context, dbAlias?)` | Register all three identity resources + linking service on a context |
|
|
17
|
-
| `makeIdentityAccountResource(dbAlias?)` | Mongo resource for `IdentityAccount` (one per user) |
|
|
18
|
-
| `makeIdentityProfileResource(dbAlias?)` | Mongo resource for `IdentityProfile` (ties user to entity + role) |
|
|
19
|
-
| `makeIdentityCredentialsResource(dbAlias?)` | Mongo resource for `IdentityCredentials` (provider link per profile) |
|
|
20
|
-
| `makeIdentityLinkingService()` | Service implementing `IdentityLinkingService` — links external providers to local profiles |
|
|
21
|
-
| `AUTH_IDENTITY_ACCOUNT` | Resource alias `'auth-identity:account'` |
|
|
22
|
-
| `AUTH_IDENTITY_PROFILE` | Resource alias `'auth-identity:profile'` |
|
|
23
|
-
| `AUTH_IDENTITY_CREDENTIALS` | Resource alias `'auth-identity:credentials'` |
|
|
24
|
-
| `AUTH_IDENTITY_LINKING` | Service alias `'auth-identity:linking'` |
|
|
25
|
-
|
|
26
|
-
## Types
|
|
27
|
-
|
|
28
|
-
| Type | Description |
|
|
29
|
-
|------|-------------|
|
|
30
|
-
| `IdentityAccount` | `Profile & ResourceRecord` — `id`, `credential` (unique entity slug) |
|
|
31
|
-
| `IdentityProfile` | `Profile & ResourceRecord` — `id`, `profileId`, `userId?`, `role`, `entityId`, `scopes`, `expiresAt?` |
|
|
32
|
-
| `IdentityCredentials` | `AuthCredentials & ResourceRecord` — `profileId`, `type`, `userId` (external key), `credential` (login-service key) |
|
|
33
|
-
| `IdentityLinkingService` | `getLinkedProfile`, `linkProfile`, `linkCredentials`, `getOwnerProfiles`, `getOwnerCredentials` |
|
|
34
|
-
| `IdentityAccountResource` | `MongoResource<IdentityAccount>` |
|
|
35
|
-
| `IdentityProfileResource` | `MongoResource<IdentityProfile>` |
|
|
36
|
-
| `IdentityCredentialsResource` | `MongoResource<IdentityCredentials>` |
|
|
37
|
-
|
|
38
|
-
## Usage
|
|
39
|
-
|
|
40
|
-
### Register in context
|
|
41
|
-
|
|
42
|
-
```typescript
|
|
43
|
-
import { appendAuthIdentityResources } from '@owlmeans/server-auth-identity'
|
|
44
|
-
|
|
45
|
-
// After appendMongo, appendRedis, appendAuthService:
|
|
46
|
-
appendAuthIdentityResources(context)
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
### Read a profile (gate / handler)
|
|
50
|
-
|
|
51
|
-
```typescript
|
|
52
|
-
import { AUTH_IDENTITY_PROFILE } from '@owlmeans/server-auth-identity'
|
|
53
|
-
import type { IdentityProfileResource } from '@owlmeans/server-auth-identity'
|
|
54
|
-
|
|
55
|
-
const profileRes = ctx.resource<IdentityProfileResource>(AUTH_IDENTITY_PROFILE)
|
|
56
|
-
|
|
57
|
-
// Single-field indexed lookup (read-only):
|
|
58
|
-
const profile = await profileRes.load(profileId, 'profileId')
|
|
59
|
-
|
|
60
|
-
// Multi-field criteria lookup (read-only):
|
|
61
|
-
const { items } = await profileRes.list({ entityId, profileId } as any)
|
|
62
|
-
const profile = items[0] ?? null
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
### Link an external provider to a local profile
|
|
66
|
-
|
|
67
|
-
```typescript
|
|
68
|
-
import { AUTH_IDENTITY_LINKING } from '@owlmeans/server-auth-identity'
|
|
69
|
-
import type { IdentityLinkingService } from '@owlmeans/server-auth-identity'
|
|
70
|
-
|
|
71
|
-
const linking = ctx.service<IdentityLinkingService>(AUTH_IDENTITY_LINKING)
|
|
72
|
-
const payload = await linking.linkProfile(providerDetails, { username })
|
|
73
|
-
// Returns AuthPayload with type, role, userId, profileId, entityId, scopes
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
## Key Derivation Conventions
|
|
77
|
-
|
|
78
|
-
- **Profile userId**: the account's mongo id — a declared ObjectId reference (`resource.reference('userId', AUTH_IDENTITY_ACCOUNT)`): stored as `ObjectId`, exchanged as a string, auto-indexed and auto-migrated at boot. The only reference in the trio.
|
|
79
|
-
- **Account credential**: unique Base58 slug (16 chars) — serves as the local `entityId`
|
|
80
|
-
- **Profile profileId**: `"{type}:{accountId}"` — stable across provider re-links; a composite key, NOT a reference
|
|
81
|
-
- **Credentials userId** (external key): `"{type}:{service}:{providerSub}"` — same name as `profile.userId`, entirely different meaning; never convert or compare across the two
|
|
82
|
-
- **Credentials credential** (login-service key): `"service:{type}:{service}"` — groups credentials by provider
|
|
83
|
-
- `AuthPayload.userId` = `profile.userId ?? profile.profileId` — a value flowing back into a `userId` query may be a composite key; reference criteria tolerate it (matches nothing)
|
|
84
|
-
|
|
85
|
-
## Resource Indexes
|
|
86
|
-
|
|
87
|
-
| Resource | Index | Fields | Notes |
|
|
88
|
-
|----------|-------|--------|-------|
|
|
89
|
-
| Account | `credential` | `{ credential: 1 }` | unique |
|
|
90
|
-
| Account | `entityId` | `{ entityId: 1 }` | |
|
|
91
|
-
| Account | `secret` | `{ secret: 1 }` | unique, sparse |
|
|
92
|
-
| Profile | `userId` | `{ userId: 1 }` | |
|
|
93
|
-
| Profile | `entityId` | `{ entityId: 1 }` | |
|
|
94
|
-
| Profile | `role` | `{ role: 1, entityId: 1 }` | |
|
|
95
|
-
| Profile | `profile` | `{ profileId: 1, entityId: 1 }` | unique |
|
|
96
|
-
| Credentials | `provider` | `{ type: 1, userId: 1, credential: 1 }` | unique |
|
|
97
|
-
| Credentials | `profileId` | `{ profileId: 1 }` | |
|
|
98
|
-
|
|
99
|
-
## Important Gotchas
|
|
100
|
-
|
|
101
|
-
- **`Resource.pick()` is destructive** — it deletes the record. For read-only identity lookups, use `load(id, field)` for single-field indexed queries or `list(criteria)` for multi-field queries. Never use `pick()` in a gate or authorization check.
|
|
102
|
-
- **`IdentityLinkingService` is compatible with `AccountLinkingService`** from `@owlmeans/server-oidc-rp` but defined independently to avoid circular dependency. Both return `AuthPayload`.
|
|
103
|
-
- First-login profiles are created with `ALL_SCOPES` and `AuthRole.User` — the gate layer is initially permissive per entity.
|
|
104
|
-
|
|
105
|
-
## Product-Viable Usage Notes
|
|
106
|
-
|
|
107
|
-
- Register `appendAuthIdentityResources(context)` immediately after `appendAuthService(context)` so guards can authenticate before product gates authorize.
|
|
108
|
-
- Product gates should load `AUTH_IDENTITY_PROFILE` read-only, verify `entityId`, reject expired/blocked profiles, then compare gate params against profile scopes.
|
|
109
|
-
- Google login goes through OIDC provider config, but the durable authorization source is the local `IdentityProfile` record.
|
|
110
|
-
- Account `credential` is the public local entity slug. Keep it separate from Mongo account `id` and provider subject identifiers.
|
|
111
|
-
|
|
112
|
-
## Depends On
|
|
113
|
-
|
|
114
|
-
- `@owlmeans/auth` — `AuthPayload`, `AuthRole`, `ALL_SCOPES`
|
|
115
|
-
- `@owlmeans/basic-ids` — `createIdOfLength` for slug generation
|
|
116
|
-
- `@owlmeans/context` — `appendContextual`
|
|
117
|
-
- `@owlmeans/mongo-resource` — `makeMongoResource`
|
|
118
|
-
- `@owlmeans/oidc` — `ProviderProfileDetails`
|
|
119
|
-
- `@owlmeans/resource` — `ResourceRecord`
|
|
120
|
-
- `@owlmeans/server-context` — `ServerConfig`, `ServerContext`
|