@jskit-ai/agent-docs 0.1.1

package/reference/autogen/packages/realtime.md

@@ -0,0 +1,95 @@
+# packages/realtime
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/realtime`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/realtime/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/client/components/RealtimeConnectionIndicator.js`
+Exports
+- `RealtimeConnectionIndicator`
+Local functions
+- `resolveTooltipText({ realtimeAvailable, connected })`
+
+### `src/client/composables/useRealtimeEvent.js`
+Exports
+- `EMPTY_REALTIME_SOCKET`
+- `useRealtimeSocket({ required = false } = {})`
+- `useRealtimeEvent({ event = "*", enabled = true, matches = null, onEvent } = {})`
+Local functions
+- `isRealtimeSocket(socket)`
+- `resolveEnabled(value)`
+- `resolveEventName(value)`
+
+### `src/client/listeners.js`
+Exports
+- `normalizeRealtimeClientListener(entry)`
+- `registerRealtimeClientListener(app, token, factory)`
+- `resolveRealtimeClientListeners(scope)`
+Local functions
+- `normalizeListenerEntries(value)`
+
+### `src/client/RealtimeClientProvider.js`
+Exports
+- `RealtimeClientProvider`
+Local functions
+- `resolveRealtimeClientConfig(app)`
+
+### `src/client/runtime.js`
+Exports
+- `createSocketIoClient({ url = "", options = {}, connect = connectSocketIoClient } = {})`
+- `disconnectSocketIoClient(socket)`
+
+### `src/server/RealtimeServiceProvider.js`
+Exports
+- `RealtimeServiceProvider`
+Local functions
+- `normalizeArray(value)`
+- `roomForUser(userId)`
+- `roomForWorkspace(workspaceId)`
+- `roomForWorkspaceUser(workspaceId, userId)`
+- `parseCookieHeader(value = "")`
+- `createProviderLogger(scope, { debugEnabled = false } = {})`
+- `parseDebugFlag(value, fallback = null)`
+- `resolveRealtimeServerDebugEnabled(scope)`
+- `buildRealtimeDispatchIndex(registrations = [])`
+- `mergeRealtimePayload(event, payloadPatch)`
+- `resolveScopeWorkspaceId(scope = {})`
+- `resolveScopeUserId(scope = {})`
+- `applyAudiencePreset(preset, { event, rooms, flags, logger } = {})`
+- `addAudienceRoomsFromObject(selection, { event, rooms, flags, logger } = {})`
+- `collectUserIdsFromQueryRows(rows = [])`
+- `resolveAudienceQueryRooms(userQuery, { scope, event, logger } = {})`
+- `resolveAudienceTargets(dispatcher, event, { scope, logger } = {})`
+- `resolveSocketActorId(authService, socket)`
+- `resolveActorWorkspaceIds(workspaceMembershipsRepository, actorId)`
+- `registerRealtimeSocketAudienceBootstrap(scope, io, logger)`
+
+### `src/server/runtime.js`
+Exports
+- `createSocketIoServer({ httpServer = null, fastify = null, options = {}, ServerCtor = SocketIoServer } = {})`
+- `closeSocketIoServer(io)`
+- `REDIS_URL_ENV_KEY`
+- `REDIS_NAMESPACE_ENV_KEY`
+- `resolveRealtimeRedisUrl(env = {})`
+- `resolveRealtimeRedisNamespace(env = {})`
+- `configureSocketIoRedisAdapter(io, { redisUrl = "", redisNamespace = "", createRedisAdapter = createSocketIoRedisAdapter, createRedisConnection = createRedisClient } = {})`
+- `closeSocketIoRedisConnections({ pubClient = null, subClient = null } = {})`
+Local functions
+- `resolveHttpServer({ httpServer = null, fastify = null } = {})`
+- `buildSocketIoRedisAdapterKey(redisNamespace = "")`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

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

@@ -0,0 +1,349 @@
+# packages/shell-web
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/shell-web`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/shell-web/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/client/components/ShellErrorHost.vue`
+Exports
+- None
+Local functions
+- `resolveSeverityColor(severity = "error")`
+- `resolveTimeout(entry)`
+- `dismiss(entry)`
+- `runAction(entry)`
+- `onSnackbarModelValue(nextValue)`
+- `onDialogModelValue(nextValue)`
+
+### `src/client/components/ShellLayout.vue`
+Exports
+- None
+
+### `src/client/components/ShellMenuLinkItem.vue`
+Exports
+- None
+
+### `src/client/components/ShellOutlet.vue`
+Exports
+- None
+
+### `src/client/components/ShellOutletMenuWidget.vue`
+Exports
+- None
+
+### `src/client/components/ShellSurfaceAwareMenuLinkItem.vue`
+Exports
+- None
+
+### `src/client/components/ShellTabLinkItem.vue`
+Exports
+- None
+
+### `src/client/composables/shellLayoutDrawerPreference.js`
+Exports
+- `SHELL_LAYOUT_DRAWER_DEFAULT_OPEN_STORAGE_KEY`
+- `readDrawerDefaultOpenPreference({ storage = typeof window === "object" ? window?.localStorage : null } = {})`
+- `writeDrawerDefaultOpenPreference(open, { storage = typeof window === "object" ? window?.localStorage : null } = {})`
+
+### `src/client/composables/useShellLayoutState.js`
+Exports
+- `useShellLayoutState(props = {})`
+Local functions
+- `toSurfaceLabel(surfaceId = "")`
+
+### `src/client/error/index.js`
+Exports
+- `createDefaultErrorPolicy`
+- `useShellWebErrorRuntime`
+- `useShellErrorPresentationStore`
+
+### `src/client/error/inject.js`
+Exports
+- `EMPTY_ERROR_RUNTIME`
+- `useShellWebErrorRuntime({ required = false } = {})`
+
+### `src/client/error/normalize.js`
+Exports
+- `ERROR_CHANNELS`
+- `ERROR_SEVERITIES`
+- `isRecord`
+- `normalizeText(value, fallback = "")`
+- `normalizeChannel(value, fallback = "")`
+- `normalizeSeverity(value, fallback = "error")`
+- `normalizeNonNegativeInteger(value, fallback = 0)`
+- `normalizeAction(value)`
+
+### `src/client/error/policy.js`
+Exports
+- `createDefaultErrorPolicy({ defaultChannel = "snackbar", unauthorizedChannel = "banner", serverErrorChannel = "dialog", defaultSeverity = "error" } = {})`
+
+### `src/client/error/presentationDefaults.js`
+Exports
+- `EMPTY_PRESENTATION_STATE`
+- `EMPTY_PRESENTATION_STORE`
+
+### `src/client/error/presenters.js`
+Exports
+- `createStoreBackedPresenter({ id, channel, store, defaultPersist = false } = {})`
+- `createMaterialSnackbarPresenter({ store } = {})`
+- `createMaterialBannerPresenter({ store } = {})`
+- `createMaterialDialogPresenter({ store } = {})`
+- `createDefaultMaterialErrorPresenters({ store } = {})`
+
+### `src/client/error/runtime.js`
+Exports
+- `createErrorRuntime({ presenters = [], policy = null, defaultPresenterId = "", moduleDefaultPresenterId = "", logger = null } = {})`
+- `normalizeErrorEvent(rawEvent = {})`
+Local functions
+- `createRuntimeLogger(logger = null)`
+- `normalizePolicyDecision(policyDecision = {}, event = {})`
+- `normalizePresenter(candidate = {})`
+
+### `src/client/error/store.js`
+Exports
+- `PRESENTATION_CHANNELS`
+- `createErrorPresentationStore({ now = () => Date.now() } = {})`
+Local functions
+- `createEmptyChannelState()`
+- `cloneEntry(entry = {})`
+
+### `src/client/index.js`
+Exports
+- `ShellWebClientProvider`
+- `ShellLayout`
+- `ShellOutlet`
+- `ShellOutletMenuWidget`
+- `ShellErrorHost`
+- `ShellMenuLinkItem`
+- `ShellSurfaceAwareMenuLinkItem`
+- `ShellTabLinkItem`
+- `useShellLayoutState`
+- `useShellLayoutStore`
+- `useShellErrorPresentationStore`
+- `clientProviders`
+
+### `src/client/lib/menuIcons.js`
+Exports
+- `resolveMenuLinkIcon({ icon = "", label = "", to = "" } = {})`
+- `resolveSurfaceSwitchIcon(surfaceId = "", explicitIcon = "")`
+Local functions
+- `resolveExplicitIconValue(explicitIcon = "")`
+- `normalizePathname(value = "")`
+- `resolveSurfaceSwitchIdFromLabel(label = "")`
+
+### `src/client/navigation/linkResolver.js`
+Exports
+- `resolveShellLinkPath({ context = null, surface = "", explicitTo = "", relativePath = "/", surfaceRelativePath = "", params = {}, strictParams = true } = {})`
+- `useShellLinkResolver({ surface = "" } = {})`
+Local functions
+- `normalizeParamsMap(params = null)`
+- `materializeSurfaceRouteBase(routeBaseTemplate = "/", { params = {}, strictParams = true, surface = "" } = {})`
+- `resolveSurfaceBasePath(context = null, surface = "", { params = {}, strictParams = true } = {})`
+
+### `src/client/placement/debug.js`
+Exports
+- `DEFAULT_DEBUG_DEPTH`
+- `explodePayload(value, depth = DEFAULT_DEBUG_DEPTH)`
+Local functions
+- `describeFunction(fn)`
+- `describeSymbol(value)`
+
+### `src/client/placement/index.js`
+Exports
+- `createPlacementRegistry`
+- `useWebPlacementContext`
+- `resolveRuntimePathname`
+- `readPlacementSurfaceConfig`
+- `resolveSurfaceDefinitionFromPlacementContext`
+- `joinSurfacePath`
+- `resolveSurfaceIdFromPlacementPathname`
+- `resolveSurfaceRootPathFromPlacementContext`
+- `resolveSurfacePathFromPlacementContext`
+- `normalizeSurfaceOrigin`
+- `resolveSurfaceNavigationTargetFromPlacementContext`
+
+### `src/client/placement/inject.js`
+Exports
+- `EMPTY_WEB_PLACEMENT_RUNTIME`
+- `EMPTY_WEB_PLACEMENT_CONTEXT`
+- `useWebPlacementRuntime({ required = false } = {})`
+- `useWebPlacementContext({ required = false } = {})`
+
+### `src/client/placement/pathname.js`
+Exports
+- `resolveRuntimePathname(candidate = "")`
+
+### `src/client/placement/registry.js`
+Exports
+- `createPlacementRegistry({ entries = [] } = {})`
+
+### `src/client/placement/runtime.js`
+Exports
+- `createWebPlacementRuntime({ app, logger = null } = {})`
+Local functions
+- `ensureArray(value)`
+- `NOOP()`
+- `isPlacementDebugEnabled()`
+- `debugLog(message, payload = null)`
+- `createRuntimeLogger(logger)`
+- `normalizePlacementList(placements, context = {})`
+- `matchesSurface(placementSurfaces, requestedSurface)`
+- `resolveContextContributors(app, baseContext = {}, logger)`
+- `resolvePlacementComponent(app, placement, logger, missingTokens, invalidComponentTokens, failedTokens)`
+- `shouldIncludePlacement(placement, placementContext, logger)`
+
+### `src/client/placement/surfaceContext.js`
+Exports
+- `EMPTY_SURFACE_CONFIG`
+- `buildSurfaceConfigContext(surfaceRuntime = null, { tenancyMode = "" } = {})`
+- `readPlacementSurfaceConfig(contextValue = null)`
+- `resolveSurfaceDefinitionFromPlacementContext(contextValue = null, surfaceId = "")`
+- `joinSurfacePath(surfacePrefix = "", pathname = "")`
+- `resolveSurfaceIdFromPlacementPathname(contextValue = null, pathname = "")`
+- `resolveSurfaceRootPathFromPlacementContext(contextValue = null, surfaceId = "")`
+- `resolveSurfacePathFromPlacementContext(contextValue = null, surfaceId = "", pathname = "")`
+- `normalizeSurfaceOrigin(originValue = "")`
+- `resolveSurfaceNavigationTargetFromPlacementContext(contextValue = null, { path = "/", surfaceId = "", currentOrigin = "" } = {})`
+Local functions
+- `normalizeSurfaceIdList(value)`
+- `normalizeSurfaceConfig(surfaceConfig = {})`
+- `resolveRuntimeOrigin(currentOrigin = "")`
+- `createPlacementSurfacePathHelpers(surfaceConfig = EMPTY_SURFACE_CONFIG)`
+
+### `src/client/placement/validators.js`
+Exports
+- `isRecord`
+- `isRenderableComponent(value)`
+- `normalizeSurface(value)`
+- `normalizePlacementSurface(value, { strict = false, source = "placement" } = {})`
+- `normalizePlacementTarget(value, { strict = false, source = "placement" } = {})`
+- `normalizePlacementSurfaces(value, { strict = false, source = "placement" } = {})`
+- `normalizePlacementDefinition(value, { strict = false, source = "placement" } = {})`
+- `definePlacement(value = {})`
+Local functions
+- `isValidSurfaceIdToken(value = "")`
+- `toInteger(value, fallback = 1000)`
+
+### `src/client/providers/ShellWebClientProvider.js`
+Exports
+- `ShellWebClientProvider`
+Local functions
+- `createShellWebQueryClient()`
+- `isMissingDynamicModule(error, moduleSpecifier)`
+- `loadAppPlacementDefinitions(logger)`
+- `createErrorConfigToolkit(errorRuntime)`
+- `loadAppErrorConfig(logger, errorRuntime)`
+- `applyAppErrorConfig(errorRuntime, errorConfig = {})`
+- `installVueErrorBridge(vueApp, errorRuntime, logger)`
+- `installRouterErrorBridge(app, errorRuntime, logger)`
+
+### `src/client/stores/useShellErrorPresentationStore.js`
+Exports
+- `useShellErrorPresentationStore`
+Local functions
+- `normalizePresentationState(nextState)`
+- `isPresentationRuntimeStore(value)`
+
+### `src/client/stores/useShellLayoutStore.js`
+Exports
+- `useShellLayoutStore`
+
+### `src/client/support/menuLinkTarget.js`
+Exports
+- `normalizeMenuLinkPathname(pathname = "")`
+- `resolveMenuLinkTarget({ to = "", surface = "", currentSurfaceId = "", placementContext = null, scopedSuffix = "/", unscopedSuffix = "/", routeParams = {}, resolvePagePath = null } = {})`
+Local functions
+- `resolveMenuLinkSurfaceId(surface = "", fallbackSurfaceId = "")`
+- `interpolateBracketParams(pathTemplate = "", params = {})`
+- `isRelativeMenuLinkTarget(target = "")`
+- `surfaceRequiresWorkspaceFromPlacementContext(contextValue = null, surfaceId = "")`
+
+### `src/server/support/localLinkItemScaffolds.js`
+Exports
+- `LOCAL_LINK_ITEM_COMPONENT_DEFINITIONS`
+- `LOCAL_LINK_ITEM_COMPONENT_TOKENS`
+- `findLocalLinkItemDefinition(componentToken = "")`
+- `readLocalLinkItemComponentSource(componentTokenOrDefinition = "")`
+- `resolveLocalLinkItemTemplateAbsolutePath(componentTokenOrDefinition = "")`
+Local functions
+- `createLocalLinkItemDefinition({ token = "", componentFile = "", componentName = "", templateFile = "" } = {})`
+- `resolveLocalLinkItemDefinition(componentTokenOrDefinition = "")`
+
+### templates
+
+### `templates/expected-existing/src/App.vue`
+Exports
+- None
+
+### `templates/expected-existing/src/pages/home.vue`
+Exports
+- None
+
+### `templates/expected-existing/src/pages/home/index.vue`
+Exports
+- None
+
+### `templates/src/App.vue`
+Exports
+- None
+
+### `templates/src/components/menus/MenuLinkItem.vue`
+Exports
+- None
+
+### `templates/src/components/menus/SurfaceAwareMenuLinkItem.vue`
+Exports
+- None
+
+### `templates/src/components/menus/TabLinkItem.vue`
+Exports
+- None
+
+### `templates/src/components/ShellLayout.vue`
+Exports
+- None
+
+### `templates/src/error.js`
+Exports
+- None
+
+### `templates/src/pages/home.vue`
+Exports
+- None
+
+### `templates/src/pages/home/index.vue`
+Exports
+- None
+
+### `templates/src/pages/home/settings.vue`
+Exports
+- None
+
+### `templates/src/pages/home/settings/general/index.vue`
+Exports
+- None
+
+### `templates/src/pages/home/settings/index.vue`
+Exports
+- None
+
+### `templates/src/placement.js`
+Exports
+- `addPlacement`
+- `getPlacements()`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

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

@@ -0,0 +1,39 @@
+# packages/storage-runtime
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/storage-runtime`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/storage-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/providers/StorageRuntimeServiceProvider.js`
+Exports
+- `StorageRuntimeServiceProvider`
+
+### `src/server/storageBinding.js`
+Exports
+- `STORAGE_DRIVER_ENV_KEY`
+- `STORAGE_FS_BASE_PATH_ENV_KEY`
+- `DEFAULT_STORAGE_DRIVER`
+- `normalizeStorageDriver(value)`
+- `createStorageBinding(scope, { rootDir = process.cwd() } = {})`
+Local functions
+- `resolveFsBasePath(fsBasePath, { rootDir } = {})`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

package/reference/autogen/packages/ui-generator.md

@@ -0,0 +1,101 @@
+# packages/ui-generator
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/ui-generator`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/ui-generator/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/server/buildTemplateContext.js`
+Exports
+- `buildUiPageTemplateContext({ appRoot, targetFile = "", options = {} } = {})`
+Local functions
+- `resolveLinkToPropLine(linkTo = "")`
+
+### `src/server/subcommands/addSubpages.js`
+Exports
+- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
+Local functions
+- `resolveSubpagesOutletTarget(options = {}, pageTarget = {})`
+
+### `src/server/subcommands/element.js`
+Exports
+- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
+Local functions
+- `renderElementComponentSource(elementName = "")`
+- `resolvePlacedElementSurface({ appRoot, placementTarget = {}, surface = "", context = "ui-generator placed-element" } = {})`
+
+### `src/server/subcommands/outlet.js`
+Exports
+- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
+Local functions
+- `hasShellOutletTarget(source = "", { target = "" } = {})`
+- `applyScriptImports(source = "")`
+- `createOutletBlock({ target = "" } = {})`
+- `findLastTemplateCloseTag(source = "")`
+- `applyOutletTemplateBlock(source = "", { target = "" } = {})`
+
+### `src/server/subcommands/page.js`
+Exports
+- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
+Local functions
+- `renderPageLinkPlacementBlock({ marker = "", context = {}, label = "", surface = "" } = {})`
+
+### `src/server/subcommands/pageSupport.js`
+Exports
+- `DEFAULT_SUBPAGES_POSITION`
+- `DEFAULT_COMPONENT_DIRECTORY`
+- `SECTION_CONTAINER_SHELL_COMPONENT`
+- `TAB_LINK_COMPONENT`
+- `TAB_LINK_COMPONENT_TOKEN`
+- `resolvePageTargetDetails`
+- `resolveNearestParentSubpagesHost`
+- `deriveDefaultSubpagesHost`
+- `renderPlainPageSource(pageTitle = "")`
+- `ensureSubpagesSupportScaffold({ appRoot, componentDirectory = DEFAULT_COMPONENT_DIRECTORY, dryRun = false } = {})`
+- `applySubpagesUpgradeToPageSource(source = "", { target = "", title = "", subtitle = "", sectionContainerComponentImportPath = "/src/components/SectionContainerShell.vue", preserveExistingContent = true } = {})`
+- `upgradePageFileToSubpages({ appRoot, targetFile, target = "", title = "", subtitle = "", componentDirectory = DEFAULT_COMPONENT_DIRECTORY, preserveExistingContent = true, dryRun = false } = {})`
+Local functions
+- `trimEdgeBlankLines(source = "")`
+- `renderSectionContainerShellSource()`
+- `findTemplateBlock(source = "")`
+- `unwrapSectionContainerShell(source = "")`
+- `stripExistingSubpagesStructure(source = "")`
+- `renderSectionContainerOpenTag({ title = "", subtitle = "" } = {})`
+- `renderSubpagesTemplate({ bodyContent = "", title = "", subtitle = "", target = "" } = {})`
+- `applySubpagesScriptImports(source = "", { sectionContainerComponentImportPath = "" } = {})`
+- `hasExistingSubpagesRouting(source = "")`
+
+### `src/server/subcommands/support.js`
+Exports
+- `DEFAULT_COMPONENT_DIRECTORY`
+- `MAIN_CLIENT_PROVIDER_FILE`
+- `PLACEMENT_FILE`
+- `toKebabCase(value = "")`
+- `toPascalCase(value = "")`
+- `requireOption(options = {}, optionName = "", { context = "ui-generator" } = {})`
+- `requireSinglePositionalTargetFile(args = [], { context = "ui-generator" } = {})`
+- `resolveOutletTargetId(rawTarget = "", { context = "ui-generator", optionName = "target" } = {})`
+- `rejectUnexpectedOptions(options = {}, allowedOptionNames = [], { context = "ui-generator" } = {})`
+- `resolvePathWithinApp(appRoot, targetPath, { context = "ui-generator" } = {})`
+- `ensureTrailingNewline(value = "")`
+- `appendBlockIfMarkerMissing(source = "", marker = "", block = "")`
+- `insertImportIfMissing(source = "", importLine = "")`
+- `insertBeforeClassDeclaration(source = "", line = "", { className = "", contextFile = "" } = {})`
+- `findScriptBlock(source = "")`
+- `parseTagAttributes(attributesSource = "")`
+- `indentBlock(source = "", indent = "")`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

package/reference/autogen/packages/uploads-image-web.md

@@ -0,0 +1,76 @@
+# packages/uploads-image-web
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/uploads-image-web`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/uploads-image-web/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/client/composables/createImageUploadRuntime.js`
+Exports
+- `createImageUploadRuntime({ endpoint = "", method = "POST", fieldName = "file", withCredentials = true, maxNumberOfFiles = 1, allowedMimeTypes = DEFAULT_IMAGE_UPLOAD_ALLOWED_MIME_TYPES, maxUploadBytes = DEFAULT_IMAGE_UPLOAD_MAX_BYTES, note = "", dashboardOptions = {}, imageEditorOptions = {}, compressorOptions = {}, parseResponse = parseUploadResponse, resolveRequestHeaders = null, onSelectedFileNameChanged = null, onUploadSuccess = null, onInvalidResponse = null, onUploadError = null, onRestrictionFailed = null, onUnavailable = null, dependencies = {} } = {})`
+Local functions
+- `normalizeObject(value)`
+
+### `src/client/composables/createManagedImageAssetRuntime.js`
+Exports
+- `createManagedImageAssetRuntime({ uploadEndpoint = "", deleteEndpoint = "", fieldName = "file", hasAsset = false, assetVersion = "", selectedFileName = null, resolveAssetUrl = null, resolveRequestHeaders = null, onUploadSuccess = null, onDeleteSuccess = null, resolveUploadErrorMessage = null, resolveDeleteErrorMessage = null, deleteRequest = null, reportFeedback = null, messages = {}, uploadOptions = {}, deleteMethod = "DELETE", source = "uploads-image-web.managed-image-asset", dependencies = {} } = {})`
+- `DEFAULT_MANAGED_IMAGE_ASSET_MESSAGES`
+Local functions
+- `normalizeText(value)`
+- `normalizeObject(value)`
+- `normalizeWritableRef(value, fallbackValue = "")`
+- `closeDashboard(uppy)`
+- `readJsonResponse(response)`
+- `resolveMessage(value, fallback)`
+- `resolveUploadErrorFallback({ error, response, fallbackMessage })`
+- `resolveDeleteErrorFallback({ error, body, fallbackMessage })`
+- `normalizeDeleteResult(result)`
+
+### `src/client/index.js`
+Exports
+- `createImageUploadRuntime`
+- `createManagedImageAssetRuntime`
+- `clientProviders`
+
+### `src/client/styles/index.js`
+Exports
+- None
+
+### `src/client/support/parseUploadResponse.js`
+Exports
+- `parseUploadResponse(xhr)`
+
+### `src/client/support/stopImageEditor.js`
+Exports
+- `stopImageEditor(uppy)`
+
+### `src/shared/imageUploadDefaults.js`
+Exports
+- `DEFAULT_IMAGE_COMPRESSOR_OPTIONS`
+- `DEFAULT_IMAGE_DASHBOARD_OPTIONS`
+- `DEFAULT_IMAGE_EDITOR_OPTIONS`
+- `DEFAULT_IMAGE_UPLOAD_ALLOWED_MIME_TYPES`
+- `DEFAULT_IMAGE_UPLOAD_MAX_BYTES`
+
+### `src/shared/index.js`
+Exports
+- `DEFAULT_IMAGE_COMPRESSOR_OPTIONS`
+- `DEFAULT_IMAGE_DASHBOARD_OPTIONS`
+- `DEFAULT_IMAGE_EDITOR_OPTIONS`
+- `DEFAULT_IMAGE_UPLOAD_ALLOWED_MIME_TYPES`
+- `DEFAULT_IMAGE_UPLOAD_MAX_BYTES`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None