@jskit-ai/agent-docs 0.1.257 → 0.1.258
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/guide/agent/app-extras/assistant-conversation.md +88 -35
- package/guide/agent/app-extras/assistant.md +28 -28
- package/guide/agent/app-setup/authentication.md +36 -17
- package/guide/agent/app-setup/database-layer.md +116 -17
- package/guide/agent/app-setup/existing-application-migration.md +29 -25
- package/guide/agent/app-setup/multi-homing.md +94 -48
- package/guide/agent/app-setup/run-an-accounts-hub.md +6 -4
- package/guide/agent/framework/client-features.md +496 -0
- package/guide/agent/framework/crud-operations.md +5 -5
- package/guide/agent/framework/translation.md +4 -3
- package/guide/agent/framework/typed-features.md +1104 -0
- package/guide/agent/framework/ui-operations.md +2 -2
- package/guide/agent/index.md +6 -1
- package/package.json +1 -1
- package/patterns/feature-package/PATTERN.md +104 -10
- package/patterns/feature-package/example/booking-engine/package.json +9 -4
- package/patterns/feature-package/example/booking-engine/src/server/BookingEngineFeature.js +24 -0
- package/patterns/feature-package/example/booking-engine/src/server/bookingAvailability.js +10 -0
- package/patterns/feature-package/example/booking-engine/src/server/bookingEngine.js +29 -0
- package/patterns/feature-package/example/booking-engine/src/server/bookingEngineActions.js +26 -0
- package/patterns/feature-package/example/booking-engine/src/server/inputSchemas.js +1 -2
- package/patterns/feature-package/example/booking-engine/src/server/types.js +12 -0
- package/patterns/feature-package/example/variations/AvailabilityEngineFeature.js +19 -0
- package/patterns/feature-package/example/variations/InvoiceRollupFeature.js +23 -0
- package/patterns/feature-package/example/variations/availabilityEngineActions.js +26 -0
- package/patterns/feature-package/example/variations/customKnexRepository.js +32 -26
- package/patterns/feature-package/example/variations/invoiceRollupActions.js +26 -0
- package/patterns/feature-package/example/variations/orchestratorService.js +24 -19
- package/patterns/feature-package/example/variations/types.js +7 -0
- package/patterns/minimal-foundation/PATTERN.md +30 -1
- package/patterns/minimal-foundation/example/AGENTS.md +14 -0
- package/patterns/minimal-foundation/example/bin/develop.js +10 -5
- package/patterns/minimal-foundation/example/eslint.config.mjs +21 -2
- package/patterns/minimal-foundation/example/package.json +5 -4
- package/patterns/minimal-foundation/example/playwright.config.mjs +1 -1
- package/patterns/minimal-foundation/example/server/lib/envFile.js +19 -0
- package/patterns/minimal-foundation/example/server/lib/loggerOptions.js +15 -0
- package/patterns/minimal-foundation/example/server/lib/runtimeEnv.js +17 -17
- package/patterns/minimal-foundation/example/server.js +32 -29
- package/patterns/minimal-foundation/example/tests/server/smoke.test.js +2 -1
- package/patterns/shell-foundation/PATTERN.md +29 -0
- package/patterns/shell-foundation/example/AGENTS.md +14 -0
- package/patterns/shell-foundation/example/bin/develop.js +10 -5
- package/patterns/shell-foundation/example/eslint.config.mjs +21 -2
- package/patterns/shell-foundation/example/package.json +6 -5
- package/patterns/shell-foundation/example/packages/main/package.json +1 -1
- package/patterns/shell-foundation/example/packages/main/src/client/providers/MainClientProvider.js +1 -0
- package/patterns/shell-foundation/example/playwright.config.mjs +1 -1
- package/patterns/shell-foundation/example/server/lib/envFile.js +19 -0
- package/patterns/shell-foundation/example/server/lib/loggerOptions.js +15 -0
- package/patterns/shell-foundation/example/server/lib/runtimeEnv.js +17 -17
- package/patterns/shell-foundation/example/server.js +32 -29
- package/patterns/shell-foundation/example/tests/server/smoke.test.js +2 -1
- package/reference/autogen/KERNEL_MAP.md +14 -8
- package/reference/autogen/PATTERN_INDEX.md +37 -37
- package/reference/autogen/README.md +2 -0
- package/reference/autogen/packages/agent-docs.md +70 -26
- package/reference/autogen/packages/agent-runtime.md +129 -0
- package/reference/autogen/packages/agent.md +149 -0
- package/reference/autogen/packages/architecture-inspector.md +97 -44
- package/reference/autogen/packages/assistant-core.md +786 -292
- package/reference/autogen/packages/assistant-runtime.md +182 -57
- package/reference/autogen/packages/assistant-voice-sherpa.md +4 -0
- package/reference/autogen/packages/assistant-voice.md +54 -8
- package/reference/autogen/packages/auth-core.md +44 -13
- package/reference/autogen/packages/auth-provider-local-core.md +86 -34
- package/reference/autogen/packages/auth-provider-local-db-core.md +1 -2
- package/reference/autogen/packages/auth-provider-oidc-core.md +10 -4
- package/reference/autogen/packages/auth-provider-supabase-core.md +52 -66
- package/reference/autogen/packages/auth-web.md +19 -11
- package/reference/autogen/packages/connectors-catalog.md +71 -43
- package/reference/autogen/packages/connectors-core.md +42 -4
- package/reference/autogen/packages/console-core.md +27 -14
- package/reference/autogen/packages/crud-core.md +178 -170
- package/reference/autogen/packages/database-runtime-mysql.md +0 -2
- package/reference/autogen/packages/database-runtime-postgres.md +0 -2
- package/reference/autogen/packages/database-runtime.md +39 -10
- package/reference/autogen/packages/http-runtime.md +79 -57
- package/reference/autogen/packages/json-rest-api-core.md +11 -8
- package/reference/autogen/packages/kernel.md +144 -83
- package/reference/autogen/packages/oidc-issuer-core.md +49 -20
- package/reference/autogen/packages/payments-core.md +20 -3
- package/reference/autogen/packages/realtime.md +47 -22
- package/reference/autogen/packages/resource-core.md +1 -1
- package/reference/autogen/packages/resource-crud-core.md +64 -26
- package/reference/autogen/packages/rewarded-core.md +47 -36
- package/reference/autogen/packages/shell-web.md +7 -10
- package/reference/autogen/packages/storage-runtime.md +6 -2
- package/reference/autogen/packages/uploads-runtime.md +10 -2
- package/reference/autogen/packages/users-core.md +73 -71
- package/reference/autogen/packages/workspaces-core.md +121 -106
- package/reference/autogen/packages/workspaces-web.md +1 -2
- package/reference/autogen/tooling/config-eslint.md +302 -0
- package/reference/autogen/tooling/jskit-catalog.md +28 -18
- package/reference/autogen/tooling/jskit-release.md +35 -20
- package/reference/autogen/tooling/testUtils.md +3 -1
- package/skills/jskit/SKILL.md +3 -2
- package/skills/jskit/references/app-operations.md +1 -1
- package/skills/jskit/references/client-features.md +491 -0
- package/skills/jskit/references/crud-form-actions.md +1 -1
- package/skills/jskit/references/crud-operations.md +7 -7
- package/skills/jskit/references/existing-application-migration.md +31 -27
- package/skills/jskit/references/heuristics/INDEX.md +5 -1
- package/skills/jskit/references/heuristics/child-cruds.md +1 -1
- package/skills/jskit/references/heuristics/client-features.md +66 -0
- package/skills/jskit/references/heuristics/client-requests.md +1 -1
- package/skills/jskit/references/heuristics/crud-authoring.md +12 -2
- package/skills/jskit/references/heuristics/crud-links.md +1 -1
- package/skills/jskit/references/heuristics/crud-repository-mapping.md +3 -3
- package/skills/jskit/references/heuristics/filters.md +1 -1
- package/skills/jskit/references/heuristics/live-actions.md +1 -1
- package/skills/jskit/references/heuristics/page-redirects.md +1 -1
- package/skills/jskit/references/heuristics/page-scaffolding.md +1 -1
- package/skills/jskit/references/heuristics/placements.md +1 -1
- package/skills/jskit/references/heuristics/row-policies.md +1 -1
- package/skills/jskit/references/heuristics/server-search.md +1 -1
- package/skills/jskit/references/heuristics/surfaces.md +1 -1
- package/skills/jskit/references/heuristics/typed-features.md +100 -0
- package/skills/jskit/references/heuristics/ui-contract.md +1 -1
- package/skills/jskit/references/heuristics/ui-testing.md +4 -4
- package/skills/jskit/references/material-3.md +2 -2
- package/skills/jskit/references/multi-homing.md +96 -50
- package/skills/jskit/references/pattern-index.md +37 -37
- package/skills/jskit/references/patterns/app/minimal-foundation/PATTERN.md +30 -1
- package/skills/jskit/references/patterns/app/minimal-foundation/example/AGENTS.md +14 -0
- package/skills/jskit/references/patterns/app/minimal-foundation/example/bin/develop.js +10 -5
- package/skills/jskit/references/patterns/app/minimal-foundation/example/eslint.config.mjs +21 -2
- package/skills/jskit/references/patterns/app/minimal-foundation/example/package.json +5 -4
- package/skills/jskit/references/patterns/app/minimal-foundation/example/playwright.config.mjs +1 -1
- package/skills/jskit/references/patterns/app/minimal-foundation/example/server/lib/envFile.js +19 -0
- package/skills/jskit/references/patterns/app/minimal-foundation/example/server/lib/loggerOptions.js +15 -0
- package/skills/jskit/references/patterns/app/minimal-foundation/example/server/lib/runtimeEnv.js +17 -17
- package/skills/jskit/references/patterns/app/minimal-foundation/example/server.js +32 -29
- package/skills/jskit/references/patterns/app/minimal-foundation/example/tests/server/smoke.test.js +2 -1
- package/skills/jskit/references/patterns/app/shell-foundation/PATTERN.md +29 -0
- package/skills/jskit/references/patterns/app/shell-foundation/example/AGENTS.md +14 -0
- package/skills/jskit/references/patterns/app/shell-foundation/example/bin/develop.js +10 -5
- package/skills/jskit/references/patterns/app/shell-foundation/example/eslint.config.mjs +21 -2
- package/skills/jskit/references/patterns/app/shell-foundation/example/package.json +6 -5
- package/skills/jskit/references/patterns/app/shell-foundation/example/packages/main/package.json +1 -1
- package/skills/jskit/references/patterns/app/shell-foundation/example/packages/main/src/client/providers/MainClientProvider.js +1 -0
- package/skills/jskit/references/patterns/app/shell-foundation/example/playwright.config.mjs +1 -1
- package/skills/jskit/references/patterns/app/shell-foundation/example/server/lib/envFile.js +19 -0
- package/skills/jskit/references/patterns/app/shell-foundation/example/server/lib/loggerOptions.js +15 -0
- package/skills/jskit/references/patterns/app/shell-foundation/example/server/lib/runtimeEnv.js +17 -17
- package/skills/jskit/references/patterns/app/shell-foundation/example/server.js +32 -29
- package/skills/jskit/references/patterns/app/shell-foundation/example/tests/server/smoke.test.js +2 -1
- package/skills/jskit/references/patterns/assistant/assistant-surface/example/src/ApplicationAiFeature.js +4 -2
- package/skills/jskit/references/patterns/auth/accounts-hub/PATTERN.md +2 -1
- package/skills/jskit/references/patterns/auth/accounts-hub/example/package.json +2 -2
- package/skills/jskit/references/patterns/auth/accounts-hub/example/server/hubPaths.js +9 -3
- package/skills/jskit/references/patterns/auth/auth-surface/PATTERN.md +25 -12
- package/skills/jskit/references/patterns/auth/auth-surface/example/tools/preview-identity +7 -1
- package/skills/jskit/references/patterns/auth/oidc-sign-in/example/package.json +2 -2
- package/skills/jskit/references/patterns/auth/supabase-auth/example/package.json +1 -1
- package/skills/jskit/references/patterns/connectors/ai-connections/PATTERN.md +16 -1
- package/skills/jskit/references/patterns/connectors/ai-connections/example/ai-model.js +12 -3
- package/skills/jskit/references/patterns/connectors/ai-connections/example/perplexity-answer.js +15 -4
- package/skills/jskit/references/patterns/connectors/api-key-connection/PATTERN.md +9 -1
- package/skills/jskit/references/patterns/connectors/api-key-connection/example/connections.js +5 -2
- package/skills/jskit/references/patterns/connectors/aws-storage-queries/PATTERN.md +13 -3
- package/skills/jskit/references/patterns/connectors/aws-storage-queries/example/s3-transfer.js +14 -3
- package/skills/jskit/references/patterns/connectors/calendar-cli/PATTERN.md +8 -0
- package/skills/jskit/references/patterns/connectors/calendar-cli/example/knexfile.js +1 -1
- package/skills/jskit/references/patterns/connectors/calendar-cli/example/package.json +4 -4
- package/skills/jskit/references/patterns/connectors/calendar-cli/example/scripts/calendar.js +8 -4
- package/skills/jskit/references/patterns/connectors/event-delivery/PATTERN.md +1 -1
- package/skills/jskit/references/patterns/connectors/firebase-messaging/PATTERN.md +10 -0
- package/skills/jskit/references/patterns/connectors/firebase-messaging/example/server/notifications.js +8 -0
- package/skills/jskit/references/patterns/connectors/google-ads-search/PATTERN.md +18 -7
- package/skills/jskit/references/patterns/connectors/google-ads-search/example/ads-setup.js +13 -5
- package/skills/jskit/references/patterns/connectors/oauth-connection/PATTERN.md +1 -1
- package/skills/jskit/references/patterns/connectors/paddle-catalogue/PATTERN.md +11 -2
- package/skills/jskit/references/patterns/connectors/paddle-catalogue/example/create-products.js +5 -2
- package/skills/jskit/references/patterns/connectors/public-image/PATTERN.md +10 -1
- package/skills/jskit/references/patterns/connectors/public-image/example/logo-url.js +4 -1
- package/skills/jskit/references/patterns/connectors/redshift-queries/PATTERN.md +1 -1
- package/skills/jskit/references/patterns/connectors/source-scanning/PATTERN.md +13 -2
- package/skills/jskit/references/patterns/connectors/source-scanning/example/source-scanner.js +9 -0
- package/skills/jskit/references/patterns/crud/json-api-resource-package/PATTERN.md +102 -23
- package/skills/jskit/references/patterns/crud/json-api-resource-package/example/packages/books/package.json +3 -2
- package/skills/jskit/references/patterns/crud/json-api-resource-package/example/packages/books/src/server/types.js +5 -0
- package/skills/jskit/references/patterns/crud/resource-contract/PATTERN.md +54 -1
- package/skills/jskit/references/patterns/database/mysql-application/PATTERN.md +16 -5
- package/skills/jskit/references/patterns/database/mysql-application/example/knexfile.js +2 -2
- package/skills/jskit/references/patterns/database/mysql-application/example/package.json +1 -1
- package/skills/jskit/references/patterns/database/mysql-application/example/scripts/prepare-database.js +1 -1
- package/skills/jskit/references/patterns/database/postgres-application/PATTERN.md +16 -5
- package/skills/jskit/references/patterns/database/postgres-application/example/knexfile.js +2 -2
- package/skills/jskit/references/patterns/database/postgres-application/example/package.json +1 -1
- package/skills/jskit/references/patterns/database/postgres-application/example/scripts/prepare-database.js +1 -1
- package/skills/jskit/references/patterns/realtime/realtime-application/example/package.json +2 -2
- package/skills/jskit/references/patterns/rewards/google-rewarded/example/GoogleRewardedDeliveryProvider.js +1 -1
- package/skills/jskit/references/patterns/rewards/google-rewarded/example/googlePublisherTag.js +5 -11
- package/skills/jskit/references/patterns/server/feature-package/PATTERN.md +104 -10
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/package.json +9 -4
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/src/server/BookingEngineFeature.js +24 -0
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/src/server/bookingAvailability.js +10 -0
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/src/server/bookingEngine.js +29 -0
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/src/server/bookingEngineActions.js +26 -0
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/src/server/inputSchemas.js +1 -2
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/src/server/types.js +12 -0
- package/skills/jskit/references/patterns/server/feature-package/example/variations/AvailabilityEngineFeature.js +19 -0
- package/skills/jskit/references/patterns/server/feature-package/example/variations/InvoiceRollupFeature.js +23 -0
- package/skills/jskit/references/patterns/server/feature-package/example/variations/availabilityEngineActions.js +26 -0
- package/skills/jskit/references/patterns/server/feature-package/example/variations/customKnexRepository.js +32 -26
- package/skills/jskit/references/patterns/server/feature-package/example/variations/invoiceRollupActions.js +26 -0
- package/skills/jskit/references/patterns/server/feature-package/example/variations/orchestratorService.js +24 -19
- package/skills/jskit/references/patterns/server/feature-package/example/variations/types.js +7 -0
- package/skills/jskit/references/patterns/users/user-administration-server/PATTERN.md +16 -1
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users/package.json +3 -2
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users/src/server/types.js +5 -0
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users-workspace/package.json +4 -3
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users-workspace/src/server/UsersWorkspaceFeature.js +2 -9
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users-workspace/src/server/types.js +5 -0
- package/skills/jskit/references/patterns/workspaces/workspace-server/PATTERN.md +42 -17
- package/skills/jskit/references/patterns/workspaces/workspace-server/example/packages/main/src/server/WorkspaceInvitationsFeature.js +27 -0
- package/skills/jskit/references/patterns/workspaces/workspace-server/example/packages/main/src/server/email/workspaceInviteEmail.js +11 -10
- package/skills/jskit/references/patterns/workspaces/workspace-server/example/packages/main/src/server/email/workspaceInviteMailer.js +27 -0
- package/skills/jskit/references/translation.md +5 -4
- package/skills/jskit/references/typed-features.md +1099 -0
- package/skills/jskit/references/ui-operations.md +3 -3
- package/patterns/feature-package/example/booking-engine/src/server/BookingEngineProvider.js +0 -33
- package/patterns/feature-package/example/booking-engine/src/server/actions.js +0 -24
- package/patterns/feature-package/example/variations/AvailabilityEngineProvider.js +0 -31
- package/patterns/feature-package/example/variations/InvoiceRollupProvider.js +0 -36
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/src/server/BookingEngineProvider.js +0 -33
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/src/server/actions.js +0 -24
- package/skills/jskit/references/patterns/server/feature-package/example/variations/AvailabilityEngineProvider.js +0 -31
- package/skills/jskit/references/patterns/server/feature-package/example/variations/InvoiceRollupProvider.js +0 -36
|
@@ -35,7 +35,7 @@ Exports
|
|
|
35
35
|
|
|
36
36
|
### `src/client/asyncModuleRecovery/runtime.js`
|
|
37
37
|
Exports
|
|
38
|
-
- `createShellAsyncModuleRecoveryRuntime({ router = null, errorRuntime = null, logger
|
|
38
|
+
- `createShellAsyncModuleRecoveryRuntime({ router = null, errorRuntime = null, logger })`
|
|
39
39
|
|
|
40
40
|
### `src/client/bootstrap/bootstrapErrorStatus.js`
|
|
41
41
|
Exports
|
|
@@ -203,10 +203,9 @@ Exports
|
|
|
203
203
|
|
|
204
204
|
### `src/client/error/runtime.js`
|
|
205
205
|
Exports
|
|
206
|
-
- `createErrorRuntime({ presenters = [], policy = null, defaultPresenterId = "", moduleDefaultPresenterId = "", logger
|
|
206
|
+
- `createErrorRuntime({ presenters = [], policy = null, defaultPresenterId = "", moduleDefaultPresenterId = "", logger })`
|
|
207
207
|
- `normalizeErrorEvent(rawEvent = {})`
|
|
208
208
|
Local functions
|
|
209
|
-
- `createRuntimeLogger(logger = null)`
|
|
210
209
|
- `freezeParams(params)`
|
|
211
210
|
- `messageCodeFields(source = {}, fallback = {})`
|
|
212
211
|
- `normalizePolicyDecision(policyDecision = {}, event = {})`
|
|
@@ -322,13 +321,11 @@ Exports
|
|
|
322
321
|
|
|
323
322
|
### `src/client/placement/runtime.js`
|
|
324
323
|
Exports
|
|
325
|
-
- `createWebPlacementRuntime({ components, contextContributors = [], logger
|
|
324
|
+
- `createWebPlacementRuntime({ components, contextContributors = [], logger })`
|
|
326
325
|
Local functions
|
|
327
326
|
- `ensureArray(value)`
|
|
328
|
-
- `NOOP()`
|
|
329
327
|
- `isPlacementDebugEnabled()`
|
|
330
328
|
- `debugLog(message, payload = null)`
|
|
331
|
-
- `createRuntimeLogger(logger)`
|
|
332
329
|
- `normalizePlacementList(placements, context = {})`
|
|
333
330
|
- `normalizeTopologyList(topology, context = {})`
|
|
334
331
|
- `matchesSurface(placementSurfaces, requestedSurface)`
|
|
@@ -404,7 +401,7 @@ Exports
|
|
|
404
401
|
### `src/client/requestRecovery/runtime.js`
|
|
405
402
|
Exports
|
|
406
403
|
- `appReloadFailureMessage()`
|
|
407
|
-
- `createShellRequestRecoveryRuntime({ queryClient = null, errorRuntime = null, logger
|
|
404
|
+
- `createShellRequestRecoveryRuntime({ queryClient = null, errorRuntime = null, logger })`
|
|
408
405
|
- `isRecoverableRequestError(error = null)`
|
|
409
406
|
- `requestRecoveryMessage(error = null, { label = "", message = "" } = {})`
|
|
410
407
|
Local functions
|
|
@@ -423,16 +420,16 @@ Local functions
|
|
|
423
420
|
|
|
424
421
|
### `src/client/runtime/bootstrapRuntime.js`
|
|
425
422
|
Exports
|
|
426
|
-
- `createShellBootstrapRuntime({ handlers, placementRuntime, requestRecoveryRuntime = null, router = null, logger, fetchImplementation = globalThis.fetch, bootstrapPath =
|
|
423
|
+
- `createShellBootstrapRuntime({ handlers, placementRuntime, requestRecoveryRuntime = null, router = null, logger, fetchImplementation = globalThis.fetch, bootstrapPath = BOOTSTRAP_PATH } = {})`
|
|
427
424
|
Local functions
|
|
428
425
|
- `normalizeObject(value)`
|
|
429
|
-
- `buildBootstrapUrl({ path =
|
|
426
|
+
- `buildBootstrapUrl({ path = BOOTSTRAP_PATH, query = {} } = {})`
|
|
430
427
|
- `normalizeBootstrapResponseError(response, url)`
|
|
431
428
|
|
|
432
429
|
### `src/client/runtime/refreshRuntime.js`
|
|
433
430
|
Exports
|
|
434
431
|
- `SHELL_WEB_REFRESH_RUNTIME_KEY`
|
|
435
|
-
- `createShellRefreshRuntime({ bootstrapRuntime = null, queryClient = null, errorRuntime = null, logger
|
|
432
|
+
- `createShellRefreshRuntime({ bootstrapRuntime = null, queryClient = null, errorRuntime = null, logger })`
|
|
436
433
|
Local functions
|
|
437
434
|
- `isPullRefreshQuery(query = null)`
|
|
438
435
|
|
|
@@ -28,6 +28,10 @@ Exports
|
|
|
28
28
|
- `STORAGE_FS_BASE_PATH_ENV_KEY`
|
|
29
29
|
- `DEFAULT_STORAGE_DRIVER`
|
|
30
30
|
- `normalizeStorageDriver(value)`
|
|
31
|
-
- `createStorageBinding({ env
|
|
31
|
+
- `createStorageBinding({ env, appRoot })`
|
|
32
32
|
Local functions
|
|
33
|
-
- `resolveFsBasePath(fsBasePath,
|
|
33
|
+
- `resolveFsBasePath(fsBasePath, appRoot)`
|
|
34
|
+
|
|
35
|
+
### `src/server/types.js`
|
|
36
|
+
Exports
|
|
37
|
+
- `type RuntimeStorage`
|
|
@@ -34,7 +34,7 @@ Exports
|
|
|
34
34
|
|
|
35
35
|
### `src/server/policy/uploadPolicy.js`
|
|
36
36
|
Exports
|
|
37
|
-
- `
|
|
37
|
+
- `buildUploadFieldError(fieldName, message, { code = "", params = {} } = {})`
|
|
38
38
|
- `normalizeUploadPolicy`
|
|
39
39
|
- `readUploadBuffer(stream, { maxBytes = DEFAULT_IMAGE_UPLOAD_POLICY.maxUploadBytes, fieldName = "file", label = "File" } = {})`
|
|
40
40
|
- `validateUploadMimeType(mimeType, policy = DEFAULT_IMAGE_UPLOAD_POLICY, { fieldName = "file", label = "File" } = {})`
|
|
@@ -49,10 +49,18 @@ Exports
|
|
|
49
49
|
- `MIME_TYPE_JPEG`
|
|
50
50
|
- `MIME_TYPE_PNG`
|
|
51
51
|
- `MIME_TYPE_WEBP`
|
|
52
|
-
- `createUploadStorageService({ storage, mimeTypeDetector = detectCommonMimeTypeFromBuffer }
|
|
52
|
+
- `createUploadStorageService({ storage, mimeTypeDetector = detectCommonMimeTypeFromBuffer })`
|
|
53
53
|
- `detectCommonMimeTypeFromBuffer(buffer)`
|
|
54
54
|
- `normalizeStorageKey(value)`
|
|
55
55
|
|
|
56
|
+
### `src/server/types.js`
|
|
57
|
+
Exports
|
|
58
|
+
- `type RuntimeUploads`
|
|
59
|
+
|
|
60
|
+
### `src/server/uploadsRuntime.js`
|
|
61
|
+
Exports
|
|
62
|
+
- `createUploadsRuntime()`
|
|
63
|
+
|
|
56
64
|
### `src/shared/imageUploadDefaults.js`
|
|
57
65
|
Exports
|
|
58
66
|
- `DEFAULT_IMAGE_UPLOAD_ALLOWED_MIME_TYPES`
|
|
@@ -16,81 +16,73 @@ Use this on demand; do not load the full index at startup.
|
|
|
16
16
|
|
|
17
17
|
### `src/server/accountNotifications/accountNotificationsActions.js`
|
|
18
18
|
Exports
|
|
19
|
-
- `
|
|
20
|
-
- `buildAccountNotificationsActions({ accountNotificationsService } = {})`
|
|
19
|
+
- `createAccountNotificationsActions({ accountNotificationsService })`
|
|
21
20
|
|
|
22
|
-
### `src/server/accountNotifications/
|
|
21
|
+
### `src/server/accountNotifications/accountNotificationsRoutes.js`
|
|
23
22
|
Exports
|
|
24
|
-
- `
|
|
23
|
+
- `registerAccountNotificationsRoutes(router)`
|
|
25
24
|
|
|
26
|
-
### `src/server/accountNotifications/
|
|
25
|
+
### `src/server/accountNotifications/accountNotificationsService.js`
|
|
27
26
|
Exports
|
|
28
|
-
- `
|
|
27
|
+
- `createService({ userSettingsRepository, userProfilesRepository, authService })`
|
|
29
28
|
|
|
30
29
|
### `src/server/accountPreferences/accountPreferencesActions.js`
|
|
31
30
|
Exports
|
|
32
|
-
- `
|
|
33
|
-
- `buildAccountPreferencesActions({ accountPreferencesService } = {})`
|
|
31
|
+
- `createAccountPreferencesActions({ accountPreferencesService })`
|
|
34
32
|
|
|
35
|
-
### `src/server/accountPreferences/
|
|
33
|
+
### `src/server/accountPreferences/accountPreferencesRoutes.js`
|
|
36
34
|
Exports
|
|
37
|
-
- `
|
|
35
|
+
- `registerAccountPreferencesRoutes(router)`
|
|
38
36
|
|
|
39
|
-
### `src/server/accountPreferences/
|
|
37
|
+
### `src/server/accountPreferences/accountPreferencesService.js`
|
|
40
38
|
Exports
|
|
41
|
-
- `
|
|
39
|
+
- `createService({ userSettingsRepository, userProfilesRepository, authService })`
|
|
42
40
|
|
|
43
41
|
### `src/server/accountProfile/accountProfileActions.js`
|
|
44
42
|
Exports
|
|
45
|
-
- `
|
|
46
|
-
|
|
43
|
+
- `createAccountProfileActions({ accountProfileService })`
|
|
44
|
+
|
|
45
|
+
### `src/server/accountProfile/accountProfileRoutes.js`
|
|
46
|
+
Exports
|
|
47
|
+
- `registerAccountProfileRoutes(router, { accountProfileService, authService, uploads })`
|
|
47
48
|
|
|
48
49
|
### `src/server/accountProfile/accountProfileService.js`
|
|
49
50
|
Exports
|
|
50
|
-
- `createService({ userSettingsRepository, userProfilesRepository, authService, avatarService }
|
|
51
|
+
- `createService({ userSettingsRepository, userProfilesRepository, authService, avatarService })`
|
|
51
52
|
|
|
52
53
|
### `src/server/accountProfile/avatarService.js`
|
|
53
54
|
Exports
|
|
54
|
-
- `createService({ userProfilesRepository, avatarStorageService
|
|
55
|
-
- `__testables`
|
|
56
|
-
Local functions
|
|
57
|
-
- `resolveAvatarPolicy(policy = {})`
|
|
58
|
-
- `readAvatarBuffer(stream, { maxBytes = DEFAULT_AVATAR_POLICY.maxUploadBytes } = {})`
|
|
55
|
+
- `createService({ userProfilesRepository, avatarStorageService })`
|
|
59
56
|
|
|
60
57
|
### `src/server/accountProfile/avatarStorageService.js`
|
|
61
58
|
Exports
|
|
62
|
-
- `createService({ storage }
|
|
59
|
+
- `createService({ storage })`
|
|
63
60
|
- `__testables`
|
|
64
61
|
Local functions
|
|
65
62
|
- `buildAvatarStorageKey(userId)`
|
|
66
63
|
|
|
67
|
-
### `src/server/accountProfile/bootAccountProfileRoutes.js`
|
|
68
|
-
Exports
|
|
69
|
-
- `registerAccountProfileRoutes(router, { accountProfileService, authService, uploads } = {})`
|
|
70
|
-
|
|
71
64
|
### `src/server/accountSecurity/accountSecurityActions.js`
|
|
72
65
|
Exports
|
|
73
|
-
- `
|
|
74
|
-
- `buildAccountSecurityActions({ accountSecurityService } = {})`
|
|
66
|
+
- `createAccountSecurityActions({ accountSecurityService })`
|
|
75
67
|
|
|
76
|
-
### `src/server/accountSecurity/
|
|
68
|
+
### `src/server/accountSecurity/accountSecurityRoutes.js`
|
|
77
69
|
Exports
|
|
78
|
-
- `
|
|
70
|
+
- `registerAccountSecurityRoutes(router, { authService })`
|
|
79
71
|
|
|
80
|
-
### `src/server/accountSecurity/
|
|
72
|
+
### `src/server/accountSecurity/accountSecurityService.js`
|
|
81
73
|
Exports
|
|
82
|
-
- `
|
|
74
|
+
- `createService({ userSettingsRepository, userProfilesRepository, authService })`
|
|
83
75
|
|
|
84
76
|
### `src/server/common/formatters/accountAvatarFormatter.js`
|
|
85
77
|
Exports
|
|
86
78
|
- `accountAvatarFormatter(profile, settings)`
|
|
87
79
|
Local functions
|
|
88
|
-
- `
|
|
89
|
-
- `
|
|
80
|
+
- `buildGravatarUrl(email, size)`
|
|
81
|
+
- `buildUploadedAvatarUrl(profile)`
|
|
90
82
|
|
|
91
83
|
### `src/server/common/formatters/accountSecurityStatusFormatter.js`
|
|
92
84
|
Exports
|
|
93
|
-
- `accountSecurityStatusFormatter(securityStatus
|
|
85
|
+
- `accountSecurityStatusFormatter(securityStatus)`
|
|
94
86
|
Local functions
|
|
95
87
|
- `normalizeMfa(source)`
|
|
96
88
|
- `normalizeAuthMethods(sourceMethods)`
|
|
@@ -98,46 +90,29 @@ Local functions
|
|
|
98
90
|
### `src/server/common/formatters/accountSettingsResponseFormatter.js`
|
|
99
91
|
Exports
|
|
100
92
|
- `accountSettingsResponseFormatter({ profile, settings, securityStatus, authService })`
|
|
93
|
+
- `formatUserSettingsSection(fieldKeys, settings = {})`
|
|
101
94
|
Local functions
|
|
102
95
|
- `resolveAuthProfileSettings(authService)`
|
|
103
|
-
- `formatUserSettingsSection(fieldKeys, settings = {})`
|
|
104
|
-
|
|
105
|
-
### `src/server/common/repositories/repositoryUtils.js`
|
|
106
|
-
Exports
|
|
107
|
-
- `toIsoString`
|
|
108
|
-
- `retryDeadlocks`
|
|
109
|
-
- `isDuplicateEntryError`
|
|
110
|
-
- `findDuplicateEntryError`
|
|
111
|
-
- `normalizeText`
|
|
112
|
-
- `normalizeLowerText`
|
|
113
|
-
- `normalizeRecordId`
|
|
114
|
-
- `normalizeDbRecordId`
|
|
115
|
-
- `uniqueSorted(values)`
|
|
116
|
-
- `parseJson(value, fallback = {})`
|
|
117
|
-
- `toDbJson(value, fallback = {})`
|
|
118
96
|
|
|
119
97
|
### `src/server/common/repositories/userProfilesRepository.js`
|
|
120
98
|
Exports
|
|
121
|
-
- `createRepository({ api }
|
|
99
|
+
- `createRepository({ api })`
|
|
122
100
|
Local functions
|
|
123
|
-
- `normalizeUsername(value)`
|
|
124
|
-
- `normalizeNullableString(value)`
|
|
125
|
-
- `normalizeNullableVersion(value)`
|
|
126
101
|
- `normalizeProfileRecord(payload = null)`
|
|
127
102
|
- `normalizeCreatePayload(payload = {})`
|
|
128
103
|
- `usernameBaseFromEmail(email)`
|
|
129
104
|
- `buildUsernameCandidate(baseUsername, suffix)`
|
|
130
105
|
- `duplicateTargetsEmail(error)`
|
|
131
106
|
- `duplicateTargetsUsername(error)`
|
|
132
|
-
- `
|
|
107
|
+
- `buildDuplicateEmailConflictError(cause)`
|
|
133
108
|
- `resolveUniqueUsername(api, baseUsername, { excludeUserId = null, transaction = null } = {})`
|
|
134
109
|
|
|
135
110
|
### `src/server/common/repositories/userSettingsRepository.js`
|
|
136
111
|
Exports
|
|
137
|
-
- `createRepository({ api }
|
|
112
|
+
- `createRepository({ api })`
|
|
138
113
|
Local functions
|
|
139
114
|
- `pickPatchFields(source = {})`
|
|
140
|
-
- `
|
|
115
|
+
- `buildDefaultUserSettingsCreatePayload(userId)`
|
|
141
116
|
|
|
142
117
|
### `src/server/common/services/accountContextService.js`
|
|
143
118
|
Exports
|
|
@@ -146,21 +121,16 @@ Exports
|
|
|
146
121
|
|
|
147
122
|
### `src/server/common/services/authProfileSyncService.js`
|
|
148
123
|
Exports
|
|
149
|
-
- `createService({ userProfilesRepository, resolveLifecycleContributors
|
|
124
|
+
- `createService({ userProfilesRepository, resolveLifecycleContributors, userSettingsRepository })`
|
|
150
125
|
Local functions
|
|
151
126
|
- `buildNormalizedIdentityKey(identityLike)`
|
|
152
127
|
- `buildNormalizedIdentityProfile(profileLike)`
|
|
153
128
|
- `profileNeedsUpdate(existing, nextProfile)`
|
|
154
129
|
- `requireSynchronizedProfile(profile)`
|
|
155
|
-
- `normalizeLifecycleContributors(entries = [])`
|
|
156
130
|
|
|
157
131
|
### `src/server/common/support/accountSettingsJsonApiTransport.js`
|
|
158
132
|
Exports
|
|
159
|
-
- `resolveAccountSettingsResourceId(_record, context
|
|
160
|
-
|
|
161
|
-
### `src/server/common/support/deepFreeze.js`
|
|
162
|
-
Exports
|
|
163
|
-
- `deepFreeze`
|
|
133
|
+
- `resolveAccountSettingsResourceId(_record, context)`
|
|
164
134
|
|
|
165
135
|
### `src/server/common/support/identity.js`
|
|
166
136
|
Exports
|
|
@@ -170,19 +140,33 @@ Exports
|
|
|
170
140
|
Exports
|
|
171
141
|
- `ACCOUNT_SETTINGS_AND_BOOTSTRAP_EVENTS`
|
|
172
142
|
Local functions
|
|
173
|
-
- `resolveActorScopedEntityId({ context }
|
|
143
|
+
- `resolveActorScopedEntityId({ context })`
|
|
174
144
|
|
|
175
145
|
### `src/server/common/support/resolveActionUser.js`
|
|
176
146
|
Exports
|
|
177
147
|
- `resolveActionUser(context, input)`
|
|
178
148
|
|
|
149
|
+
### `src/server/types.js`
|
|
150
|
+
Exports
|
|
151
|
+
- `type UsersCore`
|
|
152
|
+
- `type UsersExtensions`
|
|
153
|
+
- `type UsersIdentity`
|
|
154
|
+
- `type UserProfilesRepository`
|
|
155
|
+
- `type UserSettingsRepository`
|
|
156
|
+
- `type ResolveProfileSyncLifecycleContributors`
|
|
157
|
+
- `type AccountNotificationsService`
|
|
158
|
+
- `type AccountPreferencesService`
|
|
159
|
+
- `type AccountProfileService`
|
|
160
|
+
- `type AvatarService`
|
|
161
|
+
- `type AvatarStorageService`
|
|
162
|
+
- `type AccountSecurityService`
|
|
163
|
+
|
|
179
164
|
### `src/server/usersBootstrapContributor.js`
|
|
180
165
|
Exports
|
|
181
|
-
- `createUsersBootstrapContributor({ userProfilesRepository, userSettingsRepository, authService }
|
|
166
|
+
- `createUsersBootstrapContributor({ userProfilesRepository, userSettingsRepository, authService })`
|
|
182
167
|
Local functions
|
|
183
168
|
- `getOAuthProviderCatalogPayload(authService)`
|
|
184
|
-
- `
|
|
185
|
-
- `mapUserSettingsBootstrap(settings = {})`
|
|
169
|
+
- `buildAnonymousBootstrapPayload(surfaceAccess)`
|
|
186
170
|
|
|
187
171
|
### `src/server/usersExtensions.js`
|
|
188
172
|
Exports
|
|
@@ -197,12 +181,19 @@ Exports
|
|
|
197
181
|
### `src/server/UsersFeature.js`
|
|
198
182
|
Exports
|
|
199
183
|
- `UsersFeature`
|
|
200
|
-
|
|
184
|
+
|
|
185
|
+
### `src/server/usersIdentity.js`
|
|
186
|
+
Exports
|
|
187
|
+
- `createUsersIdentity({ jsonRestApi, extensions })`
|
|
201
188
|
|
|
202
189
|
### `src/server/UsersIdentityProvider.js`
|
|
203
190
|
Exports
|
|
204
191
|
- `UsersIdentityProvider`
|
|
205
192
|
|
|
193
|
+
### `src/server/usersRuntime.js`
|
|
194
|
+
Exports
|
|
195
|
+
- `createUsersRuntime({ authService, identity, storage })`
|
|
196
|
+
|
|
206
197
|
### `src/shared/index.js`
|
|
207
198
|
Exports
|
|
208
199
|
- `DEFAULT_USER_SETTINGS`
|
|
@@ -210,7 +201,7 @@ Exports
|
|
|
210
201
|
|
|
211
202
|
### `src/shared/operationMessages.js`
|
|
212
203
|
Exports
|
|
213
|
-
- `
|
|
204
|
+
- `OPERATION_MESSAGES`
|
|
214
205
|
|
|
215
206
|
### `src/shared/resources/accountSettingsSchemas.js`
|
|
216
207
|
Exports
|
|
@@ -221,10 +212,13 @@ Exports
|
|
|
221
212
|
### `src/shared/resources/userProfileResource.js`
|
|
222
213
|
Exports
|
|
223
214
|
- `userProfileResource`
|
|
224
|
-
|
|
225
|
-
|
|
215
|
+
|
|
216
|
+
### `src/shared/resources/userProfileValues.js`
|
|
217
|
+
Exports
|
|
218
|
+
- `USERNAME_MAX_LENGTH`
|
|
226
219
|
- `normalizeNullableString(value)`
|
|
227
220
|
- `normalizeNullableVersion(value)`
|
|
221
|
+
- `normalizeUsername(value)`
|
|
228
222
|
|
|
229
223
|
### `src/shared/resources/userSettingsResource.js`
|
|
230
224
|
Exports
|
|
@@ -264,6 +258,10 @@ Local functions
|
|
|
264
258
|
|
|
265
259
|
### patterns
|
|
266
260
|
|
|
261
|
+
### `patterns/user-administration-server/example/packages/users-workspace/src/server/types.js`
|
|
262
|
+
Exports
|
|
263
|
+
- `type AppUsersWorkspace`
|
|
264
|
+
|
|
267
265
|
### `patterns/user-administration-server/example/packages/users-workspace/src/server/UsersWorkspaceFeature.js`
|
|
268
266
|
Exports
|
|
269
267
|
- `UsersWorkspaceFeature`
|
|
@@ -276,6 +274,10 @@ Exports
|
|
|
276
274
|
Exports
|
|
277
275
|
- `resource`
|
|
278
276
|
|
|
277
|
+
### `patterns/user-administration-server/example/packages/users/src/server/types.js`
|
|
278
|
+
Exports
|
|
279
|
+
- `type AppUsers`
|
|
280
|
+
|
|
279
281
|
### `patterns/user-administration-server/example/packages/users/src/server/UsersFeature.js`
|
|
280
282
|
Exports
|
|
281
283
|
- `UsersFeature`
|