@jskit-ai/agent-docs 0.1.256 → 0.1.258

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

@@ -16,42 +16,27 @@ Use this on demand; do not load the full index at startup.
 
 ### `src/server/common/contributors/workspaceActionContextContributor.js`
 Exports
-- `createWorkspaceActionContextContributor({ workspaceService, workspaceMembershipOptionalSurfaceIds = [], workspaceSurfaceIds = [] } = {})`
-Local functions
-- `normalizeWorkspaceSurfaceIds(surfaceIds = [])`
+- `createWorkspaceActionContextContributor({ workspaceService, workspaceMembershipOptionalSurfaceIds, workspaceSurfaceIds })`
 
 ### `src/server/common/contributors/workspaceAuthPolicyContextResolver.js`
 Exports
-- `createWorkspaceAuthPolicyContextResolver({ workspaceService, workspaceMembershipOptionalSurfaceIds = [] } = {})`
+- `createWorkspaceAuthPolicyContextResolver({ workspaceService, workspaceMembershipOptionalSurfaceIds })`
 
 ### `src/server/common/contributors/workspaceRouteVisibilityResolver.js`
 Exports
-- `createWorkspaceRouteVisibilityResolver({ workspaceService, workspaceMembershipOptionalSurfaceIds = [] } = {})`
+- `createWorkspaceRouteVisibilityResolver({ workspaceService, workspaceMembershipOptionalSurfaceIds })`
 Local functions
 - `buildVisibilityContribution({ visibility, scopeOwnerId = null, userId = null } = {})`
 
 ### `src/server/common/formatters/workspaceFormatter.js`
 Exports
 - `mapMembershipSummary(membership, workspace)`
-- `mapWorkspaceSettingsPublic(workspaceSettings, { workspaceInvitationsEnabled = true } = {})`
+- `mapWorkspaceSettingsPublic(workspaceSettings, { workspaceInvitationsEnabled })`
 - `mapWorkspaceSummary(workspace, membership, roleCatalog = null)`
 
-### `src/server/common/repositories/repositoryUtils.js`
-Exports
-- `toIsoString`
-- `retryDeadlocks`
-- `isDuplicateEntryError`
-- `normalizeText`
-- `normalizeLowerText`
-- `normalizeRecordId`
-- `normalizeDbRecordId`
-- `uniqueSorted(values)`
-- `parseJson(value, fallback = {})`
-- `toDbJson(value, fallback = {})`
-
 ### `src/server/common/repositories/workspaceInvitesRepository.js`
 Exports
-- `createRepository({ api } = {})`
+- `createRepository({ api })`
 - `normalizeInviteRecord(payload)`
 - `normalizeInviteWithWorkspace(payload = {})`
 Local functions
@@ -59,55 +44,40 @@ Local functions
 
 ### `src/server/common/repositories/workspaceMembershipsRepository.js`
 Exports
-- `createRepository({ api } = {})`
+- `createRepository({ api })`
 - `normalizeMembershipRecord(payload)`
 - `normalizeMemberSummaryRow(row)`
-Local functions
-- `normalizeMembershipPatchPayload(payload = {})`
 
 ### `src/server/common/repositories/workspacesRepository.js`
 Exports
-- `createRepository({ api } = {})`
+- `createRepository({ api })`
 Local functions
 - `normalizeWorkspaceRecord(payload = null)`
 
-### `src/server/common/services/workspaceContextService.js`
+### `src/server/common/services/workspaceDirectoryService.js`
 Exports
-- `createService({ appConfig = {}, workspacesRepository, workspaceMembershipsRepository, workspaceSettingsRepository } = {})`
+- `buildWorkspaceName(user)`
+- `createService({ tenancyProfile, roleCatalog, personalWorkspaceName, 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`
+- `buildWorkspaceBaseSlug(user)`
 
 ### `src/server/common/support/realtimeServiceEvents.js`
 Exports
 - `INVITE_RECIPIENT_BOOTSTRAP_AUDIENCE`
 - `createInviteDecisionEvents()`
-- `createWorkspaceEntityAndBootstrapEvents({ workspaceEntity, workspaceOperation, workspaceRealtimeEvent, bootstrapEntityId = workspaceId, bootstrapAudience = "event_scope" } = {})`
+- `createWorkspaceEntityAndBootstrapEvents({ workspaceEntity, workspaceOperation, workspaceRealtimeEvent, bootstrapEntityId = workspaceId, bootstrapAudience = "event_scope" })`
 Local functions
-- `resultValue({ result } = {})`
-- `actorId({ context } = {})`
+- `actorId({ context })`
 - `workspaceId(execution = {})`
 - `workspaceSlugPayload(execution = {})`
 - `createActorEvent({ source, entity, realtimeEvent })`
 - `createWorkspaceAudienceEvent({ entity, realtimeEvent })`
 - `onlyAccepted(builder)`
 
-### `src/server/common/support/resolveActionUser.js`
+### `src/server/common/support/workspaceRecordId.js`
 Exports
-- `resolveActionUser(context, input)`
-
-### `src/server/common/support/workspaceRoutePaths.js`
-Exports
-- `WORKSPACE_ROUTE_BASE_PATH`
-- `resolveWorkspaceRoutePath(relativePath = "/")`
+- `resolveWorkspaceRecordId(record, context = {})`
 
 ### `src/server/common/validators/routeParamsValidator.js`
 Exports
@@ -121,133 +91,159 @@ Exports
 ### `src/server/support/resolveWorkspace.js`
 Exports
 - `resolveWorkspace(context = {}, input = {})`
-Local functions
-- `resolveRequest(context = {})`
 
 ### `src/server/support/workspaceActionSurfaces.js`
 Exports
 - `resolveWorkspaceSurfaceIdsFromAppConfig(appConfig = {})`
 - `resolveWorkspaceMembershipOptionalSurfaceIdsFromAppConfig(appConfig = {})`
 - `resolveDefaultWorkspaceRouteSurfaceIdFromAppConfig(appConfig = {})`
-- `materializeWorkspaceActionSurfaces(actions = [], { workspaceSurfaceIds = [] } = {})`
-- `materializeWorkspaceActionSurfacesFromAppConfig(actions = [], { appConfig = {} } = {})`
 Local functions
 - `normalizeSurfaceIds(surfaceIds = [])`
 - `resolveSurfaceIdsFromAppConfig(appConfig = {}, predicate)`
 
+### `src/server/support/workspaceCrud.js`
+Exports
+- `WORKSPACE_CRUD_SCOPE`
+Local functions
+- `workspaceCrudScopeInput(request)`
+
 ### `src/server/support/workspaceInvitationsPolicy.js`
 Exports
-- `normalizeWorkspaceInvitationsConfig(appConfig = {})`
-- `resolveWorkspaceInvitationsPolicy({ appConfig = {}, tenancyProfile = null } = {})`
+- `resolveWorkspaceInvitationsPolicy({ appConfig, tenancyProfile })`
+Local functions
+- `normalizeWorkspaceInvitationsConfig(appConfig)`
 
 ### `src/server/support/workspaceRouteInput.js`
 Exports
 - `readWorkspaceSlugFromRouteParams(params = {})`
 - `buildWorkspaceInputFromRouteParams(params = {})`
+- `requestedWorkspaceScope(request)`
 
-### `src/server/workspaceBootstrapContributor.js`
+### `src/server/support/workspaceRoutePaths.js`
 Exports
-- `createWorkspaceBootstrapContributor({ workspaceService, workspacePendingInvitationsService, userProfilesRepository, workspaceInvitationsEnabled = false, appConfig = {}, tenancyProfile = null } = {})`
-Local functions
-- `normalizeQueryPayload(value = {})`
-- `resolveBootstrapWorkspaceSlug({ query = {}, request = null } = {})`
-- `normalizeRequestedWorkspaceStatus(value = "")`
-- `createRequestedWorkspacePayload(workspaceSlug = "", status = "")`
-- `resolveRequestedWorkspaceStatusFromError(error)`
-- `resolveBootstrapTenancyProfile(tenancyProfile = null, appConfig = {})`
+- `WORKSPACE_ROUTE_BASE_PATH`
+- `resolveWorkspaceRoutePath(relativePath)`
+
+### `src/server/types.js`
+Exports
+- `type WorkspacesCore`
+- `type WorkspaceDirectoryService`
+- `type WorkspaceMembersService`
+- `type WorkspacePendingInvitationsService`
+- `type WorkspaceSettingsService`
+- `type WorkspacesRepository`
+- `type WorkspaceMembershipsRepository`
+- `type WorkspaceInvitesRepository`
+- `type WorkspaceSettingsRepository`
+- `type WorkspaceRoleCatalog`
+- `type WorkspaceTenancyProfile`
+- `type WorkspaceInviteUrlBuilder`
+- `type WorkspacesServerI18n`
+- `type WorkspaceInviteMailer`
+- `type WorkspaceInviteEmailTemplate`
+- `type WorkspaceInviteAcceptanceParticipant`
+- `type PersonalWorkspaceName`
 
-### `src/server/workspaceDirectory/bootWorkspaceDirectoryRoutes.js`
+### `src/server/workspaceBootstrapContributor.js`
 Exports
-- `registerWorkspaceDirectoryRoutes(router, { config = {}, workspaceSelfCreateEnabled = false } = {})`
+- `createWorkspaceBootstrapContributor({ workspaceService, workspacePendingInvitationsService, userProfilesRepository, workspaceInvitationsEnabled, tenancyProfile })`
 Local functions
-- `resolveWorkspaceRecordId(record = {}, context = {})`
+- `resolveBootstrapWorkspaceSlug({ query, request })`
+- `normalizeRequestedWorkspaceStatus(value)`
+- `buildRequestedWorkspacePayload(workspaceSlug, status)`
+- `resolveRequestedWorkspaceStatusFromError(error)`
 
 ### `src/server/workspaceDirectory/workspaceDirectoryActions.js`
 Exports
-- `workspaceDirectoryActionSpecifications`
-- `buildWorkspaceDirectoryActions({ workspaceService } = {})`
+- `createWorkspaceDirectoryActions({ workspaceService })`
 Local functions
 - `workspaceAssistantSummary({ id, slug, name, ownerUserId, avatarUrl })`
 
-### `src/server/workspaceMembers/bootWorkspaceMembers.js`
+### `src/server/workspaceDirectory/workspaceDirectoryRoutes.js`
 Exports
-- `registerWorkspaceMembersRoutes(router, { config = {}, workspaceInvitationsEnabled = false } = {})`
-Local functions
-- `resolveWorkspaceAggregateRecordId(record = {}, context = {})`
+- `registerWorkspaceDirectoryRoutes(router, { config, workspaceSelfCreateEnabled })`
 
 ### `src/server/workspaceMembers/defaultWorkspaceInviteEmail.js`
 Exports
-- `renderDefaultWorkspaceInviteEmail({ inviteUrl = "", workspace = {}, inviter = null, roleSid = "member", roleLabel = "", expiresAt = "", t = english } = {})`
+- `renderDefaultWorkspaceInviteEmail({ inviteUrl, workspace, inviter, roleSid, roleLabel, expiresAt, t })`
 Local functions
-- `english(key, params)`
-- `escapeHtml(value = "")`
+- `escapeHtml(value)`
+
+### `src/server/workspaceMembers/unconfiguredWorkspaceInviteMailer.js`
+Exports
+- `buildMailerUnconfiguredDelivery()`
+- `unconfiguredWorkspaceInviteMailer`
 
 ### `src/server/workspaceMembers/workspaceInviteUrls.js`
 Exports
-- `buildInvitePath(token, pathTemplate = "/invite/:token")`
-- `createWorkspaceInviteUrlBuilder({ appConfig = {}, env = {} } = {})`
+- `createWorkspaceInviteUrlBuilder({ appConfig, env })`
 Local functions
-- `normalizeInvitePathTemplate(value = "")`
-- `normalizeBaseUrl(value = "")`
+- `normalizeInvitePathTemplate(value)`
+- `buildInvitePath(token, template)`
+- `normalizeBaseUrl(value)`
 
 ### `src/server/workspaceMembers/workspaceMembersActions.js`
 Exports
-- `workspaceMembersActionSpecifications`
-- `buildWorkspaceMembersActions({ workspaceMembersService } = {})`
+- `createWorkspaceMembersActions({ workspaceMembersService })`
+
+### `src/server/workspaceMembers/workspaceMembersRoutes.js`
+Exports
+- `registerWorkspaceMembersRoutes(router, { config, workspaceInvitationsEnabled })`
 
 ### `src/server/workspaceMembers/workspaceMembersService.js`
 Exports
-- `createService({ workspaceMembershipsRepository, workspaceInvitesRepository, inviteExpiresInMs, roleCatalog = null, workspaceInvitationsEnabled = true, inviteUrlBuilder = null, workspaceInviteMailer = null, workspaceInviteEmailTemplate = renderDefaultWorkspaceInviteEmail, i18n = createWorkspacesServerI18n(), userProfilesRepository = null, userSettingsRepository = null } = {})`
+- `createService({ workspaceMembershipsRepository, workspaceInvitesRepository, inviteExpiresInMs, roleCatalog, workspaceInvitationsEnabled, inviteUrlBuilder, workspaceInviteMailer, workspaceInviteEmailTemplate, i18n, userProfilesRepository, userSettingsRepository })`
 Local functions
 - `roleNotAssignableError()`
+- `memberUserIdRequiredError()`
+- `inviteIdRequiredError()`
 
-### `src/server/workspacePendingInvitations/bootWorkspacePendingInvitations.js`
+### `src/server/workspacePendingInvitations/noInviteAcceptanceParticipant.js`
 Exports
-- `registerWorkspacePendingInvitationsRoutes(router)`
-Local functions
-- `resolveAuthenticatedUserRecordId(_record, context = {})`
-- `resolveInviteResolutionRecordId(record = {})`
+- `noInviteAcceptanceParticipant()`
 
 ### `src/server/workspacePendingInvitations/workspacePendingInvitationsActions.js`
 Exports
-- `workspacePendingInvitationsActionSpecifications`
-- `buildWorkspacePendingInvitationsActions({ workspacePendingInvitationsService } = {})`
+- `createWorkspacePendingInvitationsActions({ workspacePendingInvitationsService })`
 
-### `src/server/workspacePendingInvitations/workspacePendingInvitationsService.js`
+### `src/server/workspacePendingInvitations/workspacePendingInvitationsRoutes.js`
 Exports
-- `createService({ workspaceInvitesRepository, workspaceMembershipsRepository, roleCatalog = null } = {})`
+- `registerWorkspacePendingInvitationsRoutes(router)`
+Local functions
+- `resolveAuthenticatedUserRecordId(_record, context)`
+- `resolveInviteResolutionRecordId(record)`
 
-### `src/server/workspaceSettings/bootWorkspaceSettings.js`
+### `src/server/workspacePendingInvitations/workspacePendingInvitationsService.js`
 Exports
-- `registerWorkspaceSettingsRoutes(router, { config = {} } = {})`
-Local functions
-- `resolveWorkspaceSettingsRecordId(record = {}, context = {})`
+- `createService({ workspaceInvitesRepository, workspaceMembershipsRepository, roleCatalog, acceptanceParticipant })`
 
 ### `src/server/workspaceSettings/workspaceSettingsActions.js`
 Exports
-- `workspaceSettingsActionSpecifications`
-- `buildWorkspaceSettingsActions({ workspaceSettingsService } = {})`
+- `createWorkspaceSettingsActions({ workspaceSettingsService })`
 
 ### `src/server/workspaceSettings/workspaceSettingsRepository.js`
 Exports
-- `createRepository({ api, defaultInvitesEnabled = true, defaultColorSettings = {} } = {})`
+- `createRepository({ api, defaultInvitesEnabled, defaultColorSettings })`
 Local functions
-- `createDefaultWorkspaceSettingsCreatePayload(workspaceId, defaultInvitesEnabled, defaultColorSettings = {})`
+- `buildDefaultWorkspaceSettingsCreatePayload(workspaceId, defaultInvitesEnabled, defaultColorSettings)`
+
+### `src/server/workspaceSettings/workspaceSettingsRoutes.js`
+Exports
+- `registerWorkspaceSettingsRoutes(router, { config })`
 
 ### `src/server/workspaceSettings/workspaceSettingsService.js`
 Exports
-- `createService({ workspaceSettingsRepository, workspaceInvitationsEnabled = true, roleCatalog = null } = {})`
+- `createService({ workspaceSettingsRepository, workspaceInvitationsEnabled, roleCatalog })`
 
 ### `src/server/WorkspacesFeature.js`
 Exports
 - `WorkspacesFeature`
-- `createWorkspacesRuntime({ appRoot = "", config, env, jsonRestApi, users = null } = {})`
-- `installWorkspaceResources(jsonRestApi)`
-Local functions
-- `requirePositiveInteger(value, label)`
-- `requireBoolean(value, label)`
-- `requireWorkspaceColorDefaults(defaults)`
-- `resolveInviteEmailTemplate(config)`
+- `buildWorkspaceName`
+- `createWorkspacesRuntime`
+- `installWorkspaceResources`
+- `noInviteAcceptanceParticipant`
+- `renderDefaultWorkspaceInviteEmail`
+- `unconfiguredWorkspaceInviteMailer`
 
 ### `src/server/WorkspacesIntegrationsProvider.js`
 Exports
@@ -255,6 +251,15 @@ Exports
 Local functions
 - `resolveWorkspaceRealtimeScopes(workspaceMemberships, actorId)`
 
+### `src/server/workspacesRuntime.js`
+Exports
+- `createWorkspacesRuntime({ appRoot, config, env, inviteMailer, inviteEmailTemplate, inviteAcceptanceParticipant, personalWorkspaceName, jsonRestApi, users })`
+- `installWorkspaceResources(jsonRestApi)`
+Local functions
+- `requirePositiveInteger(value, label)`
+- `requireBoolean(value, label)`
+- `requireWorkspaceColorDefaults(defaults)`
+
 ### `src/shared/jsonApiTransports.js`
 Exports
 - `WORKSPACES_TRANSPORT`
@@ -271,7 +276,7 @@ Exports
 
 ### `src/shared/operationMessages.js`
 Exports
-- `createOperationMessages({ validationMessage = "Validation failed.", apiValidationMessage = validationMessage } = {})`
+- `OPERATION_MESSAGES`
 
 ### `src/shared/resources/workspaceAssistantOutputs.js`
 Exports
@@ -297,6 +302,7 @@ Exports
 ### `src/shared/resources/workspaceResource.js`
 Exports
 - `workspaceResource`
+- `WORKSPACE_PATCH_FIELD_KEYS`
 - `workspaceListItemOutputValidator`
 Local functions
 - `normalizeWorkspaceAvatarUrl(value)`
@@ -320,6 +326,7 @@ Exports
 - `ADMIN_ROLE_ID`
 - `MEMBER_ROLE_ID`
 - `resolveRolePermissions(roleSid, appConfig = {})`
+- `listCatalogRolePermissions(roleCatalog, roleSid)`
 - `listRoleDescriptors(appConfig = {})`
 - `createWorkspaceRoleCatalog(appConfig = {})`
 - `cloneWorkspaceRoleCatalog(roleCatalog = null)`
@@ -417,4 +424,12 @@ Exports
 
 ### `patterns/workspace-server/example/packages/main/src/server/email/workspaceInviteEmail.js`
 Exports
-- `renderWorkspaceInviteEmail({ inviteUrl = "", workspace = {}, inviter = null, roleSid = "member", expiresAt = "" } = {})`
+- `renderWorkspaceInviteEmail({ inviteUrl, workspace, inviter, roleSid, roleLabel, expiresAt })`
+
+### `patterns/workspace-server/example/packages/main/src/server/email/workspaceInviteMailer.js`
+Exports
+- `createWorkspaceInviteMailer({ env })`
+
+### `patterns/workspace-server/example/packages/main/src/server/WorkspaceInvitationsFeature.js`
+Exports
+- `WorkspaceInvitationsFeature`

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

@@ -262,7 +262,7 @@ Exports
 - `WORKSPACE_BOOTSTRAP_STATUS_FORBIDDEN`
 - `WORKSPACE_BOOTSTRAP_STATUS_UNAUTHENTICATED`
 - `WORKSPACE_BOOTSTRAP_STATUS_ERROR`
-- `createBootstrapPlacementRuntime({ bootstrapRuntime, placementRuntime, realtime = null, router = null, vueApp = null, logger = null } = {})`
+- `createBootstrapPlacementRuntime({ bootstrapRuntime, placementRuntime, realtime = null, router = null, vueApp = null, logger })`
 
 ### `src/client/runtime/bootstrapPlacementRuntimeConstants.js`
 Exports
@@ -279,7 +279,6 @@ Exports
 ### `src/client/runtime/bootstrapPlacementRuntimeHelpers.js`
 Exports
 - `countPendingInvites(entries = [])`
-- `createProviderLogger(logger)`
 - `fetchBootstrapPayload(workspaceSlug = "")`
 - `isGuardDenied(outcome)`
 - `normalizeSearch(search = "")`