@jskit-ai/agent-docs 0.1.1

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

@@ -0,0 +1,415 @@
+# packages/workspaces-core
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/workspaces-core`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/workspaces-core/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/server/common/contributors/workspaceActionContextContributor.js`
+Exports
+- `createWorkspaceActionContextContributor({ workspaceService, workspaceSurfaceIds = [] } = {})`
+Local functions
+- `normalizeWorkspaceSurfaceIds(surfaceIds = [])`
+
+### `src/server/common/contributors/workspaceAuthPolicyContextResolver.js`
+Exports
+- `createWorkspaceAuthPolicyContextResolver({ workspaceService } = {})`
+
+### `src/server/common/contributors/workspaceRouteVisibilityResolver.js`
+Exports
+- `createWorkspaceRouteVisibilityResolver({ workspaceService } = {})`
+Local functions
+- `buildVisibilityContribution({ visibility, scopeOwnerId = null, userId = null } = {})`
+
+### `src/server/common/formatters/workspaceFormatter.js`
+Exports
+- `mapMembershipSummary(membership, workspace)`
+- `mapWorkspaceSettingsPublic(workspaceSettings, { workspaceInvitationsEnabled = true } = {})`
+- `mapWorkspaceSummary(workspace, membership)`
+
+### `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/workspaceInvitesRepository.js`
+Exports
+- `createRepository(knex)`
+- `mapRow(row)`
+
+### `src/server/common/repositories/workspaceMembershipsRepository.js`
+Exports
+- `createRepository(knex)`
+- `mapRow(row)`
+- `mapMemberSummaryRow(row)`
+
+### `src/server/common/repositories/workspacesRepository.js`
+Exports
+- `createRepository(knex)`
+- `mapRow(row)`
+- `mapMembershipWorkspaceRow(row)`
+
+### `src/server/common/services/workspaceContextService.js`
+Exports
+- `createService({ appConfig = {}, workspacesRepository, workspaceMembershipsRepository, workspaceSettingsRepository } = {})`
+Local functions
+- `toSlugPart(value)`
+- `buildWorkspaceBaseSlug(user = {})`
+- `buildWorkspaceName(user = {})`
+- `buildPermissionsFromMembership(membership, appConfig = {})`
+- `hashInviteToken(token)`
+- `normalizeWorkspaceCreationInput(payload = {})`
+
+### `src/server/common/support/deepFreeze.js`
+Exports
+- `deepFreeze`
+
+### `src/server/common/support/realtimeServiceEvents.js`
+Exports
+- `ACCOUNT_SETTINGS_AND_BOOTSTRAP_EVENTS`
+- `createWorkspaceEntityAndBootstrapEvents({ workspaceEntity, workspaceOperation, workspaceRealtimeEvent, workspaceEntityId = ({ args }) => args?.[0]?.id, bootstrapEntityId = ({ args }) => args?.[0]?.id, bootstrapAudience = "event_scope" } = {})`
+Local functions
+- `resolveActorScopedEntityId({ options } = {})`
+- `resolveWorkspaceSlugPayload({ args } = {})`
+
+### `src/server/common/support/resolveActionUser.js`
+Exports
+- `resolveActionUser(context, input)`
+
+### `src/server/common/support/workspaceRoutePaths.js`
+Exports
+- `WORKSPACE_ROUTE_BASE_PATH`
+- `resolveWorkspaceRoutePath(relativePath = "/")`
+
+### `src/server/common/validators/authenticatedUserValidator.js`
+Exports
+- `authenticatedUserValidator`
+Local functions
+- `normalizeAuthenticatedUser(input = {})`
+
+### `src/server/common/validators/routeParamsValidator.js`
+Exports
+- `routeParamsValidator`
+- `workspaceSlugParamsValidator`
+Local functions
+- `normalizeRouteParams(input = {})`
+- `normalizeWorkspaceSlugParams(input = {})`
+
+### `src/server/registerWorkspaceBootstrap.js`
+Exports
+- `registerWorkspaceBootstrap(app)`
+
+### `src/server/registerWorkspaceCore.js`
+Exports
+- `registerWorkspaceCore(app)`
+
+### `src/server/registerWorkspaceRepositories.js`
+Exports
+- `registerWorkspaceRepositories(app)`
+
+### `src/server/support/resolveWorkspace.js`
+Exports
+- `resolveWorkspace(context = {}, input = {})`
+Local functions
+- `resolveRequest(context = {})`
+
+### `src/server/support/workspaceActionSurfaces.js`
+Exports
+- `resolveWorkspaceSurfaceIdsFromAppConfig(appConfig = {})`
+- `resolveDefaultWorkspaceRouteSurfaceIdFromAppConfig(appConfig = {})`
+- `materializeWorkspaceActionSurfaces(actions = [], { workspaceSurfaceIds = [] } = {})`
+- `materializeWorkspaceActionSurfacesFromAppConfig(actions = [], { appConfig = {} } = {})`
+- `registerWorkspaceActionSurfaceSources(app)`
+Local functions
+- `normalizeSurfaceIds(surfaceIds = [])`
+- `resolveSurfaceIdsFromAppConfig(appConfig = {}, predicate)`
+
+### `src/server/support/workspaceInvitationsPolicy.js`
+Exports
+- `normalizeWorkspaceInvitationsConfig(appConfig = {})`
+- `resolveWorkspaceInvitationsPolicy({ appConfig = {}, tenancyProfile = null } = {})`
+
+### `src/server/support/workspaceRouteInput.js`
+Exports
+- `readWorkspaceSlugFromRouteParams(params = {})`
+- `buildWorkspaceInputFromRouteParams(params = {})`
+
+### `src/server/workspaceBootstrapContributor.js`
+Exports
+- `createWorkspaceBootstrapContributor({ workspaceService, workspacePendingInvitationsService, usersRepository, workspaceInvitationsEnabled = false, appConfig = {}, tenancyProfile = null } = {})`
+Local functions
+- `normalizePendingInvites(invites)`
+- `normalizeQueryPayload(value = {})`
+- `resolveBootstrapWorkspaceSlug({ query = {}, request = null } = {})`
+- `normalizeRequestedWorkspaceStatus(value = "")`
+- `createRequestedWorkspacePayload(workspaceSlug = "", status = "")`
+- `resolveRequestedWorkspaceStatusFromError(error)`
+- `resolveBootstrapTenancyProfile(tenancyProfile = null, appConfig = {})`
+
+### `src/server/workspaceDirectory/bootWorkspaceDirectoryRoutes.js`
+Exports
+- `bootWorkspaceDirectoryRoutes(app)`
+
+### `src/server/workspaceDirectory/registerWorkspaceDirectory.js`
+Exports
+- `registerWorkspaceDirectory(app)`
+
+### `src/server/workspaceDirectory/workspaceDirectoryActions.js`
+Exports
+- `workspaceDirectoryActions`
+
+### `src/server/workspaceMembers/bootWorkspaceMembers.js`
+Exports
+- `bootWorkspaceMembers(app)`
+
+### `src/server/workspaceMembers/registerWorkspaceMembers.js`
+Exports
+- `registerWorkspaceMembers(app)`
+Local functions
+- `resolveWorkspaceMembersInviteExpiresInMs(appConfig = {})`
+
+### `src/server/workspaceMembers/workspaceMembersActions.js`
+Exports
+- `workspaceMembersActions`
+
+### `src/server/workspaceMembers/workspaceMembersService.js`
+Exports
+- `createService({ workspaceMembershipsRepository, workspaceInvitesRepository, inviteExpiresInMs, roleCatalog = null, workspaceInvitationsEnabled = true } = {})`
+
+### `src/server/workspacePendingInvitations/bootWorkspacePendingInvitations.js`
+Exports
+- `bootWorkspacePendingInvitations(app)`
+
+### `src/server/workspacePendingInvitations/registerWorkspacePendingInvitations.js`
+Exports
+- `registerWorkspacePendingInvitations(app)`
+Local functions
+- `workspaceAudienceFromEntityId({ event } = {})`
+- `actorUserEntityId({ options } = {})`
+- `createActorUserEvent({ source, entity, realtimeEvent })`
+- `createWorkspaceAudienceEvent({ entity, realtimeEvent })`
+- `createInviteDecisionEvents({ includeDirectoryAndMembers = false } = {})`
+
+### `src/server/workspacePendingInvitations/workspacePendingInvitationsActions.js`
+Exports
+- `workspacePendingInvitationsActions`
+
+### `src/server/workspacePendingInvitations/workspacePendingInvitationsService.js`
+Exports
+- `createService({ workspaceInvitesRepository, workspaceMembershipsRepository } = {})`
+
+### `src/server/WorkspacesCoreServiceProvider.js`
+Exports
+- `WorkspacesCoreServiceProvider`
+
+### `src/server/workspaceSettings/bootWorkspaceSettings.js`
+Exports
+- `bootWorkspaceSettings(app)`
+
+### `src/server/workspaceSettings/registerWorkspaceSettings.js`
+Exports
+- `registerWorkspaceSettings(app)`
+Local functions
+- `resolveWorkspaceSettingsDefaultInvitesEnabled(appConfig = {})`
+
+### `src/server/workspaceSettings/workspaceSettingsActions.js`
+Exports
+- `workspaceSettingsActions`
+
+### `src/server/workspaceSettings/workspaceSettingsRepository.js`
+Exports
+- `createRepository(knex, { defaultInvitesEnabled } = {})`
+Local functions
+- `resolveWorkspaceSettingsSeed(workspace = {}, { defaultInvitesEnabled = true } = {})`
+
+### `src/server/workspaceSettings/workspaceSettingsService.js`
+Exports
+- `createService({ workspaceSettingsRepository, workspaceInvitationsEnabled = true, roleCatalog = null } = {})`
+
+### `src/shared/operationMessages.js`
+Exports
+- `createOperationMessages({ validationMessage = "Validation failed.", apiValidationMessage = validationMessage } = {})`
+
+### `src/shared/resources/resolveGlobalArrayRegistry.js`
+Exports
+- `resolveGlobalArrayRegistry(symbolKey)`
+
+### `src/shared/resources/workspaceMembersResource.js`
+Exports
+- `workspaceMembersResource`
+Local functions
+- `normalizeWorkspaceAdminSummary(workspace)`
+- `normalizeMemberSummary(member, workspace)`
+- `normalizeInviteSummary(invite)`
+- `normalizeWorkspaceOutputEnvelope(payload = {}, { itemsKey, normalizeItem, includeInviteTokenPreview = false } = {})`
+- `normalizeWorkspaceMembersOutput(payload = {})`
+- `normalizeWorkspaceInvitesOutput(payload = {})`
+
+### `src/shared/resources/workspacePendingInvitationsResource.js`
+Exports
+- `workspacePendingInvitationsResource`
+Local functions
+- `normalizePendingInvite(invite)`
+- `normalizePendingInviteList(invites)`
+
+### `src/shared/resources/workspaceResource.js`
+Exports
+- `workspaceResource`
+Local functions
+- `normalizeWorkspaceAvatarUrl(value)`
+- `normalizeWorkspaceInput(payload = {})`
+- `normalizeWorkspaceOutput(payload = {})`
+- `normalizeWorkspaceListItemOutput(payload = {})`
+
+### `src/shared/resources/workspaceSettingsFields.js`
+Exports
+- `defineField(field = {})`
+- `resetWorkspaceSettingsFields()`
+- `resolveWorkspaceSettingsFieldKeys()`
+- `workspaceSettingsFields`
+
+### `src/shared/resources/workspaceSettingsResource.js`
+Exports
+- `workspaceSettingsResource`
+Local functions
+- `buildCreateBodySchema()`
+- `buildSettingsOutputSchema()`
+- `buildResponseRecordSchema()`
+- `normalizeInput(payload = {})`
+- `normalizeOutput(payload = {})`
+
+### `src/shared/roles.js`
+Exports
+- `OWNER_ROLE_ID`
+- `ADMIN_ROLE_ID`
+- `MEMBER_ROLE_ID`
+- `resolveRolePermissions(roleSid, appConfig = {})`
+- `listRoleDescriptors(appConfig = {})`
+- `createWorkspaceRoleCatalog(appConfig = {})`
+- `cloneWorkspaceRoleCatalog(roleCatalog = null)`
+- `hasPermission`
+Local functions
+- `asRecord(value)`
+- `normalizeRoleId(value)`
+- `resolveInheritedRolePermissions(roleSid, configuredRoles = {}, seenRoleIds = new Set())`
+- `createRoleDescriptor(roleSid, configuredDefinition, configuredRoles = {})`
+- `listConfiguredRoleIds(appConfig = {})`
+- `resolveConfiguredDefaultInviteRole(appConfig = {})`
+- `normalizeConfiguredRoles(appConfig = {})`
+
+### `src/shared/settings.js`
+Exports
+- `DEFAULT_WORKSPACE_DARK_PALETTE`
+- `DEFAULT_WORKSPACE_LIGHT_PALETTE`
+- `DEFAULT_WORKSPACE_COLOR`
+- `coerceWorkspaceColor(value)`
+- `coerceWorkspaceThemeColor(value, fallbackColor = DEFAULT_WORKSPACE_COLOR)`
+- `coerceWorkspaceSecondaryColor(value, { mode = WORKSPACE_THEME_MODE_LIGHT } = {})`
+- `coerceWorkspaceSurfaceColor(value, { mode = WORKSPACE_THEME_MODE_LIGHT } = {})`
+- `coerceWorkspaceSurfaceVariantColor(value, { mode = WORKSPACE_THEME_MODE_LIGHT } = {})`
+- `normalizeWorkspaceHexColor(value)`
+- `normalizeWorkspaceThemeMode(value = "")`
+- `resolveWorkspaceThemeDefaultPalette(mode = WORKSPACE_THEME_MODE_LIGHT)`
+- `resolveWorkspaceThemePalettes(input = {})`
+- `WORKSPACE_THEME_MODE_DARK`
+- `WORKSPACE_THEME_MODE_LIGHT`
+- `resolveWorkspaceThemePalette(input = {}, { mode = WORKSPACE_THEME_MODE_LIGHT } = {})`
+
+### `src/shared/support/workspacePathModel.js`
+Exports
+- `normalizePathname`
+- `normalizeSurfaceSegmentFromRouteBase(routeBase, { workspaceBasePath = "/w" } = {})`
+- `parseWorkspacePathname(pathname = "", { workspaceBasePath = "/w" } = {})`
+- `resolveDefaultWorkspaceSurfaceId({ defaultSurfaceId = "", workspaceSurfaceIds = [], surfaceRequiresWorkspace = null } = {})`
+- `resolveWorkspaceSurfaceIdFromSuffixSegments({ suffixSegments = [], defaultWorkspaceSurfaceId = "", workspaceSurfaces = [] } = {})`
+Local functions
+- `normalizeWorkspaceBasePath(workspaceBasePath = "/w")`
+- `normalizeSurfaceSegment(segmentLike = "")`
+- `normalizeSurfaceRouteBase(routeBaseLike = "")`
+
+### `src/shared/tenancyMode.js`
+Exports
+- `TENANCY_MODE_NONE`
+- `TENANCY_MODE_PERSONAL`
+- `TENANCY_MODE_WORKSPACES`
+- `TENANCY_MODES`
+- `normalizeTenancyMode(value = "")`
+- `isTenancyMode(value = "")`
+
+### `src/shared/tenancyProfile.js`
+Exports
+- `TENANCY_MODE_NONE`
+- `TENANCY_MODE_PERSONAL`
+- `TENANCY_MODE_WORKSPACES`
+- `normalizeTenancyMode`
+- `WORKSPACE_SLUG_POLICY_NONE`
+- `WORKSPACE_SLUG_POLICY_IMMUTABLE_USERNAME`
+- `WORKSPACE_SLUG_POLICY_USER_SELECTED`
+- `resolveTenancyProfile(appConfig = {})`
+- `isWorkspacesTenancyMode(value = "")`
+Local functions
+- `resolveWorkspacePolicyOverrides(appConfig = {})`
+- `resolveWorkspacePolicy(mode, overrides = {})`
+
+### templates
+
+### `templates/config/roles.js`
+Exports
+- `roleCatalog`
+
+### `templates/migrations/workspaces_core_initial.cjs`
+Exports
+- None
+
+### `templates/migrations/workspaces_core_workspace_settings_single_name_source.cjs`
+Exports
+- None
+Local functions
+- `hasTable(knex, tableName)`
+- `hasColumn(knex, tableName, columnName)`
+
+### `templates/migrations/workspaces_core_workspaces_drop_color.cjs`
+Exports
+- None
+Local functions
+- `hasTable(knex, tableName)`
+- `hasColumn(knex, tableName, columnName)`
+- `normalizeHexColor(value)`
+
+### `templates/packages/main/src/shared/resources/workspaceSettingsFields.js`
+Exports
+- None
+Local functions
+- `normalizeHexColor(value)`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None
+
+### test-support
+
+### `test-support/registerDefaultSettingsFields.js`
+Exports
+- None