@jskit-ai/agent-docs 0.1.1

package/reference/autogen/packages/database-runtime-mysql.md

@@ -0,0 +1,61 @@
+# packages/database-runtime-mysql
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/database-runtime-mysql`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/database-runtime-mysql/**/*{.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/DatabaseRuntimeMysqlServiceProvider.js`
+Exports
+- `DatabaseRuntimeMysqlServiceProvider`
+
+### `src/shared/dialect.js`
+Exports
+- `DIALECT_ID`
+- `getDialectId()`
+
+### `src/shared/index.js`
+Exports
+- `DIALECT_ID`
+- `getDialectId`
+- `introspectCrudTableSnapshot`
+
+### `src/shared/introspectCrudTable.js`
+Exports
+- `introspectCrudTableSnapshot(knex, { tableName = "", idColumn = "id" } = {})`
+Local functions
+- `requireKnexRaw(knex)`
+- `requireTableName(value)`
+- `normalizeRows(rawResult)`
+- `normalizeDbSchemaName(rows = [])`
+- `toBoolean(value)`
+- `toNullableNumber(value)`
+- `normalizeColumnDefault(value)`
+- `parseEnumValues(columnType = "")`
+- `resolveTypeKind(column)`
+- `normalizeColumn(row = {})`
+- `normalizePrimaryKeyColumns(rows = [])`
+- `normalizeIndexes(rows = [])`
+- `normalizeForeignKeys(rows = [])`
+- `normalizeCheckConstraints(rows = [])`
+- `requireIdColumn(columns, idColumn)`
+- `requirePrimaryKeyContainsId(primaryKeyColumns, idColumn)`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

package/reference/autogen/packages/database-runtime-postgres.md

@@ -0,0 +1,39 @@
+# packages/database-runtime-postgres
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/database-runtime-postgres`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/database-runtime-postgres/**/*{.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/DatabaseRuntimePostgresServiceProvider.js`
+Exports
+- `DatabaseRuntimePostgresServiceProvider`
+
+### `src/shared/dialect.js`
+Exports
+- `DIALECT_ID`
+- `getDialectId()`
+
+### `src/shared/index.js`
+Exports
+- `DIALECT_ID`
+- `getDialectId`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

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

@@ -0,0 +1,216 @@
+# packages/database-runtime
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/database-runtime`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/database-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/DatabaseRuntimeServiceProvider.js`
+Exports
+- `DatabaseRuntimeServiceProvider`
+Local functions
+- `resolveDatabaseEnv(scope)`
+- `resolveDriverDialectId(driver)`
+- `loadKnexFactory()`
+- `resolveRegisteredDriver(scope)`
+- `resolveRegisteredDrivers(scope)`
+- `resolveSingleRegisteredDriver(scope)`
+- `createKnexConfig(scope)`
+- `createKnexInstance(scope)`
+
+### `src/shared/databaseClient.js`
+Exports
+- `normalizeText`
+- `normalizeDatabaseClient(value, { allowEmpty = false } = {})`
+- `toKnexClientId(databaseClient)`
+
+### `src/shared/databaseConnection.js`
+Exports
+- `parseDatabaseUrl(databaseUrl, { context = "DATABASE_URL", allowEmpty = false } = {})`
+- `resolveDatabaseClientFromEnvironment(env = {}, { allowEmpty = false } = {})`
+- `resolveDatabaseConnectionFromEnvironment(env = {}, { defaultHost = "localhost", defaultPort = 3306, context = "database runtime" } = {})`
+- `resolveKnexConnectionFromEnvironment(env = {}, { client = "", defaultHost = "localhost", defaultPort = 3306, context = "database runtime" } = {})`
+Local functions
+- `toPositiveInteger(value, fallback)`
+
+### `src/shared/dateUtils.js`
+Exports
+- `normalizeDateInput(value)`
+- `toIsoString(value)`
+- `toInsertDateTime(dateLike, fallback = new Date())`
+- `toNullableDateTime(value)`
+- `toDatabaseDateTimeUtc(value)`
+Local functions
+- `toDateOrThrow(value)`
+- `pad(value, size = 2)`
+
+### `src/shared/dialect.js`
+Exports
+- `normalizeDialect(value)`
+- `detectDialectFromClient(client)`
+
+### `src/shared/duplicateEntry.js`
+Exports
+- `isDuplicateEntryError(error, { dialect = "", client = null } = {})`
+Local functions
+- `isMysqlDuplicateEntryError(error)`
+- `isPostgresDuplicateEntryError(error)`
+
+### `src/shared/index.js`
+Exports
+- `DatabaseRuntimeError`
+- `TransactionManagerError`
+- `RepositoryError`
+- `TransactionManager`
+- `createTransactionManager`
+- `BaseRepository`
+- `buildPaginationMeta`
+- `registerDatabaseRuntime`
+- `normalizeDateInput`
+- `toIsoString`
+- `toInsertDateTime`
+- `toNullableDateTime`
+- `toDatabaseDateTimeUtc`
+- `normalizeDialect`
+- `detectDialectFromClient`
+- `normalizeText`
+- `normalizeDatabaseClient`
+- `toKnexClientId`
+- `parseDatabaseUrl`
+- `resolveDatabaseClientFromEnvironment`
+- `resolveDatabaseConnectionFromEnvironment`
+- `resolveKnexConnectionFromEnvironment`
+- `isDuplicateEntryError`
+- `normalizePath`
+- `jsonTextExpression`
+- `whereJsonTextEquals`
+- `DEFAULT_VISIBILITY_COLUMNS`
+- `applyVisibility`
+- `applyVisibilityOwners`
+- `createRepositoryScope`
+- `resolveQueryOptions`
+- `resolveRepoClient`
+- `applyForUpdate`
+- `mapRowNullable`
+- `parseJsonObject`
+- `stringifyJsonObject`
+- `parseMetadataJson`
+- `stringifyMetadataJson`
+- `normalizeMetadataJsonInput`
+- `normalizeNullableString`
+- `normalizeDbRecordId`
+- `resolveInsertedRecordId`
+- `normalizeIdList`
+- `normalizeCountRow`
+- `parseJsonValue`
+- `toDbJson`
+- `runInTransaction`
+- `createWithTransaction`
+- `normalizeBatchSize`
+- `normalizeCutoffDateOrThrow`
+- `normalizeDeletedRowCount`
+- `deleteRowsOlderThan`
+- `retentionTestables`
+- `createRepoTransaction`
+
+### `src/shared/json.js`
+Exports
+- `normalizePath(path)`
+- `jsonTextExpression({ client, column, path })`
+- `whereJsonTextEquals(query, { column, path, value })`
+
+### `src/shared/repository.js`
+Exports
+- `BaseRepository`
+- `buildPaginationMeta({ total, page, pageSize } = {})`
+
+### `src/shared/repositoryOptions.js`
+Exports
+- `resolveQueryOptions(options = {})`
+- `resolveRepoClient(dbClient, options = {})`
+- `applyForUpdate(query, options = {})`
+- `mapRowNullable(mapper)`
+- `parseJsonObject(value, fallback = {})`
+- `stringifyJsonObject(value, fallback = "{}")`
+- `parseMetadataJson(value, fallback = {})`
+- `stringifyMetadataJson(metadata, fallback = "{}")`
+- `normalizeMetadataJsonInput(value, fallback = null)`
+- `normalizeNullableString(value, { trim = true } = {})`
+- `normalizeDbRecordId(value, { fallback = null } = {})`
+- `resolveInsertedRecordId(insertResult, { fallback = null } = {})`
+- `normalizeIdList(values, { parseValue } = {})`
+- `normalizeCountRow(row)`
+- `parseJsonValue(value, fallback = null, options = {})`
+- `toDbJson(value)`
+- `runInTransaction(knex, callback)`
+- `createWithTransaction(knex)`
+
+### `src/shared/repositoryScope.js`
+Exports
+- `createRepositoryScope(knex, tableName, options = {})`
+Local functions
+- `normalizeTableName(value)`
+- `normalizeIdColumn(value)`
+
+### `src/shared/retention.js`
+Exports
+- `normalizeBatchSize(value, { fallback = 1000, max = 10_000 } = {})`
+- `normalizeCutoffDateOrThrow(value)`
+- `normalizeDeletedRowCount(value)`
+- `deleteRowsOlderThan({ client, tableName, dateColumn, cutoffDate, batchSize, applyFilters })`
+- `__testables`
+
+### `src/shared/runtime.js`
+Exports
+- `registerDatabaseRuntime(app, { knex } = {})`
+Local functions
+- `ensureContainerInterface(app)`
+- `ensureKnexInterface(knex)`
+- `ensureKnexBinding(app, knex)`
+- `ensureTransactionManagerBinding(app)`
+
+### `src/shared/runtimeErrors.js`
+Exports
+- `DatabaseRuntimeError`
+- `TransactionManagerError`
+- `RepositoryError`
+
+### `src/shared/transactionManager.js`
+Exports
+- `TransactionManager`
+- `createTransactionManager(options = {})`
+
+### `src/shared/transactions.js`
+Exports
+- `createRepoTransaction(dbClient)`
+
+### `src/shared/visibility.js`
+Exports
+- `DEFAULT_VISIBILITY_COLUMNS`
+- `applyVisibility(queryBuilder, visibilityContext = {})`
+- `applyVisibilityOwners(payload = {}, visibilityContext = {})`
+
+### templates
+
+### `templates/knexfile.js`
+Exports
+- `default`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

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

@@ -0,0 +1,213 @@
+# packages/http-runtime
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/http-runtime`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/http-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
+- `createHttpClient`
+- `createTransientRetryHttpClient`
+- `normalizeFieldErrors`
+- `resolveFieldErrors`
+- `createValidationFailure`
+- `createHttpError`
+- `createNetworkError`
+- `DEFAULT_RETRYABLE_CSRF_ERROR_CODES`
+- `shouldRetryForCsrfFailure`
+- `normalizeHeaderName`
+- `hasHeader`
+- `setHeaderIfMissing`
+- `HttpValidatorsClientProvider`
+- `HttpClientRuntimeClientProvider`
+
+### `src/client/providers/HttpClientRuntimeClientProvider.js`
+Exports
+- `HttpClientRuntimeClientProvider`
+
+### `src/client/providers/HttpValidatorsClientProvider.js`
+Exports
+- `HttpValidatorsClientProvider`
+
+### `src/client/transientRetryHttpClient.js`
+Exports
+- `createTransientRetryHttpClient(options = {})`
+Local functions
+- `sleep(delayMs)`
+- `shouldRetryTransientHttpFailure(error, method, attemptIndex)`
+- `requestWithTransientRetry(executor, method)`
+
+### `src/client/validationErrors.js`
+Exports
+- `normalizeFieldErrors`
+- `resolveFieldErrors`
+- `createValidationFailure({ error = "Validation failed.", code = "validation_failed", fieldErrors = {} } = {})`
+
+### `src/server/providers/HttpClientRuntimeServiceProvider.js`
+Exports
+- `HttpClientRuntimeServiceProvider`
+
+### `src/server/providers/HttpValidatorsServiceProvider.js`
+Exports
+- `HttpValidatorsServiceProvider`
+
+### `src/shared/clientRuntime/client.js`
+Exports
+- `createHttpClient(options = {})`
+Local functions
+- `normalizeMethod(method)`
+- `resolveUnsafeMethods(value)`
+- `resolveFetch()`
+- `isObjectBody(value)`
+- `parseJsonSafely(response)`
+- `emitNdjsonLine(line, handlers)`
+- `readNdjsonStream(response, handlers = {})`
+
+### `src/shared/clientRuntime/errors.js`
+Exports
+- `createHttpError(response, data = {})`
+- `createNetworkError(cause)`
+
+### `src/shared/clientRuntime/headers.js`
+Exports
+- `normalizeHeaderName(name)`
+- `hasHeader(headers, name)`
+- `setHeaderIfMissing(headers, name, value)`
+
+### `src/shared/clientRuntime/index.js`
+Exports
+- `createHttpClient`
+- `createHttpError`
+- `createNetworkError`
+- `DEFAULT_RETRYABLE_CSRF_ERROR_CODES`
+- `shouldRetryForCsrfFailure`
+- `normalizeHeaderName`
+- `hasHeader`
+- `setHeaderIfMissing`
+
+### `src/shared/clientRuntime/retry.js`
+Exports
+- `DEFAULT_RETRYABLE_CSRF_ERROR_CODES`
+- `shouldRetryForCsrfFailure({ response, method, state, data, unsafeMethods, retryableErrorCodes = DEFAULT_RETRYABLE_CSRF_ERROR_CODES })`
+Local functions
+- `toUpperStringSet(values, fallback = [])`
+
+### `src/shared/index.js`
+Exports
+- `createPaginationQuerySchema`
+- `registerTypeBoxFormats`
+- `__testables`
+- `fieldErrorsSchema`
+- `apiErrorDetailsSchema`
+- `apiErrorResponseSchema`
+- `apiValidationErrorResponseSchema`
+- `fastifyDefaultErrorResponseSchema`
+- `STANDARD_ERROR_STATUS_CODES`
+- `passthroughErrorResponses`
+- `withStandardErrorResponses`
+- `enumSchema`
+- `createCursorPagedListResponseSchema`
+- `createResource`
+- `createCommand`
+- `resolveSchemaMessages`
+- `resolveFieldSchema`
+- `resolveIssueField`
+- `resolveMissingRequiredFields`
+- `resolveIssueMessageFromSchema`
+- `mapOperationIssues`
+- `validateOperationSection`
+- `validateOperationInput`
+
+### `src/shared/providers/singletonApiProvider.js`
+Exports
+- `SingletonApiProvider`
+
+### `src/shared/support/fieldErrors.js`
+Exports
+- `isRecord`
+- `normalizeFieldErrors(value)`
+- `resolveFieldErrors(value = null)`
+
+### `src/shared/validators/command.js`
+Exports
+- `createCommand({ input, output, idempotent = null, invalidates = [] } = {})`
+
+### `src/shared/validators/errorResponses.js`
+Exports
+- `fieldErrorsSchema`
+- `apiErrorDetailsSchema`
+- `apiErrorResponseSchema`
+- `apiValidationErrorResponseSchema`
+- `fastifyDefaultErrorResponseSchema`
+- `STANDARD_ERROR_STATUS_CODES`
+- `passthroughErrorResponses(successResponses)`
+- `withStandardErrorResponses(successResponses, { includeValidation400 = false } = {})`
+- `enumSchema(values)`
+
+### `src/shared/validators/httpValidatorsApi.js`
+Exports
+- `HTTP_VALIDATORS_API`
+
+### `src/shared/validators/operationMessages.js`
+Exports
+- `resolveSchemaMessages(schema = {})`
+- `resolveFieldSchema(schema = {}, field = "")`
+- `resolveIssueField(issue = {})`
+- `resolveMissingRequiredFields(issue = {})`
+- `resolveIssueMessageFromSchema(field, issue, schema = {})`
+- `mapOperationIssues(issues = [], schema = {})`
+Local functions
+- `decodePointerSegment(value = "")`
+- `resolveSchemaPathSegments(schemaPath = "")`
+- `resolveFieldFromSchemaPath(schemaPath = "")`
+- `resolveSchemaNode(schema = {}, schemaPath = "")`
+- `collectSchemaFieldCandidates(schema = {})`
+- `resolveConditionalIssueField(issue = {}, schema = {})`
+- `resolveFallbackIssueField(issue = {}, schema = {})`
+- `shouldSuppressRootUnionGlobalIssue(issue = {}, fieldErrors = {})`
+
+### `src/shared/validators/operationValidation.js`
+Exports
+- `validateOperationSection({ operation = {}, section = "bodyValidator", value, context = {} } = {})`
+- `validateOperationInput({ operation = {}, input = {}, context = {} } = {})`
+Local functions
+- `defaultNormalize(value)`
+- `resolveOperationSection(operation = {}, section = "bodyValidator")`
+
+### `src/shared/validators/paginationQuery.js`
+Exports
+- `createPaginationQuerySchema({ defaultPage = 1, defaultPageSize = 10, minPage = 1, minPageSize = 1, maxPageSize = 100 } = {})`
+
+### `src/shared/validators/resource.js`
+Exports
+- `createCursorPagedListResponseSchema(itemSchema)`
+- `createResource({ record, create, replace, patch, list = null, listItem = null } = {})`
+
+### `src/shared/validators/schemaUtils.js`
+Exports
+- `asSchema(value, label)`
+
+### `src/shared/validators/typeboxFormats.js`
+Exports
+- `registerTypeBoxFormats()`
+- `__testables`
+Local functions
+- `isStrictUuid(value)`
+- `isStrictIsoUtcDateTime(value)`
+- `registerTypeBoxFormatsWith(formatRegistry)`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None