@jskit-ai/agent-docs 0.1.256 → 0.1.258

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

@@ -20,9 +20,9 @@ Exports
 - `createTransientRetryHttpClient`
 - `normalizeFieldErrors`
 - `resolveFieldErrors`
-- `createValidationFailure`
-- `createHttpError`
-- `createNetworkError`
+- `buildValidationFailure`
+- `buildHttpError`
+- `buildNetworkError`
 - `isGenericHttpErrorMessage`
 - `DEFAULT_RETRYABLE_CSRF_ERROR_CODES`
 - `shouldRetryForCsrfFailure`
@@ -42,28 +42,33 @@ Local functions
 Exports
 - `normalizeFieldErrors`
 - `resolveFieldErrors`
-- `createValidationFailure({ error = "Validation failed.", code = "validation_failed", fieldErrors = {}, fieldErrorCodes = null } = {})`
+- `buildValidationFailure({ error = "Validation failed.", code = "validation_failed", fieldErrors = {}, fieldErrorCodes = null } = {})`
 
 ### `src/shared/clientRuntime/client.js`
 Exports
-- `createHttpClient(options = {})`
+- `createHttpClient({ fetchImpl = fetchWithGlobalFetch, resolveRequestUrl: resolveConfiguredRequestUrl = keepRequestUrl, hooks = {}, unsafeMethods: configuredUnsafeMethods = DEFAULT_UNSAFE_METHODS, csrf: { enabled: csrfEnabledByDefault = true, sessionPath: csrfSessionPath = "/api/session", headerName: csrfHeaderName = "csrf-token", tokenField: csrfTokenField = "csrfToken", retryableErrorCodes: csrfRetryableErrorCodes } = {}, credentials = "same-origin", readTimeoutMs = DEFAULT_READ_TIMEOUT_MS } = {})`
+- `type HttpClientHooks`
 Local functions
 - `requestSignalWithDeadline(signal, timeoutMs)`
 - `normalizeMethod(method)`
-- `resolveUnsafeMethods(value)`
-- `resolveFetch()`
+- `resolveUnsafeMethods(methods)`
+- `fetchWithGlobalFetch(url, config)`
+- `keepRequestUrl(url)`
+- `keepHeaders()`
+- `ignoreRequestOutcome()`
+- `useCsrfRetryRule()`
+- `useContentTypeForStream()`
+- `ignoreStreamEvent()`
+- `ignoreMalformedLine()`
 - `normalizeResolvedRequestUrl(value, fallback = "")`
 - `isObjectBody(value)`
 - `isQueryValuePresent(value)`
 - `appendRequestQueryToUrl(url, query = null, transport = null)`
-- `parseJsonSafely(response, signal)`
-- `emitNdjsonLine(line, handlers)`
-- `readNdjsonStream(response, handlers = {})`
 
 ### `src/shared/clientRuntime/errors.js`
 Exports
-- `createHttpError(response, data = {})`
-- `createNetworkError(cause)`
+- `buildHttpError(response, data = {})`
+- `buildNetworkError(cause)`
 - `isGenericHttpErrorMessage(error)`
 Local functions
 - `standardErrorMessage(payload = {})`
@@ -81,27 +86,36 @@ Exports
 - `JSON_API_CONTENT_TYPE`
 - `isJsonApiResourceTransport(transport = null)`
 - `normalizeJsonApiClientTransport(transport = null)`
-- `encodeJsonApiResourceRequestBody(body, transport = null)`
-- `encodeJsonApiResourceQuery(query, transport = null)`
+- `encodeJsonApiResourceRequestBody(body, normalizedTransport)`
+- `encodeJsonApiResourceQuery(query, normalizedTransport)`
 - `decodeJsonApiResourceResponse(payload, transport = null)`
-- `decodeJsonApiErrorFieldErrors(payload = {})`
-- `createJsonApiClientErrorPayload(payload = {})`
+- `decodeJsonApiResourceDocument(payload, normalizedTransport)`
+- `buildJsonApiClientErrorPayload(payload = {})`
+- `type JsonApiClientTransport`
 Local functions
 - `normalizeTransportKind(transport = null)`
 - `defaultEncodeAttributes(body = {})`
-- `createIncludedResourceIndex(document = {})`
-- `simplifyRelationshipResource(linkage = {}, options = {})`
-- `simplifyResourceObject(resource = {}, options = {})`
-- `assertPrimaryDataType(resource = {}, expectedType = "")`
+- `createIncludedResourceIndex(document)`
+- `simplifyRelationshipResource(linkage, options)`
+- `simplifyResourceObject(resource, options)`
+- `assertPrimaryDataType(resource, expectedType = "")`
 - `resolveCollectionPageMeta(document = {})`
 - `decodeJsonApiErrorFields(payload = {})`
 
+### `src/shared/clientRuntime/responseBody.js`
+Exports
+- `emitNdjsonLine(line, handlers)`
+- `parseJsonSafely(response, signal)`
+- `readNdjsonStream(response, handlers)`
+- `readNdjsonText(response, handlers)`
+- `type NdjsonHandlers`
+
 ### `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 = [])`
+- `toUpperStringSet(values)`
 
 ### `src/shared/index.js`
 Exports
@@ -114,7 +128,7 @@ Exports
 - `apiValidationErrorTransportSchema`
 - `fastifyDefaultErrorTransportSchema`
 - `STANDARD_ERROR_STATUS_CODES`
-- `createTransportResponseSchema`
+- `buildTransportResponseSchema`
 - `withStandardErrorResponses`
 - `validateOperationSection`
 - `JSON_API_CONTENT_TYPE`
@@ -127,6 +141,7 @@ Exports
 - `isJsonApiErrorDocument`
 - `isJsonApiResourceDocument`
 - `isJsonContentType`
+- `jsonApiNextCursor`
 - `normalizeJsonApiDocument`
 - `normalizeJsonApiResourceObject`
 - `resolveJsonApiTransportTypes`
@@ -138,7 +153,9 @@ Exports
 - `isJsonApiDataResult`
 - `isJsonApiDocumentResult`
 - `isJsonApiMetaResult`
-- `unwrapJsonApiResult`
+- `jsonApiResultValue`
+- `simplifyJsonApiResult`
+- `jsonApiResultOrNull`
 - `JSON_API_QUERY_PAGE_CURSOR_KEY`
 - `JSON_API_QUERY_PAGE_LIMIT_KEY`
 - `JSON_API_QUERY_INCLUDE_KEY`
@@ -147,19 +164,18 @@ Exports
 - `mapTransportQueryKeyToPlainKey`
 - `encodeJsonApiResourceQueryObject`
 - `decodeJsonApiResourceQueryObject`
-- `createJsonApiResourceQueryTransportSchema`
+- `buildJsonApiResourceQueryTransportSchema`
 - `decodeJsonApiResourceResponse`
 - `JSON_API_ERROR_DOCUMENT_SCHEMA`
-- `createJsonApiResourceObjectTransportSchema`
-- `createJsonApiResourceRequestBodyTransportSchema`
-- `createJsonApiResourceSuccessTransportSchema`
+- `buildJsonApiResourceObjectTransportSchema`
+- `buildJsonApiResourceRequestBodyTransportSchema`
+- `buildJsonApiResourceSuccessTransportSchema`
 - `withJsonApiErrorResponses`
 - `createJsonApiResourceRouteTransport`
 - `createJsonApiResourceRouteContract`
 
 ### `src/shared/support/fieldErrors.js`
 Exports
-- `isRecord`
 - `normalizeFieldErrors(value)`
 - `resolveFieldErrors(value = null)`
 
@@ -179,7 +195,7 @@ Exports
 - `apiValidationErrorTransportSchema`
 - `fastifyDefaultErrorTransportSchema`
 - `STANDARD_ERROR_STATUS_CODES`
-- `createTransportResponseSchema(schema = {})`
+- `buildTransportResponseSchema(schema = {})`
 - `withStandardErrorResponses(successResponses, { includeValidation400 = false } = {})`
 
 ### `src/shared/validators/jsonApiQueryTransport.js`
@@ -192,15 +208,31 @@ Exports
 - `mapTransportQueryKeyToPlainKey(key = "", { responseType = "" } = {})`
 - `encodeJsonApiResourceQueryObject(query = {}, { responseType = "" } = {})`
 - `decodeJsonApiResourceQueryObject(query = {}, { responseType = "" } = {})`
-- `createJsonApiResourceQueryTransportSchema({ query, responseType = "" } = {})`
+- `buildJsonApiResourceQueryTransportSchema({ query, responseType = "" } = {})`
 Local functions
-- `normalizeQueryKey(key = "")`
 - `buildFieldsTransportKey(responseType = "")`
 - `parseFieldsTransportType(key = "")`
 - `addJsonApiFieldset(fieldsets, type = "", value = [])`
-- `createJsonApiFieldsTransportValueSchema()`
+- `buildJsonApiFieldsTransportValueSchema()`
 - `normalizeTransportQueryScalar(value)`
 
+### `src/shared/validators/jsonApiResourceSchemas.js`
+Exports
+- `JSON_API_ERROR_DOCUMENT_SCHEMA`
+- `resolveRouteTypes(value = {})`
+- `buildJsonApiResourceObjectTransportSchema({ type = "", attributes, requireId = true, includeLinks = false, includeMeta = false, // readable-check: allow dependency-default - data: a list of attribute keys, not a collaborator excludeAttributeKeys = [], // readable-check: allow dependency-default - data: a list of relationship entries, not a collaborator relationshipEntries = [], relationshipMembersRequired = false, allowSparseFields = false })`
+- `buildJsonApiResourceRequestBodyTransportSchema({ type = "", attributes, requireId = false, // readable-check: allow dependency-default - data: a list of attribute keys, not a collaborator excludeAttributeKeys = [], // readable-check: allow dependency-default - data: a list of relationship entries, not a collaborator relationshipEntries = [] })`
+- `buildJsonApiResourceSuccessTransportSchema({ type = "", attributes, kind = "record", includeLinks = false, includeMeta = false, includeIncluded = false, allowSparseFields = false, // readable-check: allow dependency-default - data: a list of attribute keys, not a collaborator excludeAttributeKeys = [], // readable-check: allow dependency-default - data: a list of relationship entries, not a collaborator relationshipEntries = [] })`
+- `withJsonApiErrorResponses(successResponses, { includeValidation400 = false } = {})`
+Local functions
+- `resolveRouteType(type = "")`
+- `resolveEmbeddedAttributesTransportSchema(definition, { context = "JSON:API resource", defaultMode = "replace", removeId = false, removeKeys = [], allowSparseFields = false } = {})`
+- `normalizeRelationshipSchemaEntries(entries = [])`
+- `buildJsonApiRelationshipDataSchema(relationshipType = "", { many = false, nullable = false } = {})`
+- `buildJsonApiRelationshipsTransportSchema(entries = [], { includeRequired = false } = {})`
+- `buildResourceObjectTransportSchema({ normalizedType, attributes, requireId, includeLinks, includeMeta, excludeAttributeKeys, relationshipEntries, relationshipMembersRequired, allowSparseFields })`
+- `buildJsonApiMetaSuccessTransportSchema({ meta } = {})`
+
 ### `src/shared/validators/jsonApiResult.js`
 Exports
 - `JSON_API_RESULT_MARKER`
@@ -211,7 +243,9 @@ Exports
 - `isJsonApiDataResult(value)`
 - `isJsonApiDocumentResult(value)`
 - `isJsonApiMetaResult(value)`
-- `unwrapJsonApiResult(value)`
+- `jsonApiResultValue(value)`
+- `simplifyJsonApiResult(result)`
+- `jsonApiResultOrNull(value)`
 Local functions
 - `normalizeJsonApiResultKind(kind = "")`
 - `createJsonApiResult(kind, value)`
@@ -219,28 +253,19 @@ Local functions
 
 ### `src/shared/validators/jsonApiRouteTransport.js`
 Exports
-- `JSON_API_ERROR_DOCUMENT_SCHEMA`
-- `createJsonApiResourceObjectTransportSchema({ type = "", attributes, requireId = true, includeLinks = false, includeMeta = false, excludeAttributeKeys = [], relationshipEntries = [], relationshipMembersRequired = false, allowSparseFields = false } = {})`
-- `createJsonApiResourceRequestBodyTransportSchema({ type = "", attributes, requireId = false, excludeAttributeKeys = [], relationshipEntries = [] } = {})`
-- `createJsonApiResourceSuccessTransportSchema({ type = "", attributes, kind = "record", includeLinks = false, includeMeta = false, includeIncluded = false, allowSparseFields = false, excludeAttributeKeys = [], relationshipEntries = [] } = {})`
-- `withJsonApiErrorResponses(successResponses, { includeValidation400 = false } = {})`
-- `createJsonApiResourceRouteTransport({ type = "", requestType = "", responseType = "", query = null, allowBodyId = false, successKind = "record", pointerPrefix = "/data/attributes", mapRequestRelationships = null, getRecordType = null, getRecordId = null, getRecordAttributes = null, getRecordRelationships = null, getRecordLinks = null, getRecordMeta = null, getIncluded = null, getDocumentLinks = null, getDocumentMeta = null, getCollectionItems = null } = {})`
-- `createJsonApiResourceRouteContract({ type = "", requestType = "", responseType = "", body = null, query = null, output = null, outputKind = "record", successStatus = 200, includeValidation400 = false, allowSparseFields = false, allowBodyId = false, pointerPrefix = "/data/attributes", bodyAttributeExcludeKeys = [], outputAttributeExcludeKeys = [], bodyRelationshipEntries = [], outputRelationshipEntries = [], getRecordType = null, getRecordId = null, getRecordAttributes = null, getRecordRelationships = null, getRecordLinks = null, getRecordMeta = null, getIncluded = null, getDocumentLinks = null, getDocumentMeta = null, getCollectionItems = null, mapRequestRelationships = null } = {})`
+- `createJsonApiResourceRouteTransport({ type = "", requestType = "", responseType = "", query, allowBodyId = false, successKind = "record", pointerPrefix = "/data/attributes", mapRequestRelationships, getRecordType, getRecordId, getRecordAttributes, getRecordRelationships, getRecordLinks, getRecordMeta, getIncluded, getDocumentLinks, getDocumentMeta, getCollectionItems })`
+- `createJsonApiResourceRouteContract({ type = "", requestType = "", responseType = "", body, query, output, outputKind = "record", successStatus = 200, includeValidation400 = false, allowSparseFields = false, allowBodyId = false, pointerPrefix = "/data/attributes", // readable-check: allow dependency-default - data: a list of attribute keys, not a collaborator bodyAttributeExcludeKeys = [], // readable-check: allow dependency-default - data: a list of attribute keys, not a collaborator outputAttributeExcludeKeys = [], // readable-check: allow dependency-default - data: a list of relationship entries, not a collaborator bodyRelationshipEntries = [], // readable-check: allow dependency-default - data: a list of relationship entries, not a collaborator outputRelationshipEntries = [], getRecordType, getRecordId, getRecordAttributes, getRecordRelationships, getRecordLinks, getRecordMeta, getIncluded, getDocumentLinks, getDocumentMeta, getCollectionItems, mapRequestRelationships })`
+- `type JsonApiRouteHook`
 Local functions
-- `createJsonApiTransportError(statusCode, message, code, params = {})`
-- `resolveRouteType(type = "")`
-- `resolveRouteTypes(value = {})`
-- `resolveEmbeddedAttributesTransportSchema(definition, { context = "JSON:API resource", defaultMode = "replace", removeId = false, removeKeys = [], allowSparseFields = false } = {})`
-- `normalizeRelationshipSchemaEntries(entries = [])`
-- `createJsonApiRelationshipDataSchema(relationshipType = "", { many = false, nullable = false } = {})`
-- `createJsonApiRelationshipsTransportSchema(entries = [], { includeRequired = false } = {})`
-- `createJsonApiMetaSuccessTransportSchema({ meta } = {})`
+- `buildJsonApiTransportError(statusCode, message, code, params = {})`
 - `defaultRecordTypeResolver(type)`
-- `defaultRecordIdResolver(record = {})`
-- `defaultRecordAttributesResolver(record = {})`
+- `defaultRecordIdResolver(record)`
+- `defaultRecordAttributesResolver(record)`
 - `defaultCollectionItemsResolver(payload)`
 - `defaultCollectionMetaResolver(payload)`
+- `resolveNothing()`
 - `assertJsonApiSuccessResult(payload)`
+- `buildRouteTransport({ types: { requestType: normalizedRequestType, responseType: normalizedResponseType }, successKind: normalizedSuccessKind, query, allowBodyId, pointerPrefix, hooks: { mapRequestRelationships, getRecordType, getRecordId, getRecordAttributes, getRecordRelationships, getRecordLinks, getRecordMeta, getIncluded, getDocumentLinks, getDocumentMeta, getCollectionItems } })`
 
 ### `src/shared/validators/jsonApiTransport.js`
 Exports
@@ -255,6 +280,7 @@ Exports
 - `isJsonApiErrorDocument(payload = {})`
 - `isJsonApiResourceDocument(payload = {})`
 - `isJsonContentType(contentType = "")`
+- `jsonApiNextCursor(document)`
 - `normalizeCodedEntry(entry)`
 - `normalizeJsonApiDocument(payload = {})`
 - `normalizeJsonApiResourceObject(resource = {})`
@@ -266,9 +292,9 @@ Local functions
 - `normalizeJsonApiMeta(value)`
 - `normalizeJsonApiErrors(value)`
 - `escapeJsonPointerSegment(value = "")`
-- `resolveValidationFieldName(issue = {})`
+- `resolveValidationFieldName(issue)`
 - `resolveJsonApiValidationSource(issue = {}, validationContext = "")`
-- `createJsonApiErrorMeta({ transactionOutcome, params, messageCode, messageParams, fieldErrorCode })`
+- `buildJsonApiErrorMeta({ transactionOutcome, params, messageCode, messageParams, fieldErrorCode })`
 - `simplifyJsonApiResourceObject(resource = {})`
 
 ### `src/shared/validators/operationValidation.js`
@@ -278,11 +304,7 @@ Local functions
 - `resolveOperationSection(operation = {}, section = "body")`
 - `isFieldValidationError(error)`
 
-### `src/shared/validators/schemaUtils.js`
-Exports
-- `asSchemaDefinition(value, label, defaultMode, { required = true } = {})`
-
 ### `src/shared/validators/transportSchemaEmbedding.js`
 Exports
 - `rewriteEmbeddedTransportSchemaRefs(value, { rootRef = "#", definitionRefByName = {} } = {})`
-- `createEmbeddableTransportSchemaDocument(schemaDocument = {}, rootDefinitionName = "TransportSchema")`
+- `createEmbeddableTransportSchemaDocument(schemaDocument, rootDefinitionName = "TransportSchema")`

package/reference/autogen/packages/json-rest-api-core.md

@@ -16,34 +16,37 @@ Use this on demand; do not load the full index at startup.
 
 ### `src/server/jsonRestApiHost.js`
 Exports
-- `JSON_REST_AUTOFILTER_PRESETS`
 - `addResourceIfMissing(api, scopeName, resourceConfig)`
 - `buildJsonRestQueryParams(resourceType = "", query = {}, { include = undefined } = {})`
-- `createJsonRestResourceScopeOptions(resource = {}, { writeSerializers = {}, normalizeId = null, rowPolicy = undefined, searchSchema = null, queryFields = null } = {})`
+- `createJsonRestResourceScopeOptions(resource = {}, { writeSerializers = {}, normalizeId, rowPolicy, searchSchema, queryFields } = {})`
 - `createJsonRestContext(context = null)`
 - `extractJsonRestCollectionRows(payload)`
-- `isJsonRestResourceMissingError(error = null)`
 - `returnNullWhenJsonRestResourceMissing(run)`
 - `returnBadRequestWhenJsonRestFieldsetInvalid(run)`
 - `resolveWorkspaceScopeValue(context = null)`
 - `resolveUserScopeValue(context = null)`
-- `createJsonRestApiHost({ knex, logger = JSON_REST_DEFAULT_LOGGER })`
+- `createJsonRestApiHost({ knex, logger })`
 Local functions
 - `isPlainJsonRestObject(value)`
 - `cloneJsonRestResourceValue(value, { writeSerializers = {} } = {})`
 - `normalizeScopeValue(value)`
-- `normalizeJsonRestText(value, { fallback = "" } = {})`
 - `normalizeJsonRestFilterValue(value)`
-- `normalizeJsonRestObject(value)`
 - `normalizeJsonRestList(value)`
-- `resolveJsonRestCollectionRelationships(resource = {})`
+- `resolveJsonRestCollectionRelationships(resource)`
 - `normalizeJsonRestQueryField(fieldName = "", fieldDefinition = {}, projectionDefinition = null)`
 - `isJsonRestVirtualField(fieldDefinition = null)`
 - `applyJsonRestQueryFields(scopeOptions = {}, extraQueryFields = {})`
-- `resolveJsonRestDefaultExcludedFields(resource = {})`
+- `resolveJsonRestDefaultExcludedFields(resource)`
 - `applyJsonRestDefaultExclusions(scopeOptions = {}, resource = {})`
+- `workspaceScopeOwnerId(visibilityContext)`
+- `isJsonRestResourceMissingError(error = null)`
 - `isJsonRestSparseFieldError(error = null)`
 
 ### `src/server/JsonRestApiProvider.js`
 Exports
 - `JsonRestApiProvider`
+
+### `src/server/types.js`
+Exports
+- `type RuntimeJsonRestApi`
+- `type JsonRestResource`