@jskit-ai/agent-docs 0.1.1

package/reference/autogen/packages/uploads-runtime.md

@@ -0,0 +1,85 @@
+# packages/uploads-runtime
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/uploads-runtime`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/uploads-runtime/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/client/index.js`
+Exports
+- None
+
+### `src/server/multipart/readSingleMultipartFile.js`
+Exports
+- `readSingleMultipartFile(request, options = {})`
+Local functions
+- `normalizeFieldName(value)`
+- `resolveFieldName(options = {})`
+- `resolveMaxBytes(value)`
+- `formatMaxSizeMb(maxBytes)`
+- `isMultipartError(error, code)`
+
+### `src/server/multipart/registerMultipartSupport.js`
+Exports
+- `registerMultipartSupport(app)`
+
+### `src/server/policy/uploadPolicy.js`
+Exports
+- `createUploadFieldError(fieldName, message)`
+- `normalizeUploadPolicy`
+- `readUploadBuffer(stream, { maxBytes = DEFAULT_IMAGE_UPLOAD_POLICY.maxUploadBytes, fieldName = "file", label = "File" } = {})`
+- `validateUploadMimeType(mimeType, policy = DEFAULT_IMAGE_UPLOAD_POLICY, { fieldName = "file", label = "File" } = {})`
+
+### `src/server/providers/UploadsRuntimeServiceProvider.js`
+Exports
+- `UploadsRuntimeServiceProvider`
+
+### `src/server/storage/createUploadStorageService.js`
+Exports
+- `MIME_TYPE_FALLBACK`
+- `MIME_TYPE_JPEG`
+- `MIME_TYPE_PNG`
+- `MIME_TYPE_WEBP`
+- `createUploadStorageService({ storage, mimeTypeDetector = detectCommonMimeTypeFromBuffer } = {})`
+- `detectCommonMimeTypeFromBuffer(buffer)`
+- `normalizeStorageKey(value)`
+
+### `src/shared/imageUploadDefaults.js`
+Exports
+- `DEFAULT_IMAGE_UPLOAD_ALLOWED_MIME_TYPES`
+- `DEFAULT_IMAGE_UPLOAD_MAX_BYTES`
+
+### `src/shared/index.js`
+Exports
+- `DEFAULT_IMAGE_UPLOAD_ALLOWED_MIME_TYPES`
+- `DEFAULT_IMAGE_UPLOAD_MAX_BYTES`
+- `DEFAULT_IMAGE_UPLOAD_POLICY`
+- `normalizeAllowedMimeTypes`
+- `normalizeMaxUploadBytes`
+- `normalizeMimeType`
+- `normalizeUploadPolicy`
+
+### `src/shared/uploadPolicy.js`
+Exports
+- `DEFAULT_IMAGE_UPLOAD_ALLOWED_MIME_TYPES`
+- `DEFAULT_IMAGE_UPLOAD_MAX_BYTES`
+- `DEFAULT_IMAGE_UPLOAD_POLICY`
+- `normalizeAllowedMimeTypes(values = [], fallback = [])`
+- `normalizeMaxUploadBytes(value, fallback = DEFAULT_IMAGE_UPLOAD_MAX_BYTES)`
+- `normalizeMimeType(value)`
+- `normalizeUploadPolicy(policy = {}, defaults = {})`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

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

@@ -0,0 +1,307 @@
+# packages/users-core
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/users-core`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/users-core/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/server/accountNotifications/accountNotificationsActions.js`
+Exports
+- `accountNotificationsActions`
+
+### `src/server/accountNotifications/accountNotificationsService.js`
+Exports
+- `createService({ userSettingsRepository, usersRepository, authService } = {})`
+
+### `src/server/accountNotifications/bootAccountNotificationsRoutes.js`
+Exports
+- `bootAccountNotificationsRoutes(app)`
+
+### `src/server/accountNotifications/registerAccountNotifications.js`
+Exports
+- `registerAccountNotifications(app)`
+
+### `src/server/accountPreferences/accountPreferencesActions.js`
+Exports
+- `accountPreferencesActions`
+
+### `src/server/accountPreferences/accountPreferencesService.js`
+Exports
+- `createService({ userSettingsRepository, usersRepository, authService } = {})`
+
+### `src/server/accountPreferences/bootAccountPreferencesRoutes.js`
+Exports
+- `bootAccountPreferencesRoutes(app)`
+
+### `src/server/accountPreferences/registerAccountPreferences.js`
+Exports
+- `registerAccountPreferences(app)`
+
+### `src/server/accountProfile/accountProfileActions.js`
+Exports
+- `accountProfileActions`
+
+### `src/server/accountProfile/accountProfileService.js`
+Exports
+- `createService({ userSettingsRepository, usersRepository, authService, avatarService } = {})`
+
+### `src/server/accountProfile/avatarService.js`
+Exports
+- `createService({ usersRepository, avatarStorageService, avatarPolicy } = {})`
+- `__testables`
+Local functions
+- `resolveAvatarPolicy(policy = {})`
+- `readAvatarBuffer(stream, { maxBytes = DEFAULT_AVATAR_POLICY.maxUploadBytes } = {})`
+
+### `src/server/accountProfile/avatarStorageService.js`
+Exports
+- `createService({ storage } = {})`
+- `__testables`
+Local functions
+- `buildAvatarStorageKey(userId)`
+
+### `src/server/accountProfile/bootAccountProfileRoutes.js`
+Exports
+- `bootAccountProfileRoutes(app)`
+
+### `src/server/accountProfile/registerAccountProfile.js`
+Exports
+- `registerAccountProfile(app)`
+
+### `src/server/accountSecurity/accountSecurityActions.js`
+Exports
+- `accountSecurityActions`
+
+### `src/server/accountSecurity/accountSecurityService.js`
+Exports
+- `createService({ userSettingsRepository, usersRepository, authService } = {})`
+
+### `src/server/accountSecurity/bootAccountSecurityRoutes.js`
+Exports
+- `bootAccountSecurityRoutes(app)`
+
+### `src/server/accountSecurity/registerAccountSecurity.js`
+Exports
+- `registerAccountSecurity(app)`
+
+### `src/server/common/formatters/accountAvatarFormatter.js`
+Exports
+- `accountAvatarFormatter(profile, settings)`
+Local functions
+- `createGravatarUrl(email, size = 64)`
+- `createUploadedAvatarUrl(profile = {})`
+
+### `src/server/common/formatters/accountSecurityStatusFormatter.js`
+Exports
+- `accountSecurityStatusFormatter(securityStatus = {})`
+Local functions
+- `normalizeMfa(source)`
+- `normalizeAuthMethods(sourceMethods)`
+
+### `src/server/common/formatters/accountSettingsResponseFormatter.js`
+Exports
+- `accountSettingsResponseFormatter({ profile, settings, securityStatus, authService })`
+Local functions
+- `resolveAuthProfileSettings(authService)`
+- `formatUserSettingsSection(section, settings = {})`
+
+### `src/server/common/registerCommonRepositories.js`
+Exports
+- `registerCommonRepositories(app)`
+
+### `src/server/common/registerSharedApi.js`
+Exports
+- `registerSharedApi(app, usersCoreApi)`
+
+### `src/server/common/repositories/repositoryUtils.js`
+Exports
+- `toNullableDateTime`
+- `toIsoString`
+- `isDuplicateEntryError`
+- `normalizeText`
+- `normalizeLowerText`
+- `normalizeRecordId`
+- `normalizeDbRecordId`
+- `nowDb()`
+- `toNullableIso(value)`
+- `uniqueSorted(values)`
+- `parseJson(value, fallback = {})`
+- `toDbJson(value, fallback = {})`
+- `createWithTransaction`
+
+### `src/server/common/repositories/userSettingsRepository.js`
+Exports
+- `createRepository(knex)`
+- `mapRow(row)`
+Local functions
+- `normalizeBoolean(value, fallback = false)`
+- `createInsertPayload(userId)`
+
+### `src/server/common/repositories/usersRepository.js`
+Exports
+- `createRepository(knex)`
+- `mapProfileRow(row)`
+- `normalizeIdentity(identityLike)`
+Local functions
+- `normalizeUsername(value)`
+- `usernameBaseFromEmail(email)`
+- `buildUsernameCandidate(baseUsername, suffix)`
+- `duplicateTargetsEmail(error)`
+- `duplicateTargetsUsername(error)`
+- `createDuplicateEmailConflictError()`
+- `resolveUniqueUsername(client, baseUsername, { excludeUserId = null } = {})`
+
+### `src/server/common/services/accountContextService.js`
+Exports
+- `resolveUserProfile(usersRepository, user)`
+- `resolveSecurityStatus(authService, request)`
+
+### `src/server/common/services/authProfileSyncService.js`
+Exports
+- `createService({ usersRepository, lifecycleContributors = [], userSettingsRepository = null } = {})`
+Local functions
+- `buildNormalizedIdentityKey(identityLike)`
+- `buildNormalizedIdentityProfile(profileLike)`
+- `profileNeedsUpdate(existing, nextProfile)`
+- `requireSynchronizedProfile(profile)`
+- `normalizeLifecycleContributors(entries = [])`
+
+### `src/server/common/support/deepFreeze.js`
+Exports
+- `deepFreeze`
+
+### `src/server/common/support/realtimeServiceEvents.js`
+Exports
+- `ACCOUNT_SETTINGS_AND_BOOTSTRAP_EVENTS`
+Local functions
+- `resolveActorScopedEntityId({ options } = {})`
+
+### `src/server/common/support/resolveActionUser.js`
+Exports
+- `resolveActionUser(context, input)`
+
+### `src/server/common/validators/authenticatedUserValidator.js`
+Exports
+- `authenticatedUserValidator`
+Local functions
+- `normalizeAuthenticatedUser(input = {})`
+
+### `src/server/profileSyncLifecycleContributorRegistry.js`
+Exports
+- `PROFILE_SYNC_LIFECYCLE_CONTRIBUTOR_TAG`
+- `registerProfileSyncLifecycleContributor(app, token, factory)`
+- `resolveProfileSyncLifecycleContributors(scope)`
+Local functions
+- `normalizeProfileSyncLifecycleContributor(entry)`
+
+### `src/server/registerUsersBootstrap.js`
+Exports
+- `registerUsersBootstrap(app)`
+
+### `src/server/registerUsersCore.js`
+Exports
+- `registerUsersCore(app)`
+
+### `src/server/usersBootstrapContributor.js`
+Exports
+- `createUsersBootstrapContributor({ usersRepository, userSettingsRepository, appConfig = {}, authService } = {})`
+Local functions
+- `getOAuthProviderCatalogPayload(authService)`
+- `normalizeBoolean(value, fallback)`
+- `resolveAppState(appConfig = {})`
+- `createAnonymousBootstrapPayload({ appState, surfaceAccess = {} })`
+- `mapUserSettingsBootstrap(settings = {})`
+
+### `src/server/UsersCoreServiceProvider.js`
+Exports
+- `UsersCoreServiceProvider`
+
+### `src/shared/index.js`
+Exports
+- `DEFAULT_USER_SETTINGS`
+- `USERS_SHARED_API`
+
+### `src/shared/operationMessages.js`
+Exports
+- `createOperationMessages({ validationMessage = "Validation failed.", apiValidationMessage = validationMessage } = {})`
+
+### `src/shared/resources/resolveGlobalArrayRegistry.js`
+Exports
+- `resolveGlobalArrayRegistry(symbolKey)`
+
+### `src/shared/resources/userProfileResource.js`
+Exports
+- `userProfileResource`
+Local functions
+- `normalizeProfileInput(payload = {})`
+
+### `src/shared/resources/userSettingsFields.js`
+Exports
+- `USER_SETTINGS_SECTIONS`
+- `defineField(field = {})`
+- `resetUserSettingsFields()`
+- `userSettingsFields`
+
+### `src/shared/resources/userSettingsResource.js`
+Exports
+- `userSettingsResource`
+Local functions
+- `pickPatchBody(schema, keys = [])`
+- `listFieldsBySection(section)`
+- `buildCreateBodySchema()`
+- `buildSectionOutputSchema(section)`
+- `normalizeInput(payload = {})`
+- `normalizeSectionOutput(section, sectionSource = {}, settings = {})`
+- `buildUserSettingsOutputSchema()`
+- `buildUserSettingsCreateBodySchema()`
+- `buildUserSettingsPatchBodySchema()`
+- `buildPreferencesUpdateBodySchema()`
+- `buildNotificationsUpdateBodySchema()`
+- `normalizeOAuthProviderParams(payload = {})`
+- `normalizeOAuthProviderQuery(payload = {})`
+
+### `src/shared/settings.js`
+Exports
+- `DEFAULT_USER_SETTINGS`
+
+### templates
+
+### `templates/migrations/users_core_generic_initial.cjs`
+Exports
+- None
+
+### `templates/migrations/users_core_profile_username.cjs`
+Exports
+- None
+Local functions
+- `normalizeUsername(value)`
+- `usernameBaseFromEmail(email)`
+- `buildUsernameCandidate(baseUsername, suffix)`
+- `resolveUniqueUsername(baseUsername, usedUsernames)`
+
+### `templates/packages/main/src/shared/resources/userSettingsFields.js`
+Exports
+- None
+Local functions
+- `normalizePositiveInteger(value, fallback)`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None
+
+### test-support
+
+### `test-support/registerDefaultSettingsFields.js`
+Exports
+- None