@jskit-ai/agent-docs 0.1.1

package/reference/autogen/packages/auth-web.md

@@ -0,0 +1,267 @@
+# packages/auth-web
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/auth-web`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/auth-web/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/client/composables/loginView/constants.js`
+Exports
+- `LOGIN_MODE`
+- `REGISTER_MODE`
+- `FORGOT_MODE`
+- `OTP_MODE`
+- `EMAIL_CONFIRMATION_MODE`
+- `AUTH_TITLE_BY_MODE`
+- `AUTH_SUBTITLE_BY_MODE`
+- `SUBMIT_LABEL_BY_MODE`
+- `DEFAULT_REGISTER_CONFIRMATION_MESSAGE`
+
+### `src/client/composables/loginView/identityHelpers.js`
+Exports
+- `normalizeEmailAddress(value)`
+- `maskEmail(emailAddress)`
+
+### `src/client/composables/loginView/oauthCallbackUrl.js`
+Exports
+- `stripOAuthParamsFromLocation()`
+- `readOAuthCallbackParamsFromLocation()`
+
+### `src/client/composables/loginView/registerCompletion.js`
+Exports
+- `resolveRegisterCompletionState(registerResult)`
+
+### `src/client/composables/loginView/rememberedAccountStorage.js`
+Exports
+- `createRememberedAccountHint({ email: accountEmail, displayName, maskedEmail, lastUsedAt } = {})`
+- `readRememberedAccountHint()`
+- `writeRememberedAccountHint(hint)`
+- `clearRememberedAccountHint()`
+Local functions
+- `resolveLocalStorage()`
+
+### `src/client/composables/loginView/useLoginViewActions.js`
+Exports
+- `useLoginViewActions({ state, validation, queryClient, errorRuntime } = {})`
+
+### `src/client/composables/loginView/useLoginViewState.js`
+Exports
+- `useLoginViewState({ placementContext } = {})`
+
+### `src/client/composables/loginView/useLoginViewValidation.js`
+Exports
+- `useLoginViewValidation({ state } = {})`
+
+### `src/client/composables/loginView/validationHelpers.js`
+Exports
+- `validateCommandSection(commandResource, section, payload)`
+- `resolveValidationMessage(validationResult, fallbackMessage = "Validation failed.")`
+- `resolveFieldValidationMessage(validationResult, fieldName = "")`
+- `ensureCommandSectionValid(commandResource, section, payload, fallbackMessage)`
+
+### `src/client/composables/useDefaultSignOutView.js`
+Exports
+- `useDefaultSignOutView()`
+Local functions
+- `readReturnToPathFromLocation({ allowedOrigins = [] } = {})`
+- `navigateToPath(path, { replace = true } = {})`
+
+### `src/client/index.js`
+Exports
+- `AuthWebClientProvider`
+- `DefaultLoginView`
+- `DefaultSignOutView`
+- `AuthProfileWidget`
+- `AuthProfileMenuLinkItem`
+- `useAuthStore`
+- `useAuthGuardRuntime`
+- `routeComponents`
+- `clientProviders`
+
+### `src/client/lib/profileMenuLinkTarget.js`
+Exports
+- `appendAccountReturnToIfNeeded(target = "", { placementContext = null, currentFullPath = "", currentPath = "", currentHref = "" } = {})`
+- `resolveAccountSettingsPathFromPlacementContext(contextValue = null)`
+Local functions
+- `resolvePathnameFromLinkTarget(target = "")`
+- `resolveFallbackReturnTo({ currentFullPath = "", currentPath = "", currentHref = "", absolute = false } = {})`
+
+### `src/client/lib/returnToPath.js`
+Exports
+- `normalizeAuthReturnToPath(value, fallback = "/", { allowedOrigins = [] } = {})`
+- `resolveAllowedReturnToOriginsFromPlacementContext(contextValue = null)`
+
+### `src/client/lib/surfaceLinkTarget.js`
+Exports
+- `resolveSurfaceLinkTarget({ context = null, surface = "", explicitTo = "", scopedSuffix = "", unscopedSuffix = "" } = {})`
+
+### `src/client/providers/AuthWebClientProvider.js`
+Exports
+- `AuthWebClientProvider`
+
+### `src/client/providers/bootAuthClientProvider.js`
+Exports
+- `bootAuthClientProvider(app)`
+
+### `src/client/runtime/authGuardRuntime.js`
+Exports
+- `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 } = {})`
+- `isAuthGuardRuntime(value)`
+- `initializeAuthGuardRuntime(input = {})`
+- `refreshAuthGuardState(input = {})`
+- `getAuthGuardState(input = {})`
+Local functions
+- `asGlobalObject()`
+- `normalizePathname(pathname, fallback = "/")`
+- `normalizeLoginRoute(loginRoute, fallback = DEFAULT_LOGIN_ROUTE)`
+- `normalizeOAuthProviders(rawProviders)`
+- `normalizeAuthState(payload = {})`
+- `isPlacementRuntime(value)`
+- `applyAuthContext(nextState, placementRuntime)`
+- `readSessionState({ sessionPath = DEFAULT_SESSION_PATH, fetchImplementation = globalThis.fetch } = {})`
+- `resolveReturnToPath(context, { absolute = false } = {})`
+- `toLoginRedirect(loginRoute, context)`
+- `evaluateAuthGuard({ guard, context, loginRoute, authState = DEFAULT_AUTH_STATE })`
+- `installGuardEvaluator({ loginRoute = DEFAULT_LOGIN_ROUTE, getAuthState })`
+- `normalizeRuntimePath(value, fallback)`
+- `hasOAuthCallbackParams({ search = "", hash = "" } = {})`
+- `stripOAuthCallbackParamsFromSearch(search = "")`
+- `redirectOAuthCallbackToLoginRoute(loginRoute)`
+- `asEventTarget(value)`
+- `getWindowEventTarget()`
+- `getDocumentEventTarget()`
+- `isDocumentVisible()`
+- `asRealtimeSocket(value)`
+- `normalizeRealtimeRefreshEvents(value)`
+- `resolveRuntimeInput(input = {})`
+
+### `src/client/runtime/authHttpClient.js`
+Exports
+- `authHttpRequest(url, options = {}, state = undefined)`
+- `clearAuthCsrfTokenCache()`
+
+### `src/client/runtime/inject.js`
+Exports
+- `AUTH_GUARD_RUNTIME_INJECTION_KEY`
+- `EMPTY_AUTH_GUARD_STATE`
+- `EMPTY_AUTH_GUARD_RUNTIME`
+- `useAuthGuardRuntime({ required = false } = {})`
+
+### `src/client/runtime/useLoginView.js`
+Exports
+- `useLoginView()`
+
+### `src/client/runtime/useSignOut.js`
+Exports
+- `useSignOut(options = {})`
+- `createSignOutAction({ currentSurface, goToEntry, authGuardRuntime, returnTo = "", resolveReturnToPath = null } = {})`
+- `performSignOutRequest({ authGuardRuntime } = {})`
+Local functions
+- `readSessionState()`
+- `waitForSignedOutState({ attempts = 4, delayMs = 120 } = {})`
+- `createHttpLogoutApi()`
+
+### `src/client/stores/useAuthStore.js`
+Exports
+- `useAuthStore`
+Local functions
+- `normalizeAuthStateValue(nextState)`
+
+### `src/client/views/AuthProfileMenuLinkItem.vue`
+Exports
+- None
+Local functions
+- `resolveWindowHref()`
+
+### `src/client/views/AuthProfileWidget.vue`
+Exports
+- None
+
+### `src/client/views/DefaultLoginView.vue`
+Exports
+- None
+Local functions
+- `togglePasswordVisibility()`
+- `toggleConfirmPasswordVisibility()`
+
+### `src/client/views/DefaultSignOutView.vue`
+Exports
+- None
+
+### `src/server/constants/authActionIds.js`
+Exports
+- `AUTH_ACTION_IDS`
+
+### `src/server/controllers/AuthController.js`
+Exports
+- `AuthController`
+- `AUTH_ACTION_IDS`
+- `createController({ service, authService } = {})`
+
+### `src/server/providers/AuthRouteServiceProvider.js`
+Exports
+- `AuthRouteServiceProvider`
+
+### `src/server/providers/AuthWebServiceProvider.js`
+Exports
+- `AuthWebServiceProvider`
+
+### `src/server/routes/authRoutes.js`
+Exports
+- `buildRoutes(controller)`
+
+### `src/server/services/AuthWebService.js`
+Exports
+- `AuthWebService`
+
+### templates
+
+### `templates/src/pages/auth/login.vue`
+Exports
+- None
+
+### `templates/src/pages/auth/signout.vue`
+Exports
+- None
+
+### `templates/src/runtime/authGuardRuntime.js`
+Exports
+- `createAuthGuardRuntime`
+- `isAuthGuardRuntime`
+- `initializeAuthGuardRuntime`
+- `refreshAuthGuardState`
+- `getAuthGuardState`
+
+### `templates/src/runtime/authHttpClient.js`
+Exports
+- `authHttpRequest`
+- `clearAuthCsrfTokenCache`
+
+### `templates/src/runtime/useSignOut.js`
+Exports
+- `useSignOut`
+- `createSignOutAction`
+- `performSignOutRequest`
+
+### `templates/src/views/auth/LoginView.vue`
+Exports
+- None
+
+### `templates/src/views/auth/SignOutView.vue`
+Exports
+- None
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

package/reference/autogen/packages/console-core.md

@@ -0,0 +1,116 @@
+# packages/console-core
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/console-core`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/console-core/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/server/consoleBootstrapContributor.js`
+Exports
+- `createConsoleBootstrapContributor({ consoleService } = {})`
+
+### `src/server/ConsoleCoreServiceProvider.js`
+Exports
+- `ConsoleCoreServiceProvider`
+
+### `src/server/consoleSettings/bootConsoleSettingsRoutes.js`
+Exports
+- `bootConsoleSettingsRoutes(app)`
+
+### `src/server/consoleSettings/consoleService.js`
+Exports
+- `createService({ consoleSettingsRepository } = {})`
+
+### `src/server/consoleSettings/consoleSettingsActions.js`
+Exports
+- `consoleSettingsActions`
+
+### `src/server/consoleSettings/consoleSettingsRepository.js`
+Exports
+- `createRepository(knex)`
+Local functions
+- `nowDb()`
+- `mapSettings(row = {})`
+- `mapSingletonRow(row)`
+
+### `src/server/consoleSettings/consoleSettingsService.js`
+Exports
+- `createService({ consoleSettingsRepository, consoleService } = {})`
+Local functions
+- `buildSettingsResponse(record = {})`
+
+### `src/server/consoleSettings/registerConsoleSettings.js`
+Exports
+- `registerConsoleSettings(app)`
+
+### `src/server/registerConsoleBootstrap.js`
+Exports
+- `registerConsoleBootstrap(app)`
+
+### `src/server/registerConsoleCore.js`
+Exports
+- `registerConsoleCore(app)`
+
+### `src/server/support/consoleActionSurfaces.js`
+Exports
+- `resolveConsoleSurfaceIdsFromAppConfig(appConfig = {})`
+- `registerConsoleCoreActionSurfaceSources(app)`
+Local functions
+- `normalizeSurfaceIds(surfaceIds = [])`
+
+### `src/shared/operationMessages.js`
+Exports
+- `createOperationMessages({ validationMessage = "Validation failed.", apiValidationMessage = validationMessage } = {})`
+
+### `src/shared/resources/consoleSettingsFields.js`
+Exports
+- `defineField(field = {})`
+- `resetConsoleSettingsFields()`
+- `consoleSettingsFields`
+
+### `src/shared/resources/consoleSettingsResource.js`
+Exports
+- `consoleSettingsResource`
+Local functions
+- `buildCreateSchema()`
+- `buildOutputSchema()`
+- `buildConsoleSettingsRecordSchema()`
+- `buildConsoleSettingsCreateSchema()`
+- `buildConsoleSettingsReplaceSchema()`
+- `buildConsoleSettingsPatchSchema()`
+- `normalizeConsoleSettingsInput(payload = {})`
+
+### `src/shared/resources/resolveGlobalArrayRegistry.js`
+Exports
+- `resolveGlobalArrayRegistry(symbolKey)`
+
+### templates
+
+### `templates/migrations/console_core_generic_initial.cjs`
+Exports
+- None
+
+### `templates/packages/main/src/shared/resources/consoleSettingsFields.js`
+Exports
+- None
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None
+
+### test-support
+
+### `test-support/registerDefaultSettingsFields.js`
+Exports
+- None

package/reference/autogen/packages/console-web.md

@@ -0,0 +1,37 @@
+# packages/console-web
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/console-web`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/console-web/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### templates
+
+### `templates/src/pages/console.vue`
+Exports
+- None
+
+### `templates/src/pages/console/index.vue`
+Exports
+- None
+
+### `templates/src/pages/console/settings.vue`
+Exports
+- None
+
+### `templates/src/pages/console/settings/index.vue`
+Exports
+- None
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None