@jskit-ai/agent-docs 0.1.62 → 0.1.64
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/guide/agent/app-setup/authentication.md +101 -155
- package/guide/agent/app-setup/database-layer.md +24 -34
- package/guide/agent/app-setup/initial-scaffolding.md +4 -8
- package/guide/agent/app-setup/quickstart.md +5 -9
- package/guide/agent/app-setup/users.md +39 -30
- package/guide/agent/app-setup/working-with-the-jskit-cli.md +27 -31
- package/package.json +1 -1
- package/reference/autogen/README.md +1 -0
- package/reference/autogen/packages/auth-core.md +74 -0
- package/reference/autogen/packages/auth-provider-local-core.md +112 -0
- package/reference/autogen/packages/auth-provider-supabase-core.md +3 -12
- package/reference/autogen/packages/auth-web.md +30 -1
- package/reference/autogen/tooling/jskit-cli.md +5 -0
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# packages/auth-provider-local-core
|
|
2
|
+
|
|
3
|
+
Generated by `npm run agent-docs:build`.
|
|
4
|
+
Do not edit manually.
|
|
5
|
+
|
|
6
|
+
Generated inventory for `packages/auth-provider-local-core`.
|
|
7
|
+
Use this on demand; do not load the full index at startup.
|
|
8
|
+
|
|
9
|
+
## Scope
|
|
10
|
+
- Source: `packages/auth-provider-local-core/**/*{.js,.mjs,.cjs,.vue}`
|
|
11
|
+
- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`, `.vitepress/cache/`, `.vitepress/dist/`
|
|
12
|
+
|
|
13
|
+
## Sections
|
|
14
|
+
|
|
15
|
+
### src
|
|
16
|
+
|
|
17
|
+
### `src/server/lib/fileBackend.js`
|
|
18
|
+
Exports
|
|
19
|
+
- `createLocalFileBackend({ storeDir })`
|
|
20
|
+
Local functions
|
|
21
|
+
- `nowIso()`
|
|
22
|
+
- `encodeField(value)`
|
|
23
|
+
- `decodeField(value)`
|
|
24
|
+
- `splitLine(line, expectedType)`
|
|
25
|
+
- `parseUsers(content)`
|
|
26
|
+
- `serializeUsers(users)`
|
|
27
|
+
- `parseSessions(content)`
|
|
28
|
+
- `serializeSessions(sessions)`
|
|
29
|
+
- `parseRecovery(content)`
|
|
30
|
+
- `serializeRecovery(records)`
|
|
31
|
+
- `readText(filePath)`
|
|
32
|
+
- `writeAtomic(filePath, content)`
|
|
33
|
+
- `encodeJournalContent(content)`
|
|
34
|
+
- `decodeJournalContent(content)`
|
|
35
|
+
- `buildJournal(entries)`
|
|
36
|
+
- `parseJournal(content)`
|
|
37
|
+
- `writeCommitJournal(storeDir, entries)`
|
|
38
|
+
- `replayCommitJournal(storeDir)`
|
|
39
|
+
- `parseLockPid(content)`
|
|
40
|
+
- `isProcessAlive(pid)`
|
|
41
|
+
- `removeStaleLock(lockPath)`
|
|
42
|
+
- `acquireLock(storeDir, timeoutMs = 2000)`
|
|
43
|
+
- `clone(value)`
|
|
44
|
+
- `createTx(state, touched)`
|
|
45
|
+
|
|
46
|
+
### `src/server/lib/index.js`
|
|
47
|
+
Exports
|
|
48
|
+
- `createLocalAuthService`
|
|
49
|
+
- `createLocalFileBackend`
|
|
50
|
+
|
|
51
|
+
### `src/server/lib/passwords.js`
|
|
52
|
+
Exports
|
|
53
|
+
- `hashPassword(password)`
|
|
54
|
+
- `verifyPassword(password, record)`
|
|
55
|
+
Local functions
|
|
56
|
+
- `base64url(buffer)`
|
|
57
|
+
- `fromBase64url(value)`
|
|
58
|
+
|
|
59
|
+
### `src/server/lib/service.js`
|
|
60
|
+
Exports
|
|
61
|
+
- `createLocalAuthService({ backend, config, profileProjector = null })`
|
|
62
|
+
Local functions
|
|
63
|
+
- `nowSeconds()`
|
|
64
|
+
- `isoFromNow(seconds)`
|
|
65
|
+
- `isExpiredIso(value)`
|
|
66
|
+
- `isNormalSession(session)`
|
|
67
|
+
- `normalizeDisplayName(value, email)`
|
|
68
|
+
- `createId(prefix)`
|
|
69
|
+
- `safeRequestCookies(request)`
|
|
70
|
+
- `cookieOptions(isProduction, maxAge)`
|
|
71
|
+
- `clearCookieOptions(isProduction)`
|
|
72
|
+
- `buildProfile(user)`
|
|
73
|
+
- `buildActor(user, profile = null)`
|
|
74
|
+
- `buildAuthPayload({ user, session, profileProjector })`
|
|
75
|
+
- `buildAccessToken({ user, session, secret, ttlSeconds = ACCESS_TTL_SECONDS })`
|
|
76
|
+
- `buildSessionPayload({ user, session, refreshToken, secret })`
|
|
77
|
+
- `validatePasswordInput(password)`
|
|
78
|
+
- `validateEmailInput(email)`
|
|
79
|
+
- `maybeSendRecoveryEmail(config, recoveryUrl, email)`
|
|
80
|
+
|
|
81
|
+
### `src/server/lib/tokens.js`
|
|
82
|
+
Exports
|
|
83
|
+
- `randomToken(bytes = 32)`
|
|
84
|
+
- `sha256Base64url(value)`
|
|
85
|
+
- `signToken(payload, secret)`
|
|
86
|
+
- `verifySignedToken(token, secret)`
|
|
87
|
+
Local functions
|
|
88
|
+
- `base64urlJson(value)`
|
|
89
|
+
- `parseBase64urlJson(value)`
|
|
90
|
+
|
|
91
|
+
### `src/server/providers/AuthLocalServiceProvider.js`
|
|
92
|
+
Exports
|
|
93
|
+
- `AuthLocalServiceProvider`
|
|
94
|
+
Local functions
|
|
95
|
+
- `parseBoolean(value, fallback = false)`
|
|
96
|
+
- `resolveRuntimeEnv(scope)`
|
|
97
|
+
- `assertSelectedAuthProvider(env)`
|
|
98
|
+
- `resolveStoreDir(env)`
|
|
99
|
+
- `resolveSessionSecret(env, { storeDir, isProduction })`
|
|
100
|
+
- `resolveSmtpConfig(env)`
|
|
101
|
+
- `resolveAppPublicUrl(env, { smtpConfigured })`
|
|
102
|
+
- `resolveConfig(scope)`
|
|
103
|
+
|
|
104
|
+
### `src/server/providers/AuthProviderServiceProvider.js`
|
|
105
|
+
Exports
|
|
106
|
+
- `AuthProviderServiceProvider`
|
|
107
|
+
|
|
108
|
+
### root
|
|
109
|
+
|
|
110
|
+
### `package.descriptor.mjs`
|
|
111
|
+
Exports
|
|
112
|
+
- None
|
|
@@ -26,11 +26,7 @@ Local functions
|
|
|
26
26
|
|
|
27
27
|
### `src/server/lib/actions/auth.contributor.js`
|
|
28
28
|
Exports
|
|
29
|
-
- `baseAuthActions`
|
|
30
|
-
- `buildAuthActions({ includeDevLoginAs = false } = {})`
|
|
31
29
|
- `devLoginAsAction`
|
|
32
|
-
Local functions
|
|
33
|
-
- `requireRequestContext(context, actionId)`
|
|
34
30
|
|
|
35
31
|
### `src/server/lib/authCookies.js`
|
|
36
32
|
Exports
|
|
@@ -75,7 +71,7 @@ Exports
|
|
|
75
71
|
- `collectProviderIdsFromSupabaseUser(user)`
|
|
76
72
|
- `buildAuthMethodsStatusFromProviderIds(providerIds, options = {})`
|
|
77
73
|
- `buildAuthMethodsStatusFromSupabaseUser(user, options = {})`
|
|
78
|
-
- `buildSecurityStatusFromAuthMethodsStatus(authMethodsStatus)`
|
|
74
|
+
- `buildSecurityStatusFromAuthMethodsStatus(authMethodsStatus, options = {})`
|
|
79
75
|
- `findAuthMethodById(authMethodsStatus, methodId)`
|
|
80
76
|
- `findLinkedIdentityByProvider(user, provider)`
|
|
81
77
|
Local functions
|
|
@@ -105,10 +101,6 @@ Exports
|
|
|
105
101
|
Exports
|
|
106
102
|
- `buildDisabledPasswordSecret()`
|
|
107
103
|
|
|
108
|
-
### `src/server/lib/authSessionEventsService.js`
|
|
109
|
-
Exports
|
|
110
|
-
- `createAuthSessionEventsService()`
|
|
111
|
-
|
|
112
104
|
### `src/server/lib/devAuthBootstrap.js`
|
|
113
105
|
Exports
|
|
114
106
|
- `assertDevAuthBootstrapConfig(config, { userProfilesRepository = null } = {})`
|
|
@@ -144,8 +136,6 @@ Exports
|
|
|
144
136
|
Exports
|
|
145
137
|
- `createService`
|
|
146
138
|
- `__testables`
|
|
147
|
-
- `baseAuthActions`
|
|
148
|
-
- `buildAuthActions`
|
|
149
139
|
- `devLoginAsAction`
|
|
150
140
|
|
|
151
141
|
### `src/server/lib/oauthFlows.js`
|
|
@@ -247,9 +237,10 @@ Local functions
|
|
|
247
237
|
- `resolveAuthProfileMode(appConfig = {})`
|
|
248
238
|
- `isDevAuthBypassEnabledForRegistration(env)`
|
|
249
239
|
- `isDevAuthBypassRequested(env)`
|
|
250
|
-
- `
|
|
240
|
+
- `createProviderIdentityProfileSyncService({ authProviderId = "supabase" } = {})`
|
|
251
241
|
- `resolveCommonDependencies(scope)`
|
|
252
242
|
- `resolveRuntimeEnv(scope)`
|
|
243
|
+
- `assertSelectedAuthProvider(env)`
|
|
253
244
|
- `resolveOptionalRepositories(scope)`
|
|
254
245
|
- `isDeferredJsonRestBootGap(app, error)`
|
|
255
246
|
- `applyAuthServiceDecorators(scope, authService)`
|
|
@@ -80,6 +80,7 @@ Exports
|
|
|
80
80
|
- `AuthWebClientProvider`
|
|
81
81
|
- `DefaultLoginView`
|
|
82
82
|
- `DefaultSignOutView`
|
|
83
|
+
- `DefaultResetPasswordView`
|
|
83
84
|
- `AuthProfileWidget`
|
|
84
85
|
- `AuthProfileMenuLinkItem`
|
|
85
86
|
- `useAuthStore`
|
|
@@ -115,6 +116,12 @@ Exports
|
|
|
115
116
|
Exports
|
|
116
117
|
- `bootAuthClientProvider(app)`
|
|
117
118
|
|
|
119
|
+
### `src/client/runtime/authCallbackUrlParams.js`
|
|
120
|
+
Exports
|
|
121
|
+
- `readAuthCallbackParam(callbackUrlParams, key)`
|
|
122
|
+
- `readAuthCallbackUrlParams(url = "")`
|
|
123
|
+
- `stripAuthCallbackParamsFromUrl(url = "", keys = [])`
|
|
124
|
+
|
|
118
125
|
### `src/client/runtime/authGuardRuntime.js`
|
|
119
126
|
Exports
|
|
120
127
|
- `createAuthGuardRuntime({ placementRuntime = null, sessionPath = DEFAULT_SESSION_PATH, loginRoute = DEFAULT_LOGIN_ROUTE, fetchImplementation = globalThis.fetch, refreshOnForeground = DEFAULT_REFRESH_ON_FOREGROUND, refreshOnReconnect = DEFAULT_REFRESH_ON_RECONNECT, realtimeSocket = null, realtimeRefreshEvents = DEFAULT_REALTIME_REFRESH_EVENTS } = {})`
|
|
@@ -167,7 +174,6 @@ Exports
|
|
|
167
174
|
- `completeOAuthCallbackFromUrl({ url = "", fallbackReturnTo = "/", allowedReturnToOrigins = [], defaultProvider = "", request = authHttpRequest, refreshSession = async () => null } = {})`
|
|
168
175
|
- `readOAuthCallbackParamsFromUrl(url = "")`
|
|
169
176
|
Local functions
|
|
170
|
-
- `parseCallbackUrl(url = "")`
|
|
171
177
|
- `buildOAuthCompletePayload({ callbackParams = null, provider = "", hasSessionPair = false } = {})`
|
|
172
178
|
|
|
173
179
|
### `src/client/runtime/oauthLaunchClient.js`
|
|
@@ -175,6 +181,13 @@ Exports
|
|
|
175
181
|
- `createBrowserOAuthLaunchClient({ location = null } = {})`
|
|
176
182
|
- `isAuthOAuthLaunchClient(value = null)`
|
|
177
183
|
|
|
184
|
+
### `src/client/runtime/passwordRecoveryCallbackRuntime.js`
|
|
185
|
+
Exports
|
|
186
|
+
- `PASSWORD_RECOVERY_CALLBACK_PARAM_KEYS`
|
|
187
|
+
- `readPasswordRecoveryCallbackPayloadFromUrl(url = "")`
|
|
188
|
+
- `stripPasswordRecoveryCallbackParamsFromLocation()`
|
|
189
|
+
- `stripPasswordRecoveryCallbackParamsFromUrl(url = "")`
|
|
190
|
+
|
|
178
191
|
### `src/client/runtime/useLoginView.js`
|
|
179
192
|
Exports
|
|
180
193
|
- `useLoginView()`
|
|
@@ -212,6 +225,14 @@ Local functions
|
|
|
212
225
|
- `togglePasswordVisibility()`
|
|
213
226
|
- `toggleConfirmPasswordVisibility()`
|
|
214
227
|
|
|
228
|
+
### `src/client/views/DefaultResetPasswordView.vue`
|
|
229
|
+
Exports
|
|
230
|
+
- None
|
|
231
|
+
Local functions
|
|
232
|
+
- `readRecoveryPayload()`
|
|
233
|
+
- `exchangeRecoveryToken()`
|
|
234
|
+
- `submitReset()`
|
|
235
|
+
|
|
215
236
|
### `src/client/views/DefaultSignOutView.vue`
|
|
216
237
|
Exports
|
|
217
238
|
- None
|
|
@@ -251,6 +272,10 @@ Exports
|
|
|
251
272
|
Exports
|
|
252
273
|
- None
|
|
253
274
|
|
|
275
|
+
### `templates/src/pages/auth/reset-password.vue`
|
|
276
|
+
Exports
|
|
277
|
+
- None
|
|
278
|
+
|
|
254
279
|
### `templates/src/pages/auth/signout.vue`
|
|
255
280
|
Exports
|
|
256
281
|
- None
|
|
@@ -278,6 +303,10 @@ Exports
|
|
|
278
303
|
Exports
|
|
279
304
|
- None
|
|
280
305
|
|
|
306
|
+
### `templates/src/views/auth/ResetPasswordView.vue`
|
|
307
|
+
Exports
|
|
308
|
+
- None
|
|
309
|
+
|
|
281
310
|
### `templates/src/views/auth/SignOutView.vue`
|
|
282
311
|
Exports
|
|
283
312
|
- None
|
|
@@ -71,6 +71,7 @@ Local functions
|
|
|
71
71
|
- `buildCapabilityGraph(packageRegistry)`
|
|
72
72
|
- `createCapabilityPackageDetail(packageId, packageRegistry)`
|
|
73
73
|
- `collectPlannedCapabilityIssues(plannedPackageIds, packageRegistry)`
|
|
74
|
+
- `collectExclusiveCapabilityIssues(plannedPackageIds, packageRegistry)`
|
|
74
75
|
|
|
75
76
|
### `src/server/cliRuntime/completion.js`
|
|
76
77
|
Exports
|
|
@@ -920,3 +921,7 @@ Exports
|
|
|
920
921
|
### `bundles/auth-base/bundle.descriptor.mjs`
|
|
921
922
|
Exports
|
|
922
923
|
- None
|
|
924
|
+
|
|
925
|
+
### `bundles/auth-local/bundle.descriptor.mjs`
|
|
926
|
+
Exports
|
|
927
|
+
- None
|