@jskit-ai/agent-docs 0.1.261 → 0.1.263

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

@@ -16,13 +16,21 @@ Use this on demand; do not load the full index at startup.
 
 ### `src/client/account-settings/accountSettingsInvitesRuntime.js`
 Exports
-- `createAccountSettingsInvitesRuntime({ invitesAvailable, isResolvingInvite, inviteAction, redeemInviteModel, redeemInviteCommand, pendingInvites, pendingInvitesModel, pendingInvitesView, openWorkspace, reportAccountFeedback } = {})`
+- `createAccountSettingsInvitesRuntime({ invitesAvailable, isResolvingInvite, inviteAction, redeemInviteModel, redeemInviteCommand, pendingInvites, pendingInvitesModel, pendingInvitesView, openWorkspace, reportAccountFeedback })`
 
 ### `src/client/account-settings/useAccountSettingsInvitesSectionRuntime.js`
 Exports
 - `useAccountSettingsInvitesSectionRuntime()`
+
+### `src/client/browser.js`
+Exports
+- `assignPageLocation(href)`
+- `pageClipboard()`
+- `pageLocalStorage()`
+- `pagePathname()`
+- `pagePrefersDark()`
 Local functions
-- `normalizePendingInvite(entry)`
+- `pageWindow()`
 
 ### `src/client/components/AccountSettingsInvitesSection.vue`
 Exports
@@ -56,25 +64,6 @@ Local functions
 ### `src/client/components/WorkspaceMembersClientElement.vue`
 Exports
 - None
-Local functions
-- `workspaceMembersPath(memberId)`
-- `workspaceInvitePath(inviteId)`
-- `resetMessages()`
-- `clearRoleOptions()`
-- `resetViewState()`
-- `toRoleTitle(roleSid)`
-- `normalizeRoleCatalog(payload = {})`
-- `applyRoleCatalog(payload = {})`
-- `normalizeMembers(entries)`
-- `normalizeInvites(entries)`
-- `latestPage(pages)`
-- `applyWorkspaceSettingsPolicy(payload = {})`
-- `refreshLoad()`
-- `submitInvite()`
-- `copyCreatedInviteLink()`
-- `submitRevokeInvite(inviteId)`
-- `submitMemberRoleUpdate(member, roleSid)`
-- `submitRemoveMember(member)`
 
 ### `src/client/components/WorkspaceMembersMenuItem.vue`
 Exports
@@ -94,25 +83,14 @@ Exports
 Exports
 - None
 Local functions
-- `normalizePendingInvite(entry)`
-- `reportFeedback({ message, severity = "error", channel = "", dedupeKey = "" } = {})`
 - `workspaceInitials(workspace)`
-- `workspaceHomePath(workspaceSlug)`
-- `resolveLandingSlug()`
 - `workspaceOpenLabel(workspace)`
 - `isRespondingToInvite(invite, decision)`
-- `openWorkspace(workspaceSlug)`
-- `respondToInvite(invite, decision)`
-- `acceptInvite(invite)`
-- `refuseInvite(invite)`
-- `createWorkspace()`
-- `refreshBootstrap()`
 
 ### `src/client/components/WorkspaceSelector.vue`
 Exports
 - None
 Local functions
-- `resolveBrowserPath()`
 - `navigateToWorkspace(slug)`
 
 ### `src/client/components/WorkspaceSettingsMenuItem.vue`
@@ -123,15 +101,27 @@ Exports
 Exports
 - None
 
+### `src/client/composables/useWorkspaceMembersActions.js`
+Exports
+- `useWorkspaceMembersActions({ forms, workspaceMembersApiPath, workspaceInvitesApiPath, canInviteMembers, canManageMembers, canRevokeInvites, workspaceRolesView, workspaceMembersList, workspaceInvitesList })`
+
+### `src/client/composables/useWorkspaceMembersPage.js`
+Exports
+- `useWorkspaceMembersPage()`
+
 ### `src/client/composables/useWorkspaceRouteContext.js`
 Exports
 - `useWorkspaceRouteContext()`
 
+### `src/client/composables/useWorkspacesLanding.js`
+Exports
+- `useWorkspacesLanding()`
+
 ### `src/client/composables/useWorkspaceSurfaceId.js`
 Exports
-- `useWorkspaceSurfaceId({ route = null, placementContext = null } = {})`
+- `useWorkspaceSurfaceId({ route, placementContext })`
 Local functions
-- `resolveCurrentPathname(route = null)`
+- `resolveCurrentPathname(route)`
 
 ### `src/client/i18n.js`
 Exports
@@ -150,23 +140,26 @@ Exports
 - `findWorkspaceBySlug(entries = [], workspaceSlug = "")`
 - `normalizeWorkspaceEntry(entry = null)`
 - `normalizeWorkspaceList(entries = [])`
-Local functions
-- `normalizeWorkspaceSlug(value = "")`
 
 ### `src/client/lib/lastWorkspace.js`
 Exports
-- `readLastWorkspaceSlug(userId, { storage } = {})`
+- `readLastWorkspaceSlug(userId, { storage = pageLocalStorage() } = {})`
 - `resolveWorkspaceLandingSlug({ workspaces = [], pendingInvites = [], lastWorkspaceSlug = "" } = {})`
-- `writeLastWorkspaceSlug(userId, workspaceSlug, { storage } = {})`
+- `writeLastWorkspaceSlug(userId, workspaceSlug, { storage = pageLocalStorage() } = {})`
 Local functions
-- `resolveStorage(storage)`
 - `lastWorkspaceStorageKey(userId)`
 
+### `src/client/lib/pendingInvites.js`
+Exports
+- `readPendingInvites(payload, invitesEnabled)`
+Local functions
+- `normalizePendingInvite(entry)`
+
 ### `src/client/lib/profileSurfaceMenuLinks.js`
 Exports
-- `resolveProfileSurfaceMenuLinks({ context, surface } = {})`
-- `resolvePrimarySurfaceSwitchLink({ context, surface } = {})`
-- `resolveSurfaceSwitchLinks({ context, surface } = {})`
+- `resolveProfileSurfaceMenuLinks({ context, surface })`
+- `resolvePrimarySurfaceSwitchLink({ context, surface })`
+- `resolveSurfaceSwitchLinks({ context, surface })`
 - `hasWorkspaceMembership`
 Local functions
 - `resolveSurfaceSwitchIcon(surfaceId = "", explicitIcon = "")`
@@ -180,8 +173,6 @@ Exports
 - `resolveSurfaceAccessPolicy(contextValue = null, surfaceDefinition = null)`
 - `evaluateSurfaceAccess({ context = null, surfaceId = "", workspaceSlug = "", allowOnUnknown = false } = {})`
 Local functions
-- `normalizeSurfaceAccessPolicyId(value = "")`
-- `normalizeWorkspaceSlug(value = "")`
 - `normalizeAccessFlagName(value = "")`
 - `normalizeStringList(value)`
 - `normalizeSurfaceAccessFlags(value = null)`
@@ -199,8 +190,8 @@ Exports
 - `hexColorToRgb(value = "")`
 - `normalizeThemePreference(value)`
 - `persistBootstrapThemePreference(payload = {}, options = {})`
-- `persistThemePreference(themePreference, options = {})`
-- `readPersistedThemePreference(options = {})`
+- `persistThemePreference(themePreference, { storage = pageLocalStorage() } = {})`
+- `readPersistedThemePreference({ storage = pageLocalStorage() } = {})`
 - `resolveBootstrapThemePreference(payload = {}, options = {})`
 - `resolveThemeNameForPreference(themePreference, options = {})`
 - `resolveBootstrapThemeName(payload = {}, options = {})`
@@ -209,7 +200,6 @@ Exports
 - `setVuetifyThemeName(themeController, themeName)`
 Local functions
 - `resolveSystemThemeName({ prefersDark } = {})`
-- `resolveThemePreferenceStorage(options = {})`
 - `normalizeHexColor(value = "")`
 - `resolveVuetifyThemeDefinitions(themeController)`
 - `normalizeThemeColors(colors)`
@@ -227,6 +217,15 @@ Local functions
 - `resolveSurfaceBasePath(context = null, surface = "")`
 - `resolveWorkspaceBasePath(context = null, surface = "", workspaceSlug = "")`
 
+### `src/client/lib/workspaceMembersPayloads.js`
+Exports
+- `latestPage(pages)`
+- `normalizeInvites(entries)`
+- `normalizeMembers(entries)`
+- `normalizeRoleCatalog(payload)`
+Local functions
+- `toRoleTitle(roleSid)`
+
 ### `src/client/lib/workspaceSurfaceContext.js`
 Exports
 - `listWorkspaceSurfaceIdsFromSurfaceConfig(surfaceConfig = null)`
@@ -253,7 +252,10 @@ Exports
 
 ### `src/client/runtime/bootstrapPlacementRouteGuards.js`
 Exports
-- `createBootstrapPlacementRouteGuards({ placementRuntime, router = null, root = null, getWorkspaceBootstrapStatus = () => "" } = {})`
+- `createBootstrapPlacementRouteGuards({ placementRuntime, router, root, getWorkspaceBootstrapStatus })`
+Local functions
+- `allowEveryRoute()`
+- `normalizeGuardEvaluator(candidate)`
 
 ### `src/client/runtime/bootstrapPlacementRuntime.js`
 Exports
@@ -262,7 +264,7 @@ Exports
 - `WORKSPACE_BOOTSTRAP_STATUS_FORBIDDEN`
 - `WORKSPACE_BOOTSTRAP_STATUS_UNAUTHENTICATED`
 - `WORKSPACE_BOOTSTRAP_STATUS_ERROR`
-- `createBootstrapPlacementRuntime({ bootstrapRuntime, placementRuntime, realtime = null, router = null, vueApp = null, logger })`
+- `createBootstrapPlacementRuntime({ bootstrapRuntime, placementRuntime, realtime, router, vueApp, logger })`
 
 ### `src/client/runtime/bootstrapPlacementRuntimeConstants.js`
 Exports
@@ -283,20 +285,18 @@ Exports
 - `isGuardDenied(outcome)`
 - `normalizeSearch(search = "")`
 - `normalizeWorkspaceBootstrapStatus(status = "")`
-- `normalizeWorkspaceSlugKey(workspaceSlug = "")`
-- `resolveAuthSignature(context = {})`
-- `resolveRequestedWorkspaceBootstrapStatus(payload = {}, workspaceSlug = "")`
+- `resolveAuthSignature(context)`
+- `resolveRequestedWorkspaceBootstrapStatus(payload, workspaceSlug = "")`
 - `resolveRouteState(placementRuntime, router)`
 - `resolveSearchFromFullPath(fullPath = "")`
 
 ### `src/client/support/realtimeWorkspace.js`
 Exports
-- `matchesCurrentWorkspaceEvent(payload = {}, workspaceSlug = "")`
+- `matchesCurrentWorkspaceEvent(payload, workspaceSlug = "")`
 - `createWorkspaceRealtimeMatcher(workspaceSlugRef)`
 
 ### `src/client/support/runtimeNormalization.js`
 Exports
-- `normalizeRecord(value)`
 - `normalizeWorkspaceBootstrapStatusValue(status = "", allowedStatuses = null)`
 - `resolveErrorStatusCode(error)`
 
@@ -308,7 +308,38 @@ Exports
 Exports
 - `WORKSPACES_WEB_SCOPE_SUPPORT_INJECTION_KEY`
 - `createWorkspaceScopeSupport()`
-- `readWorkspaceRouteScope(routeContext = {})`
+- `readWorkspaceRouteScope(routeContext)`
+
+### `src/client/types.js`
+Exports
+- `type WorkspacePlacementContext`
+- `type WorkspacePlacementRuntime`
+- `type ShellBootstrapRuntime`
+- `type WorkspaceShell`
+- `type WorkspaceRealtime`
+- `type ShellGuardEvaluator`
+- `type WorkspaceRouteScopeContext`
+- `type WorkspaceBootstrapRuntime`
+- `type WorkspaceScopeSupport`
+- `type WorkspacesClient`
+- `type WorkspaceRouteContext`
+- `type WorkspaceSurfaceIds`
+- `type WorkspaceMembersPage`
+- `type WorkspaceMembersActions`
+- `type WorkspacesLanding`
+- `type AccountSettingsInvites`
+- `type WorkspaceLinkResolver`
+- `type PendingInvite`
+- `type InviteAction`
+- `type WorkspaceFeedback`
+- `type MembersAdminForms`
+- `type MembersAdminOptions`
+- `type WorkspaceMember`
+- `type WorkspaceMemberInvite`
+- `type MembersAdminCollections`
+- `type MembersAdminPermissions`
+- `type MembersAdminStatus`
+- `type MembersAdminActions`
 
 ### `src/shared/toolsOutletContracts.js`
 Exports
@@ -324,6 +355,16 @@ Exports
 Exports
 - None
 
+### `fixtures/workspaces-components/main.js`
+Exports
+- None
+Local functions
+- `pageFor(label)`
+
+### `fixtures/workspaces-components/vite.config.mjs`
+Exports
+- None
+
 ### `fixtures/workspaces-landing/main.js`
 Exports
 - None

package/reference/autogen/tooling/config-eslint.md

@@ -312,6 +312,7 @@ Exports
 - `typedInject`
 Local functions
 - `isTypedInjection(sourceCode, call)`
+- `requiredOption(sourceCode, call)`
 
 ### `plugin/support.js`
 Exports

package/reference/autogen/tooling/jskit-release.md

@@ -54,7 +54,7 @@ Local functions
 
 ### `src/release.mjs`
 Exports
-- `assertMainReleaseCheckout(repoRoot)`
+- `assertMainReleaseCheckout(repoRoot, { allowAhead = false } = {})`
 - `bumpPatch`
 - `collectPublishDependencies`
 - `collectPatternPackageJsonPaths`

package/skills/jskit/references/client-features.md

@@ -122,6 +122,23 @@ function useAttachments({ uploadAttachment = null } = {}) {
   if (typeof uploadAttachment !== "function") return;
 ```
 
+Each `typeof` probe is one of these, decided by reading its callers:
+
+| The probe | What it is | What it becomes |
+| --- | --- | --- |
+| `typeof socket.on === "function"` on a value with a contract | a member every implementer has | the contract, typed once; the probe goes |
+| `if (typeof onEvent !== "function") throw` | an "x is required" guard | a required option; the guard goes |
+| `typeof matches === "function" && matches(context)` | an option real callers omit | a [named default](#absent-options), called plainly |
+| `typeof deleteAttachment === "function"` | a contract member some real caller lacks | an [optional operation](#absent-options) |
+| `typeof guard === "function"` on an option documented as `false`, a function or options | telling the shapes of one option apart | a check of the data, `isRecord(guard)`; the probe goes |
+| a shape check on an injected value, to learn whether it is there | an availability test | [one comparison](#injected-accessors) with the named default |
+| `typeof window !== "undefined"` | a host object | a [platform probe](#platform-probes) |
+| `typeof config.debug === "boolean"` | a check of data, not a collaborator | stays |
+
+A test that only pins a probe (`disconnect(null)` does nothing, `connect: null`
+is refused) goes with the probe; a test that reaches production code through a
+double keeps its assertions, and the double gains what the code now calls.
+
 ### Absent options
 
 **What a real caller leaves out takes one of the server's two forms.** A
@@ -246,6 +263,51 @@ const support = inject("workspaceScope", null);
 if (!support || typeof support.readRouteScope !== "function") return FALLBACK;
 ```
 
+### Injected accessors
+
+**A `use<Name>()` accessor takes no `required` option: the key's owner decides
+once, and it resolves one way.** When no real application runs without the
+provider, it is `inject(KEY)`. When one does, it is `inject(KEY, NO_X)`, and
+`NO_X` has every member of the contract, each doing nothing, so callers call it
+plainly.
+
+- A caller that behaves differently when the value is absent compares once with
+  the named default, `socket !== NO_REALTIME_SOCKET`, and branches on that.
+- A caller that cannot work without the value compares and refuses once, where
+  it receives it; a `required` option on the owner's accessor is not the way.
+- The accessor keeps no shape check of what was provided: a provider supplies
+  the contract, and a test double completes it.
+
+Why: a mode and a shape check give one key several outcomes, and each caller
+has to know which it got. A default that lacks members moves the probes to the
+callers (`socket.connect?.()`).
+
+```js
+// good: src/client/composables/useRealtimeEvent.js
+const NO_REALTIME_SOCKET = Object.freeze({
+  connected: false,
+  connect() {},
+  on() {},
+  off() {}
+});
+/** @returns {import("../types.js").RealtimeSocket} */
+function useRealtimeSocket() {
+  return inject(REALTIME_SOCKET_KEY, NO_REALTIME_SOCKET);
+}
+
+// good: a caller that needs one
+const socket = useRealtimeSocket();
+if (socket === NO_REALTIME_SOCKET) throw new Error("Conversations need the realtime socket.");
+
+// bad
+function useRealtimeSocket({ required = false } = {}) {
+  const socket = inject(REALTIME_SOCKET_KEY, null);
+  if (socket && typeof socket.on === "function") return socket;
+  if (required) throw new Error("No socket.");
+  return EMPTY_SOCKET;
+}
+```
+
 ## Components
 
 ### Collaborator props
@@ -456,7 +518,7 @@ client-only rules below. The server's action and error rules do not apply.
 
 | Rule | Reports | Section |
 | --- | --- | --- |
-| `jskit/typed-inject` | `inject()` with a literal key, an untyped binding, or a `null` / `{}` default | [Injected values](#injected-values) |
+| `jskit/typed-inject` | `inject()` with a literal key, an untyped binding, a `null` / `{}` default, or in a function with a `required` option | [Injected values](#injected-values), [Injected accessors](#injected-accessors) |
 | `jskit/collaborator-props` | a prop the component calls that is optional with no named default, or typed only `Object` | [Collaborator props](#collaborator-props) |
 | `jskit/fixed-result-shape` | behaviour assigned to a `use*` / `create*` result after it is built, also one a wrapper's callback built | [Fixed result shape](#fixed-result-shape) |
 | `jskit/no-frozen-vue-state` | `Object.freeze` over refs, computeds or reactive state | [Fixed result shape](#fixed-result-shape) |

package/skills/jskit/references/heuristics/client-features.md

@@ -35,6 +35,10 @@ rule's intent, and report the case.
   - [Client providers](../client-features.md#client-providers)
 - `inject("key")`, `inject(KEY, null)`, `inject(KEY, {})` (`jskit/typed-inject`)
   - [Injected values](../client-features.md#injected-values)
+- `useX({ required })`, an `EMPTY_*` fallback, a shape check of an injected value, `socket.connect?.()` on a default (`jskit/typed-inject`)
+  - [Injected accessors](../client-features.md#injected-accessors)
+- which kind of `typeof` probe this is, a test that only pins a probe
+  - [Required options](../client-features.md#required-options)
 - `type: Object, default: null` on a prop the component calls, `adapter: Object` (`jskit/collaborator-props`, `vue/require-default-prop`)
   - [Collaborator props](../client-features.md#collaborator-props)
 - an event emitted but not declared (`vue/require-explicit-emits`)