@segmentstream/ontology 0.0.0-stage → 0.92.1
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/LICENSE +201 -0
- package/NOTICE +2 -0
- package/README.md +1655 -2
- package/dist/action.d.ts +193 -0
- package/dist/action.js +41 -0
- package/dist/agent-chat.d.ts +44 -0
- package/dist/agent-chat.js +91 -0
- package/dist/agent-task-contract.d.ts +64 -0
- package/dist/agent-task-contract.js +15 -0
- package/dist/agent-task.d.ts +39 -0
- package/dist/agent-task.js +112 -0
- package/dist/analyze.d.ts +215 -0
- package/dist/analyze.js +2438 -0
- package/dist/app-feedback.d.ts +167 -0
- package/dist/app-feedback.js +176 -0
- package/dist/authoring-input.d.ts +3 -0
- package/dist/authoring-input.js +107 -0
- package/dist/authoring-names.d.ts +4 -0
- package/dist/authoring-names.js +13 -0
- package/dist/authoring-records.d.ts +35 -0
- package/dist/authoring-records.js +264 -0
- package/dist/authoring.d.ts +15 -0
- package/dist/authoring.js +331 -0
- package/dist/bin/check.d.ts +30 -0
- package/dist/bin/check.js +99 -0
- package/dist/bin/load.d.ts +48 -0
- package/dist/bin/load.js +139 -0
- package/dist/bin/main.d.ts +31 -0
- package/dist/bin/main.js +121 -0
- package/dist/bin/migrate.d.ts +57 -0
- package/dist/bin/migrate.js +170 -0
- package/dist/bin/output.d.ts +31 -0
- package/dist/bin/output.js +84 -0
- package/dist/bin.d.ts +2 -0
- package/dist/bin.js +31 -0
- package/dist/blob.d.ts +52 -0
- package/dist/blob.js +87 -0
- package/dist/channel-session.d.ts +16 -0
- package/dist/channel-session.js +16 -0
- package/dist/chat.d.ts +43 -0
- package/dist/chat.js +34 -0
- package/dist/confirmation.d.ts +46 -0
- package/dist/confirmation.js +41 -0
- package/dist/connection.d.ts +213 -0
- package/dist/connection.js +289 -0
- package/dist/deployment.d.ts +35 -0
- package/dist/deployment.js +76 -0
- package/dist/diagnostics.d.ts +27 -0
- package/dist/diagnostics.js +106 -0
- package/dist/emails.d.ts +70 -0
- package/dist/emails.js +221 -0
- package/dist/entity.d.ts +331 -0
- package/dist/entity.js +153 -0
- package/dist/errors.d.ts +154 -0
- package/dist/errors.js +109 -0
- package/dist/feedback-config.d.ts +24 -0
- package/dist/feedback-config.js +126 -0
- package/dist/files.d.ts +39 -0
- package/dist/files.js +4 -0
- package/dist/groups.d.ts +95 -0
- package/dist/groups.js +280 -0
- package/dist/index.d.ts +109 -0
- package/dist/index.js +70 -0
- package/dist/internal/diagnostics.js +594 -0
- package/dist/legacy.d.ts +160 -0
- package/dist/legacy.js +270 -0
- package/dist/manifest-compatibility.d.ts +8 -0
- package/dist/manifest-compatibility.js +87 -0
- package/dist/manifest.d.ts +3329 -0
- package/dist/manifest.js +757 -0
- package/dist/me.d.ts +46 -0
- package/dist/me.js +109 -0
- package/dist/metric-filters.d.ts +48 -0
- package/dist/metric-filters.js +252 -0
- package/dist/metric-routes.d.ts +132 -0
- package/dist/metric-routes.js +498 -0
- package/dist/metric.d.ts +172 -0
- package/dist/metric.js +132 -0
- package/dist/migrate/apply.d.ts +94 -0
- package/dist/migrate/apply.js +526 -0
- package/dist/migrate/errors.d.ts +46 -0
- package/dist/migrate/errors.js +38 -0
- package/dist/migrate/index.d.ts +10 -0
- package/dist/migrate/index.js +7 -0
- package/dist/migrate/model.d.ts +2311 -0
- package/dist/migrate/model.js +148 -0
- package/dist/migrate/plan.d.ts +51 -0
- package/dist/migrate/plan.js +1856 -0
- package/dist/migrate/preview.d.ts +13 -0
- package/dist/migrate/preview.js +65 -0
- package/dist/migrate/storage.d.ts +226 -0
- package/dist/migrate/storage.js +774 -0
- package/dist/model-metrics.d.ts +22 -0
- package/dist/model-metrics.js +545 -0
- package/dist/names.d.ts +49 -0
- package/dist/names.js +110 -0
- package/dist/navigation-artifact.d.ts +13 -0
- package/dist/navigation-artifact.js +11 -0
- package/dist/navigation-catalog.d.ts +55 -0
- package/dist/navigation-catalog.js +297 -0
- package/dist/nitro-navigation.d.ts +3 -0
- package/dist/nitro-navigation.js +64 -0
- package/dist/nitro-workflows.d.ts +108 -0
- package/dist/nitro-workflows.js +286 -0
- package/dist/nitro.d.ts +40 -0
- package/dist/nitro.js +50 -0
- package/dist/ontology.d.ts +41 -0
- package/dist/ontology.js +46 -0
- package/dist/permissions.d.ts +198 -0
- package/dist/permissions.js +272 -0
- package/dist/property.d.ts +188 -0
- package/dist/property.js +301 -0
- package/dist/query.d.ts +245 -0
- package/dist/query.js +615 -0
- package/dist/relationship.d.ts +99 -0
- package/dist/relationship.js +33 -0
- package/dist/render.d.ts +81 -0
- package/dist/render.js +512 -0
- package/dist/replication/baseline.d.ts +51 -0
- package/dist/replication/baseline.js +215 -0
- package/dist/replication/bigquery.d.ts +37 -0
- package/dist/replication/bigquery.js +211 -0
- package/dist/replication/coverage.d.ts +14 -0
- package/dist/replication/coverage.js +53 -0
- package/dist/replication/evolution.d.ts +25 -0
- package/dist/replication/evolution.js +184 -0
- package/dist/replication/identities.d.ts +6 -0
- package/dist/replication/identities.js +47 -0
- package/dist/replication/legacy-baseline.d.ts +27 -0
- package/dist/replication/legacy-baseline.js +109 -0
- package/dist/replication/legacy-store.d.ts +19 -0
- package/dist/replication/legacy-store.js +63 -0
- package/dist/replication/lineage.d.ts +36 -0
- package/dist/replication/lineage.js +72 -0
- package/dist/replication/migrate.d.ts +21 -0
- package/dist/replication/migrate.js +84 -0
- package/dist/replication/model.d.ts +52 -0
- package/dist/replication/model.js +99 -0
- package/dist/replication/scans.d.ts +34 -0
- package/dist/replication/scans.js +158 -0
- package/dist/replication/schema.d.ts +11 -0
- package/dist/replication/schema.js +226 -0
- package/dist/replication/shadow-schema.d.ts +4 -0
- package/dist/replication/shadow-schema.js +61 -0
- package/dist/replication/shadow.d.ts +127 -0
- package/dist/replication/shadow.js +614 -0
- package/dist/replication/source-replacement.d.ts +33 -0
- package/dist/replication/source-replacement.js +76 -0
- package/dist/replication/store.d.ts +36 -0
- package/dist/replication/store.js +382 -0
- package/dist/replication/transaction.d.ts +23 -0
- package/dist/replication/transaction.js +88 -0
- package/dist/role.d.ts +61 -0
- package/dist/role.js +76 -0
- package/dist/runtime/action-deadlocks.d.ts +21 -0
- package/dist/runtime/action-deadlocks.js +130 -0
- package/dist/runtime/action-transactions.d.ts +35 -0
- package/dist/runtime/action-transactions.js +54 -0
- package/dist/runtime/agent-counters.d.ts +26 -0
- package/dist/runtime/agent-counters.js +98 -0
- package/dist/runtime/agent-tasks.d.ts +63 -0
- package/dist/runtime/agent-tasks.js +120 -0
- package/dist/runtime/agents.d.ts +15 -0
- package/dist/runtime/agents.js +457 -0
- package/dist/runtime/batch-diagnostics.d.ts +22 -0
- package/dist/runtime/batch-diagnostics.js +89 -0
- package/dist/runtime/batch.d.ts +52 -0
- package/dist/runtime/batch.js +534 -0
- package/dist/runtime/channel-session-revocation.d.ts +3 -0
- package/dist/runtime/channel-session-revocation.js +5 -0
- package/dist/runtime/channel-sessions.d.ts +4 -0
- package/dist/runtime/channel-sessions.js +61 -0
- package/dist/runtime/confirmations.d.ts +29 -0
- package/dist/runtime/confirmations.js +57 -0
- package/dist/runtime/cursor.d.ts +23 -0
- package/dist/runtime/cursor.js +100 -0
- package/dist/runtime/deployment.d.ts +7 -0
- package/dist/runtime/deployment.js +4 -0
- package/dist/runtime/errors.d.ts +118 -0
- package/dist/runtime/errors.js +109 -0
- package/dist/runtime/federation-tables.d.ts +2 -0
- package/dist/runtime/federation-tables.js +20 -0
- package/dist/runtime/federation.d.ts +42 -0
- package/dist/runtime/federation.js +222 -0
- package/dist/runtime/files.d.ts +39 -0
- package/dist/runtime/files.js +44 -0
- package/dist/runtime/generated-actions.d.ts +37 -0
- package/dist/runtime/generated-actions.js +307 -0
- package/dist/runtime/history.d.ts +91 -0
- package/dist/runtime/history.js +77 -0
- package/dist/runtime/ids.d.ts +6 -0
- package/dist/runtime/ids.js +39 -0
- package/dist/runtime/member-tables.d.ts +8 -0
- package/dist/runtime/member-tables.js +33 -0
- package/dist/runtime/member-writes.d.ts +78 -0
- package/dist/runtime/member-writes.js +202 -0
- package/dist/runtime/metric-query.d.ts +19 -0
- package/dist/runtime/metric-query.js +411 -0
- package/dist/runtime/model.d.ts +67 -0
- package/dist/runtime/model.js +150 -0
- package/dist/runtime/new-user-hook.d.ts +6 -0
- package/dist/runtime/new-user-hook.js +37 -0
- package/dist/runtime/oauth.d.ts +9 -0
- package/dist/runtime/oauth.js +299 -0
- package/dist/runtime/pipeline.d.ts +155 -0
- package/dist/runtime/pipeline.js +597 -0
- package/dist/runtime/postgres-tls.d.ts +10 -0
- package/dist/runtime/postgres-tls.js +14 -0
- package/dist/runtime/principals.d.ts +302 -0
- package/dist/runtime/principals.js +1307 -0
- package/dist/runtime/reads.d.ts +55 -0
- package/dist/runtime/reads.js +313 -0
- package/dist/runtime/records.d.ts +42 -0
- package/dist/runtime/records.js +245 -0
- package/dist/runtime/resolve-agent-identity.d.ts +6 -0
- package/dist/runtime/resolve-agent-identity.js +181 -0
- package/dist/runtime/service-binding.d.ts +18 -0
- package/dist/runtime/service-binding.js +266 -0
- package/dist/runtime/sign-in-links.d.ts +68 -0
- package/dist/runtime/sign-in-links.js +147 -0
- package/dist/runtime/sql-runtime.d.ts +131 -0
- package/dist/runtime/sql-runtime.js +362 -0
- package/dist/runtime/statement.d.ts +18 -0
- package/dist/runtime/statement.js +31 -0
- package/dist/runtime/user-identities.d.ts +66 -0
- package/dist/runtime/user-identities.js +106 -0
- package/dist/runtime/user-identity-sql.d.ts +86 -0
- package/dist/runtime/user-identity-sql.js +297 -0
- package/dist/runtime/user-roles.d.ts +16 -0
- package/dist/runtime/user-roles.js +32 -0
- package/dist/runtime/validation.d.ts +16 -0
- package/dist/runtime/validation.js +26 -0
- package/dist/runtime/where.d.ts +57 -0
- package/dist/runtime/where.js +404 -0
- package/dist/runtime/workflow-admission.d.ts +49 -0
- package/dist/runtime/workflow-admission.js +92 -0
- package/dist/runtime/workflow-argument-codec.d.ts +10 -0
- package/dist/runtime/workflow-argument-codec.js +120 -0
- package/dist/runtime/workflow-arguments.d.ts +17 -0
- package/dist/runtime/workflow-arguments.js +99 -0
- package/dist/runtime/workflow-starts.d.ts +203 -0
- package/dist/runtime/workflow-starts.js +493 -0
- package/dist/runtime/workflow-users.d.ts +9 -0
- package/dist/runtime/workflow-users.js +17 -0
- package/dist/runtime/workload.d.ts +25 -0
- package/dist/runtime/workload.js +24 -0
- package/dist/runtime/writes.d.ts +108 -0
- package/dist/runtime/writes.js +491 -0
- package/dist/runtime-source.d.ts +22 -0
- package/dist/runtime-source.js +28 -0
- package/dist/runtime.d.ts +310 -0
- package/dist/runtime.js +31 -0
- package/dist/server.d.ts +23 -0
- package/dist/server.js +107 -0
- package/dist/service/agent/attachments.d.ts +33 -0
- package/dist/service/agent/attachments.js +228 -0
- package/dist/service/agent/authentication.d.ts +22 -0
- package/dist/service/agent/authentication.js +58 -0
- package/dist/service/agent/confirmations.d.ts +5 -0
- package/dist/service/agent/confirmations.js +73 -0
- package/dist/service/agent/conversation-routes.d.ts +14 -0
- package/dist/service/agent/conversation-routes.js +45 -0
- package/dist/service/agent/conversations.d.ts +40 -0
- package/dist/service/agent/conversations.js +69 -0
- package/dist/service/agent/files.d.ts +12 -0
- package/dist/service/agent/files.js +69 -0
- package/dist/service/agent/protocol.d.ts +90 -0
- package/dist/service/agent/protocol.js +114 -0
- package/dist/service/agent/server.d.ts +28 -0
- package/dist/service/agent/server.js +374 -0
- package/dist/service/agent/task-caller.d.ts +21 -0
- package/dist/service/agent/task-caller.js +35 -0
- package/dist/service/agent/task-start.d.ts +53 -0
- package/dist/service/agent/task-start.js +161 -0
- package/dist/service/agent/tasks.d.ts +40 -0
- package/dist/service/agent/tasks.js +155 -0
- package/dist/service/api.d.ts +50 -0
- package/dist/service/api.js +288 -0
- package/dist/service/authentication.d.ts +227 -0
- package/dist/service/authentication.js +767 -0
- package/dist/service/caller-context.d.ts +24 -0
- package/dist/service/caller-context.js +6 -0
- package/dist/service/catalog.d.ts +42 -0
- package/dist/service/catalog.js +66 -0
- package/dist/service/channel/provider.d.ts +10 -0
- package/dist/service/channel/provider.js +1 -0
- package/dist/service/channel/providers/telegram.d.ts +18 -0
- package/dist/service/channel/providers/telegram.js +108 -0
- package/dist/service/channel/sessions.d.ts +5 -0
- package/dist/service/channel/sessions.js +53 -0
- package/dist/service/channel/sign-in.d.ts +7 -0
- package/dist/service/channel/sign-in.js +78 -0
- package/dist/service/chat/archive.d.ts +64 -0
- package/dist/service/chat/archive.js +62 -0
- package/dist/service/chat/attribution.d.ts +26 -0
- package/dist/service/chat/attribution.js +28 -0
- package/dist/service/chat/delivery.d.ts +18 -0
- package/dist/service/chat/delivery.js +251 -0
- package/dist/service/chat/diagnostics.d.ts +2 -0
- package/dist/service/chat/diagnostics.js +35 -0
- package/dist/service/chat/envelope.d.ts +96 -0
- package/dist/service/chat/envelope.js +39 -0
- package/dist/service/chat/idempotency.d.ts +19 -0
- package/dist/service/chat/idempotency.js +37 -0
- package/dist/service/chat/providers/telegram.d.ts +36 -0
- package/dist/service/chat/providers/telegram.js +133 -0
- package/dist/service/chat/reads.d.ts +25 -0
- package/dist/service/chat/reads.js +75 -0
- package/dist/service/chat/resolve.d.ts +34 -0
- package/dist/service/chat/resolve.js +150 -0
- package/dist/service/chat/routes.d.ts +23 -0
- package/dist/service/chat/routes.js +75 -0
- package/dist/service/chat/schemas.d.ts +43 -0
- package/dist/service/chat/schemas.js +31 -0
- package/dist/service/config.d.ts +218 -0
- package/dist/service/config.js +265 -0
- package/dist/service/connection-stream.d.ts +10 -0
- package/dist/service/connection-stream.js +191 -0
- package/dist/service/connections.d.ts +60 -0
- package/dist/service/connections.js +271 -0
- package/dist/service/decisions.d.ts +35 -0
- package/dist/service/decisions.js +63 -0
- package/dist/service/descriptions.d.ts +8 -0
- package/dist/service/descriptions.js +20 -0
- package/dist/service/discovery-schemas.d.ts +92 -0
- package/dist/service/discovery-schemas.js +59 -0
- package/dist/service/discovery-search.d.ts +30 -0
- package/dist/service/discovery-search.js +95 -0
- package/dist/service/discovery.d.ts +37 -0
- package/dist/service/discovery.js +436 -0
- package/dist/service/docs.d.ts +9 -0
- package/dist/service/docs.js +197 -0
- package/dist/service/errors.d.ts +145 -0
- package/dist/service/errors.js +704 -0
- package/dist/service/federation-provider.d.ts +36 -0
- package/dist/service/federation-provider.js +110 -0
- package/dist/service/federation-server.d.ts +20 -0
- package/dist/service/federation-server.js +249 -0
- package/dist/service/federation-status.d.ts +40 -0
- package/dist/service/federation-status.js +151 -0
- package/dist/service/handlers.d.ts +18 -0
- package/dist/service/handlers.js +287 -0
- package/dist/service/mcp/confirmation.d.ts +68 -0
- package/dist/service/mcp/confirmation.js +178 -0
- package/dist/service/mcp/find-input.d.ts +12 -0
- package/dist/service/mcp/find-input.js +122 -0
- package/dist/service/mcp/input-schema.d.ts +6 -0
- package/dist/service/mcp/input-schema.js +126 -0
- package/dist/service/mcp/listing.d.ts +26 -0
- package/dist/service/mcp/listing.js +92 -0
- package/dist/service/mcp/metric-tools.d.ts +85 -0
- package/dist/service/mcp/metric-tools.js +258 -0
- package/dist/service/mcp/request-log.d.ts +5 -0
- package/dist/service/mcp/request-log.js +53 -0
- package/dist/service/mcp/runtime-policy.d.ts +27 -0
- package/dist/service/mcp/runtime-policy.js +62 -0
- package/dist/service/mcp/server.d.ts +52 -0
- package/dist/service/mcp/server.js +861 -0
- package/dist/service/mcp/tools.d.ts +99 -0
- package/dist/service/mcp/tools.js +938 -0
- package/dist/service/member-file-routes.d.ts +22 -0
- package/dist/service/member-file-routes.js +52 -0
- package/dist/service/member-files.d.ts +245 -0
- package/dist/service/member-files.js +258 -0
- package/dist/service/metric-query-platform.d.ts +77 -0
- package/dist/service/metric-query-platform.js +198 -0
- package/dist/service/metric-query-scopes.d.ts +43 -0
- package/dist/service/metric-query-scopes.js +147 -0
- package/dist/service/metric-query.d.ts +48 -0
- package/dist/service/metric-query.js +200 -0
- package/dist/service/name-suggestions.d.ts +3 -0
- package/dist/service/name-suggestions.js +38 -0
- package/dist/service/navigation-schemas.d.ts +80 -0
- package/dist/service/navigation-schemas.js +49 -0
- package/dist/service/navigation.d.ts +20 -0
- package/dist/service/navigation.js +165 -0
- package/dist/service/oauth/protocol.d.ts +70 -0
- package/dist/service/oauth/protocol.js +157 -0
- package/dist/service/oauth/refresh-replay.d.ts +2 -0
- package/dist/service/oauth/refresh-replay.js +20 -0
- package/dist/service/oauth/server.d.ts +28 -0
- package/dist/service/oauth/server.js +769 -0
- package/dist/service/operations.d.ts +170 -0
- package/dist/service/operations.js +392 -0
- package/dist/service/plan.d.ts +57 -0
- package/dist/service/plan.js +96 -0
- package/dist/service/rate-limit.d.ts +22 -0
- package/dist/service/rate-limit.js +52 -0
- package/dist/service/record-reads.d.ts +21 -0
- package/dist/service/record-reads.js +155 -0
- package/dist/service/replication.d.ts +5 -0
- package/dist/service/replication.js +39 -0
- package/dist/service/runtime-contract.d.ts +508 -0
- package/dist/service/runtime-contract.js +18 -0
- package/dist/service/runtime-identity.d.ts +71 -0
- package/dist/service/runtime-identity.js +122 -0
- package/dist/service/schemas.d.ts +961 -0
- package/dist/service/schemas.js +639 -0
- package/dist/service/service.d.ts +21 -0
- package/dist/service/service.js +526 -0
- package/dist/service/warehouse-platform.d.ts +17 -0
- package/dist/service/warehouse-platform.js +122 -0
- package/dist/service/warehouse-query.d.ts +24 -0
- package/dist/service/warehouse-query.js +280 -0
- package/dist/service/webhooks.d.ts +106 -0
- package/dist/service/webhooks.js +233 -0
- package/dist/service/workflow-admission-provider.d.ts +31 -0
- package/dist/service/workflow-admission-provider.js +205 -0
- package/dist/service/workflow-argument-serialization.d.ts +2 -0
- package/dist/service/workflow-argument-serialization.js +14 -0
- package/dist/service/workflow-callback.d.ts +22 -0
- package/dist/service/workflow-callback.js +75 -0
- package/dist/service/workflow-deployment.d.ts +8 -0
- package/dist/service/workflow-deployment.js +131 -0
- package/dist/service/workflow-diagnostics.d.ts +23 -0
- package/dist/service/workflow-diagnostics.js +263 -0
- package/dist/service/workflow-errors.d.ts +26 -0
- package/dist/service/workflow-errors.js +181 -0
- package/dist/service/workflow-logging.d.ts +2 -0
- package/dist/service/workflow-logging.js +50 -0
- package/dist/service/workflow-queue-fence.d.ts +6 -0
- package/dist/service/workflow-queue-fence.js +66 -0
- package/dist/service/workflows.d.ts +200 -0
- package/dist/service/workflows.js +1549 -0
- package/dist/sign-in.d.ts +58 -0
- package/dist/sign-in.js +57 -0
- package/dist/source.d.ts +30 -0
- package/dist/source.js +107 -0
- package/dist/start-recovery-contract.d.ts +49 -0
- package/dist/start-recovery-contract.js +26 -0
- package/dist/start-recovery.d.ts +27 -0
- package/dist/start-recovery.js +81 -0
- package/dist/storage/api.d.ts +4 -0
- package/dist/storage/api.js +40 -0
- package/dist/storage/attachments.d.ts +146 -0
- package/dist/storage/attachments.js +733 -0
- package/dist/storage/authorization.d.ts +38 -0
- package/dist/storage/authorization.js +83 -0
- package/dist/storage/file-access.d.ts +17 -0
- package/dist/storage/file-access.js +8 -0
- package/dist/storage/limits.d.ts +12 -0
- package/dist/storage/limits.js +17 -0
- package/dist/storage/maintenance-auth.d.ts +20 -0
- package/dist/storage/maintenance-auth.js +24 -0
- package/dist/storage/maintenance.d.ts +11 -0
- package/dist/storage/maintenance.js +67 -0
- package/dist/storage/neon.d.ts +4 -0
- package/dist/storage/neon.js +318 -0
- package/dist/storage/operator.d.ts +11 -0
- package/dist/storage/operator.js +30 -0
- package/dist/storage/provider.d.ts +93 -0
- package/dist/storage/provider.js +36 -0
- package/dist/storage/sessions.d.ts +184 -0
- package/dist/storage/sessions.js +688 -0
- package/dist/storage/tables.d.ts +54 -0
- package/dist/storage/tables.js +205 -0
- package/dist/storage/transfers.d.ts +16 -0
- package/dist/storage/transfers.js +153 -0
- package/dist/storage/writes.d.ts +7 -0
- package/dist/storage/writes.js +88 -0
- package/dist/telegram.d.ts +35 -0
- package/dist/telegram.js +173 -0
- package/dist/user-identity.d.ts +28 -0
- package/dist/user-identity.js +106 -0
- package/dist/user.d.ts +75 -0
- package/dist/user.js +111 -0
- package/dist/warehouse-backed.d.ts +6 -0
- package/dist/warehouse-backed.js +495 -0
- package/dist/webhook-token.d.ts +11 -0
- package/dist/webhook-token.js +18 -0
- package/dist/webhooks.d.ts +40 -0
- package/dist/webhooks.js +55 -0
- package/dist/wire.d.ts +10 -0
- package/dist/wire.js +35 -0
- package/dist/workflow-runtime.d.ts +116 -0
- package/dist/workflow-runtime.js +109 -0
- package/dist/workflow-topics.d.ts +28 -0
- package/dist/workflow-topics.js +28 -0
- package/dist/workflow.d.ts +284 -0
- package/dist/workflow.js +259 -0
- package/dist/workflows.d.ts +24 -0
- package/dist/workflows.js +18 -0
- package/package.json +127 -4
|
@@ -0,0 +1,3329 @@
|
|
|
1
|
+
import type { ChatAttributionSettings } from "./chat.js";
|
|
2
|
+
import { Effect, Schema } from "effect";
|
|
3
|
+
import type { ResolvedConnection, ResolvedEntity } from "./analyze.js";
|
|
4
|
+
import type { ResolvedFeedback } from "./feedback-config.js";
|
|
5
|
+
import type { Role } from "./role.js";
|
|
6
|
+
import { type SignInOptions, type SignInPolicy } from "./sign-in.js";
|
|
7
|
+
/**
|
|
8
|
+
* The manifest format this SDK writes. Readers accept any version and ignore unknown fields. Version
|
|
9
|
+
* 2 replaced the actions' `allow` with `permission`, and added the roles' `permissions` and the
|
|
10
|
+
* entities' `permissions`; those fields are optional when decoding, so version 1 manifests still read.
|
|
11
|
+
* `signIn` came later within version 2 and is optional too, as are the actions' `connections` and the
|
|
12
|
+
* top-level `connections`, which are written only when an action calls a connection. Version 3 added
|
|
13
|
+
* warehouse sources and metrics. Version 4 writes snake_case names on the wire. Version 5 lets
|
|
14
|
+
* relationships target warehouse-backed entities and warehouse-backed properties declare `unique`:
|
|
15
|
+
* a relationship with a warehouse-backed end carries `on` and omits `optional` and `onDelete`.
|
|
16
|
+
* Version 6 adds the `countDistinct` metric operator and lets stored entities declare `metrics`,
|
|
17
|
+
* whose columns name the stored properties' replication view columns. Version 7 adds the avg, min,
|
|
18
|
+
* max and filtered metric operators and balanceOver on metrics. Version 8 adds the top-level
|
|
19
|
+
* `metrics`, the metrics of the model, written only when the ontology declares some: each combines
|
|
20
|
+
* metrics of entities, named `entity.metric`, with its inputs and its alignment. Version 9 adds the
|
|
21
|
+
* top-level `workflows`, written only when the ontology declares some: each names its role, its
|
|
22
|
+
* input as JSON Schema, the connections its steps call and its triggers, whose input is in wire form.
|
|
23
|
+
* Within version 9, a property may have the type `list` with its `items` type: only the built-in
|
|
24
|
+
* user's managed `roles`, which has no column.
|
|
25
|
+
* Within version 9, triggers may also be `action` and `webhook` triggers; readers ignore kinds they
|
|
26
|
+
* do not know.
|
|
27
|
+
* Version 10 adds the roles' `scopes`, written only when a role scopes some of its permissions: each
|
|
28
|
+
* names the permission and its `where` in the wire form of a query, with `me` as `{ "$me": [] }`
|
|
29
|
+
* and a path from it as `{ "$me": ["staff_member", "division"] }`. `permissions` still lists every
|
|
30
|
+
* permission the role holds, scoped or not. Version 11 adds resolved `feedback` settings and the
|
|
31
|
+
* reserved built-in `feedback_reporter` role, which is implicit for humans and never assignable.
|
|
32
|
+
* Within version 11, actions may opt in to SQL deadlock recovery with `retryOnDeadlock`; its absence
|
|
33
|
+
* disables retries and older readers may ignore it.
|
|
34
|
+
* Within version 11, the top-level `emails`, written only when the ontology declares some, holds the
|
|
35
|
+
* workspace's own emails by wire name: plain-text fields with `{{value}}` placeholders, which the
|
|
36
|
+
* platform renders when it sends a sign-in link. Older readers ignore it.
|
|
37
|
+
* Version 12 changes no field: it marks an SDK whose actions arm a recovery run for their triggers,
|
|
38
|
+
* so publication writes no sweep cron for it. For earlier versions publication keeps the
|
|
39
|
+
* five-minute sweep cron, which their service still needs.
|
|
40
|
+
* Version 13 adds optional `signIn.browser` declarations for workspace-owned browser sign-in
|
|
41
|
+
* methods, primary method, automatic redirect behavior, and local callback port.
|
|
42
|
+
* Within version 13, an entity may carry `writes: "actions"`: it has no generated writes, and its
|
|
43
|
+
* `permissions` hold only `read`, so readers that derive the generated actions from `permissions`
|
|
44
|
+
* need no change. Older readers ignore the field.
|
|
45
|
+
* Within version 13, an action may carry `writes`, the names of the entities its handler writes,
|
|
46
|
+
* which the runtime enforces; absent means it declares none. Older readers ignore the field.
|
|
47
|
+
* Version 14 gives metrics their current names: entities' and the model's `metrics`, and `metric`
|
|
48
|
+
* expression nodes (`{ op: "metric", name }`). Readers accept the earlier names, which the history
|
|
49
|
+
* above calls metrics too; `legacy.ts` names them and renames every document it decodes.
|
|
50
|
+
* Within version 14, `signIn` may carry `codeLink`, written only when declared: whether the
|
|
51
|
+
* platform's sign-in code emails also link to the app's sign-in page with the code filled in.
|
|
52
|
+
* Older readers ignore it and send the code alone.
|
|
53
|
+
* Version 15 changes no field this SDK writes. Ontology SDKs 0.86.0 to 0.88.0 introduced it with
|
|
54
|
+
* `executionCompatibility` and three workflow capabilities for a deploy guard that was withdrawn;
|
|
55
|
+
* readers ignore them.
|
|
56
|
+
*/
|
|
57
|
+
export declare const MANIFEST_VERSION = 15;
|
|
58
|
+
/** The phrase used for a direction the author did not phrase. */
|
|
59
|
+
export declare const DEFAULT_PHRASE = "has";
|
|
60
|
+
export declare const SelectOptionManifest: Schema.Struct<{
|
|
61
|
+
readonly value: Schema.String;
|
|
62
|
+
readonly label: Schema.String;
|
|
63
|
+
readonly description: Schema.String;
|
|
64
|
+
}>;
|
|
65
|
+
export declare const PropertyManifest: Schema.Struct<{
|
|
66
|
+
readonly column: Schema.optionalKey<Schema.String>;
|
|
67
|
+
readonly scope: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
68
|
+
readonly name: Schema.String;
|
|
69
|
+
readonly type: Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>;
|
|
70
|
+
readonly label: Schema.String;
|
|
71
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
72
|
+
readonly optional: Schema.Boolean;
|
|
73
|
+
readonly unique: Schema.Boolean;
|
|
74
|
+
readonly managed: Schema.Boolean;
|
|
75
|
+
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
76
|
+
readonly display: Schema.optionalKey<Schema.String>;
|
|
77
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
78
|
+
readonly min: Schema.optionalKey<Schema.Number>;
|
|
79
|
+
readonly max: Schema.optionalKey<Schema.Number>;
|
|
80
|
+
readonly maxLength: Schema.optionalKey<Schema.Number>;
|
|
81
|
+
readonly accept: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
82
|
+
readonly maxBytes: Schema.optionalKey<Schema.Number>;
|
|
83
|
+
readonly options: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
84
|
+
readonly value: Schema.String;
|
|
85
|
+
readonly label: Schema.String;
|
|
86
|
+
readonly description: Schema.String;
|
|
87
|
+
}>>>;
|
|
88
|
+
/** The item type of a `list`, the built-in user's `roles`, which has no column. */
|
|
89
|
+
readonly items: Schema.optionalKey<Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>>;
|
|
90
|
+
}>;
|
|
91
|
+
export type PropertyManifest = typeof PropertyManifest.Type;
|
|
92
|
+
/**
|
|
93
|
+
* A relationship as declared. The inverse is not repeated on the target entity: readers derive it
|
|
94
|
+
* from `to`, `inverse` and the second `phrase`.
|
|
95
|
+
*/
|
|
96
|
+
export declare const RelationshipManifest: Schema.Struct<{
|
|
97
|
+
/**
|
|
98
|
+
* The property pair of a value-matched relationship, one with a warehouse-backed end. Absent
|
|
99
|
+
* between stored entities, which use a `<name>_id` key instead.
|
|
100
|
+
*/
|
|
101
|
+
readonly on: Schema.optionalKey<Schema.Struct<{
|
|
102
|
+
readonly property: Schema.String;
|
|
103
|
+
readonly targetProperty: Schema.String;
|
|
104
|
+
}>>;
|
|
105
|
+
readonly name: Schema.String;
|
|
106
|
+
readonly to: Schema.String;
|
|
107
|
+
readonly inverse: Schema.String;
|
|
108
|
+
readonly cardinality: Schema.Literals<readonly ["one", "many"]>;
|
|
109
|
+
/** `rel.one` between stored entities only. */
|
|
110
|
+
readonly optional: Schema.optionalKey<Schema.Boolean>;
|
|
111
|
+
/**
|
|
112
|
+
* `rel.one` between stored entities only. Before version 5, warehouse → stored relationships
|
|
113
|
+
* carried it too, as `restrict`, though nothing enforced it.
|
|
114
|
+
*/
|
|
115
|
+
readonly onDelete: Schema.optionalKey<Schema.Literals<readonly ["setNull", "cascade", "restrict"]>>;
|
|
116
|
+
/** `rel.many` only. */
|
|
117
|
+
readonly ordered: Schema.optionalKey<Schema.Boolean>;
|
|
118
|
+
/** Forward and inverse phrases; unphrased directions read "has". */
|
|
119
|
+
readonly phrase: Schema.Tuple<readonly [Schema.String, Schema.String]>;
|
|
120
|
+
readonly description: Schema.String;
|
|
121
|
+
}>;
|
|
122
|
+
export type RelationshipManifest = typeof RelationshipManifest.Type;
|
|
123
|
+
/**
|
|
124
|
+
* Whether a relationship is matched by value: either end is warehouse-backed. A value-matched
|
|
125
|
+
* relationship always declares `on`; a stored → stored relationship never does. It has no
|
|
126
|
+
* `<name>_id` column, foreign key, index or traversal route.
|
|
127
|
+
*/
|
|
128
|
+
export declare function isValueMatched(relationship: {
|
|
129
|
+
readonly on?: unknown;
|
|
130
|
+
}): boolean;
|
|
131
|
+
export declare const IndexManifest: Schema.Struct<{
|
|
132
|
+
readonly properties: Schema.$Array<Schema.String>;
|
|
133
|
+
readonly unique: Schema.Boolean;
|
|
134
|
+
}>;
|
|
135
|
+
export declare const ActionManifest: Schema.Struct<{
|
|
136
|
+
readonly name: Schema.String;
|
|
137
|
+
readonly description: Schema.String;
|
|
138
|
+
/**
|
|
139
|
+
* The permission a principal needs to run the action, for example `lead:changeStatus`. Always
|
|
140
|
+
* written; absent from version 1 manifests, where it reads as `<entity>:<action name>`.
|
|
141
|
+
*/
|
|
142
|
+
readonly permission: Schema.optionalKey<Schema.String>;
|
|
143
|
+
/** JSON Schema (draft 2020-12) of the input object. */
|
|
144
|
+
readonly input: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
145
|
+
/** Opt-in SQL handler replay after a confirmed deadlock rollback; absent means disabled. */
|
|
146
|
+
readonly retryOnDeadlock: Schema.optionalKey<Schema.Boolean>;
|
|
147
|
+
/**
|
|
148
|
+
* The entities the handler writes, by name, as the action declares them; the runtime refuses any
|
|
149
|
+
* other write. Absent means it declares none and may write any entity; `[]` writes nothing.
|
|
150
|
+
*/
|
|
151
|
+
readonly writes: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
152
|
+
/**
|
|
153
|
+
* The keys of the workspace connections the action calls before its transaction. Written only
|
|
154
|
+
* when there are some; absent reads as none.
|
|
155
|
+
*/
|
|
156
|
+
readonly connections: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
157
|
+
/** File writes declared in code; absence grants preparation no staging targets. */
|
|
158
|
+
readonly files: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
159
|
+
readonly entity: Schema.String;
|
|
160
|
+
readonly property: Schema.String;
|
|
161
|
+
}>>>;
|
|
162
|
+
/**
|
|
163
|
+
* How the action behaves, as MCP tool annotations tell agents. Written only when the action
|
|
164
|
+
* declares hints; absent safety labels require agent confirmation for compatibility.
|
|
165
|
+
*/
|
|
166
|
+
readonly hints: Schema.optionalKey<Schema.Struct<{
|
|
167
|
+
readonly readOnly: Schema.optionalKey<Schema.Boolean>;
|
|
168
|
+
readonly connectionsReadOnly: Schema.optionalKey<Schema.Boolean>;
|
|
169
|
+
readonly destructive: Schema.optionalKey<Schema.Boolean>;
|
|
170
|
+
readonly irreversible: Schema.optionalKey<Schema.Boolean>;
|
|
171
|
+
readonly idempotent: Schema.optionalKey<Schema.Boolean>;
|
|
172
|
+
}>>;
|
|
173
|
+
}>;
|
|
174
|
+
export type ActionManifest = typeof ActionManifest.Type;
|
|
175
|
+
/**
|
|
176
|
+
* The permissions of an entity's reads and generated actions, so that readers need not rebuild the
|
|
177
|
+
* convention. The built-in user has only `read`; `link` and `unlink` exist with a `rel.many`. The
|
|
178
|
+
* generated `upsert_by_<property>` requires both `create` and `update`.
|
|
179
|
+
*/
|
|
180
|
+
export declare const EntityPermissionsManifest: Schema.Struct<{
|
|
181
|
+
readonly read: Schema.String;
|
|
182
|
+
readonly create: Schema.optionalKey<Schema.String>;
|
|
183
|
+
readonly update: Schema.optionalKey<Schema.String>;
|
|
184
|
+
readonly delete: Schema.optionalKey<Schema.String>;
|
|
185
|
+
readonly link: Schema.optionalKey<Schema.String>;
|
|
186
|
+
readonly unlink: Schema.optionalKey<Schema.String>;
|
|
187
|
+
}>;
|
|
188
|
+
export type EntityPermissionsManifest = typeof EntityPermissionsManifest.Type;
|
|
189
|
+
/** A metric of an entity: its metadata and the expression the platform computes. */
|
|
190
|
+
export declare const MetricManifest: Schema.Struct<{
|
|
191
|
+
readonly name: Schema.String;
|
|
192
|
+
readonly label: Schema.String;
|
|
193
|
+
readonly description: Schema.String;
|
|
194
|
+
readonly unit: Schema.Literals<readonly ["number", "currency", "ratio", "percent"]>;
|
|
195
|
+
readonly format: Schema.Literals<readonly ["decimal", "currency", "percent"]>;
|
|
196
|
+
readonly expression: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
197
|
+
/**
|
|
198
|
+
* The column of the date or timestamp property a balance metric snapshots over; absent for
|
|
199
|
+
* additive metrics and in manifests before version 7. `balance_over` on the wire.
|
|
200
|
+
*/
|
|
201
|
+
readonly balanceOver: Schema.optionalKey<Schema.String>;
|
|
202
|
+
}>;
|
|
203
|
+
export type MetricManifest = typeof MetricManifest.Type;
|
|
204
|
+
/**
|
|
205
|
+
* A metric of the model, `defineOntology({ metrics })`. Its expression is an entity metric's
|
|
206
|
+
* arithmetic whose `metric` nodes name `entity.metric`, with references to other model metrics
|
|
207
|
+
* expanded. Names are wire names throughout.
|
|
208
|
+
*/
|
|
209
|
+
export declare const ModelMetricManifest: Schema.Struct<{
|
|
210
|
+
readonly name: Schema.String;
|
|
211
|
+
readonly label: Schema.String;
|
|
212
|
+
readonly description: Schema.String;
|
|
213
|
+
readonly unit: Schema.Literals<readonly ["number", "currency", "ratio", "percent"]>;
|
|
214
|
+
readonly format: Schema.Literals<readonly ["decimal", "currency", "percent"]>;
|
|
215
|
+
readonly expression: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
216
|
+
/** The entity metrics the expression reads, `entity.metric`, each once, in reading order. */
|
|
217
|
+
readonly inputs: Schema.$Array<Schema.String>;
|
|
218
|
+
/**
|
|
219
|
+
* Groups of properties that stand for one another: each names every entity the metric reads,
|
|
220
|
+
* with a property or `null` for an entity without a counterpart.
|
|
221
|
+
*/
|
|
222
|
+
readonly align: Schema.$Array<Schema.$Record<Schema.String, Schema.NullOr<Schema.String>>>;
|
|
223
|
+
}>;
|
|
224
|
+
export type ModelMetricManifest = typeof ModelMetricManifest.Type;
|
|
225
|
+
export declare const EntityManifest: Schema.Struct<{
|
|
226
|
+
readonly source: Schema.optionalKey<Schema.Struct<{
|
|
227
|
+
readonly asset: Schema.String;
|
|
228
|
+
readonly key: Schema.$Array<Schema.String>;
|
|
229
|
+
readonly currency: Schema.optionalKey<Schema.String>;
|
|
230
|
+
}>>;
|
|
231
|
+
readonly metrics: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
232
|
+
readonly name: Schema.String;
|
|
233
|
+
readonly label: Schema.String;
|
|
234
|
+
readonly description: Schema.String;
|
|
235
|
+
readonly unit: Schema.Literals<readonly ["number", "currency", "ratio", "percent"]>;
|
|
236
|
+
readonly format: Schema.Literals<readonly ["decimal", "currency", "percent"]>;
|
|
237
|
+
readonly expression: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
238
|
+
/**
|
|
239
|
+
* The column of the date or timestamp property a balance metric snapshots over; absent for
|
|
240
|
+
* additive metrics and in manifests before version 7. `balance_over` on the wire.
|
|
241
|
+
*/
|
|
242
|
+
readonly balanceOver: Schema.optionalKey<Schema.String>;
|
|
243
|
+
}>>>;
|
|
244
|
+
readonly id: Schema.String;
|
|
245
|
+
readonly name: Schema.String;
|
|
246
|
+
readonly label: Schema.String;
|
|
247
|
+
readonly plural: Schema.String;
|
|
248
|
+
readonly title: Schema.String;
|
|
249
|
+
readonly description: Schema.String;
|
|
250
|
+
readonly builtIn: Schema.Boolean;
|
|
251
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
252
|
+
readonly guide: Schema.optionalKey<Schema.String>;
|
|
253
|
+
readonly properties: Schema.$Array<Schema.Struct<{
|
|
254
|
+
readonly column: Schema.optionalKey<Schema.String>;
|
|
255
|
+
readonly scope: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
256
|
+
readonly name: Schema.String;
|
|
257
|
+
readonly type: Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>;
|
|
258
|
+
readonly label: Schema.String;
|
|
259
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
260
|
+
readonly optional: Schema.Boolean;
|
|
261
|
+
readonly unique: Schema.Boolean;
|
|
262
|
+
readonly managed: Schema.Boolean;
|
|
263
|
+
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
264
|
+
readonly display: Schema.optionalKey<Schema.String>;
|
|
265
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
266
|
+
readonly min: Schema.optionalKey<Schema.Number>;
|
|
267
|
+
readonly max: Schema.optionalKey<Schema.Number>;
|
|
268
|
+
readonly maxLength: Schema.optionalKey<Schema.Number>;
|
|
269
|
+
readonly accept: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
270
|
+
readonly maxBytes: Schema.optionalKey<Schema.Number>;
|
|
271
|
+
readonly options: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
272
|
+
readonly value: Schema.String;
|
|
273
|
+
readonly label: Schema.String;
|
|
274
|
+
readonly description: Schema.String;
|
|
275
|
+
}>>>;
|
|
276
|
+
/** The item type of a `list`, the built-in user's `roles`, which has no column. */
|
|
277
|
+
readonly items: Schema.optionalKey<Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>>;
|
|
278
|
+
}>>;
|
|
279
|
+
readonly relationships: Schema.$Array<Schema.Struct<{
|
|
280
|
+
/**
|
|
281
|
+
* The property pair of a value-matched relationship, one with a warehouse-backed end. Absent
|
|
282
|
+
* between stored entities, which use a `<name>_id` key instead.
|
|
283
|
+
*/
|
|
284
|
+
readonly on: Schema.optionalKey<Schema.Struct<{
|
|
285
|
+
readonly property: Schema.String;
|
|
286
|
+
readonly targetProperty: Schema.String;
|
|
287
|
+
}>>;
|
|
288
|
+
readonly name: Schema.String;
|
|
289
|
+
readonly to: Schema.String;
|
|
290
|
+
readonly inverse: Schema.String;
|
|
291
|
+
readonly cardinality: Schema.Literals<readonly ["one", "many"]>;
|
|
292
|
+
/** `rel.one` between stored entities only. */
|
|
293
|
+
readonly optional: Schema.optionalKey<Schema.Boolean>;
|
|
294
|
+
/**
|
|
295
|
+
* `rel.one` between stored entities only. Before version 5, warehouse → stored relationships
|
|
296
|
+
* carried it too, as `restrict`, though nothing enforced it.
|
|
297
|
+
*/
|
|
298
|
+
readonly onDelete: Schema.optionalKey<Schema.Literals<readonly ["setNull", "cascade", "restrict"]>>;
|
|
299
|
+
/** `rel.many` only. */
|
|
300
|
+
readonly ordered: Schema.optionalKey<Schema.Boolean>;
|
|
301
|
+
/** Forward and inverse phrases; unphrased directions read "has". */
|
|
302
|
+
readonly phrase: Schema.Tuple<readonly [Schema.String, Schema.String]>;
|
|
303
|
+
readonly description: Schema.String;
|
|
304
|
+
}>>;
|
|
305
|
+
readonly indexes: Schema.$Array<Schema.Struct<{
|
|
306
|
+
readonly properties: Schema.$Array<Schema.String>;
|
|
307
|
+
readonly unique: Schema.Boolean;
|
|
308
|
+
}>>;
|
|
309
|
+
readonly actions: Schema.$Array<Schema.Struct<{
|
|
310
|
+
readonly name: Schema.String;
|
|
311
|
+
readonly description: Schema.String;
|
|
312
|
+
/**
|
|
313
|
+
* The permission a principal needs to run the action, for example `lead:changeStatus`. Always
|
|
314
|
+
* written; absent from version 1 manifests, where it reads as `<entity>:<action name>`.
|
|
315
|
+
*/
|
|
316
|
+
readonly permission: Schema.optionalKey<Schema.String>;
|
|
317
|
+
/** JSON Schema (draft 2020-12) of the input object. */
|
|
318
|
+
readonly input: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
319
|
+
/** Opt-in SQL handler replay after a confirmed deadlock rollback; absent means disabled. */
|
|
320
|
+
readonly retryOnDeadlock: Schema.optionalKey<Schema.Boolean>;
|
|
321
|
+
/**
|
|
322
|
+
* The entities the handler writes, by name, as the action declares them; the runtime refuses any
|
|
323
|
+
* other write. Absent means it declares none and may write any entity; `[]` writes nothing.
|
|
324
|
+
*/
|
|
325
|
+
readonly writes: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
326
|
+
/**
|
|
327
|
+
* The keys of the workspace connections the action calls before its transaction. Written only
|
|
328
|
+
* when there are some; absent reads as none.
|
|
329
|
+
*/
|
|
330
|
+
readonly connections: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
331
|
+
/** File writes declared in code; absence grants preparation no staging targets. */
|
|
332
|
+
readonly files: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
333
|
+
readonly entity: Schema.String;
|
|
334
|
+
readonly property: Schema.String;
|
|
335
|
+
}>>>;
|
|
336
|
+
/**
|
|
337
|
+
* How the action behaves, as MCP tool annotations tell agents. Written only when the action
|
|
338
|
+
* declares hints; absent safety labels require agent confirmation for compatibility.
|
|
339
|
+
*/
|
|
340
|
+
readonly hints: Schema.optionalKey<Schema.Struct<{
|
|
341
|
+
readonly readOnly: Schema.optionalKey<Schema.Boolean>;
|
|
342
|
+
readonly connectionsReadOnly: Schema.optionalKey<Schema.Boolean>;
|
|
343
|
+
readonly destructive: Schema.optionalKey<Schema.Boolean>;
|
|
344
|
+
readonly irreversible: Schema.optionalKey<Schema.Boolean>;
|
|
345
|
+
readonly idempotent: Schema.optionalKey<Schema.Boolean>;
|
|
346
|
+
}>>;
|
|
347
|
+
}>>;
|
|
348
|
+
/** Always written; absent from version 1 manifests. */
|
|
349
|
+
readonly permissions: Schema.optionalKey<Schema.Struct<{
|
|
350
|
+
readonly read: Schema.String;
|
|
351
|
+
readonly create: Schema.optionalKey<Schema.String>;
|
|
352
|
+
readonly update: Schema.optionalKey<Schema.String>;
|
|
353
|
+
readonly delete: Schema.optionalKey<Schema.String>;
|
|
354
|
+
readonly link: Schema.optionalKey<Schema.String>;
|
|
355
|
+
readonly unlink: Schema.optionalKey<Schema.String>;
|
|
356
|
+
}>>;
|
|
357
|
+
/**
|
|
358
|
+
* `"actions"` when only the entity's authored actions write its records, so it has no generated
|
|
359
|
+
* writes and its `permissions` hold only `read`. Absent means the generated writes exist.
|
|
360
|
+
*/
|
|
361
|
+
readonly writes: Schema.optionalKey<Schema.Literal<"actions">>;
|
|
362
|
+
}>;
|
|
363
|
+
export type EntityManifest = typeof EntityManifest.Type;
|
|
364
|
+
/**
|
|
365
|
+
* A scoped permission of a role: `<entity>:<verb>` and the `where` of the records it covers, in the
|
|
366
|
+
* wire form of a query on the entity, where `{ "$me": [...] }` stands for the caller or a path from
|
|
367
|
+
* them. Readers that do not enforce scopes may show the `where` or ignore it.
|
|
368
|
+
*/
|
|
369
|
+
export declare const ScopeManifest: Schema.Struct<{
|
|
370
|
+
readonly permission: Schema.String;
|
|
371
|
+
readonly where: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
372
|
+
}>;
|
|
373
|
+
export type ScopeManifest = typeof ScopeManifest.Type;
|
|
374
|
+
export declare const RoleManifest: Schema.Struct<{
|
|
375
|
+
readonly name: Schema.String;
|
|
376
|
+
readonly description: Schema.String;
|
|
377
|
+
readonly builtIn: Schema.Boolean;
|
|
378
|
+
/**
|
|
379
|
+
* What the role may do, wildcards included; for the built-in `member`, what every active app user
|
|
380
|
+
* may do. Always written; absent from version 1 manifests.
|
|
381
|
+
*/
|
|
382
|
+
readonly permissions: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
383
|
+
/**
|
|
384
|
+
* The permissions the role holds only for the records their `where` matches, since version 10.
|
|
385
|
+
* Written only when there are some; absent reads as none.
|
|
386
|
+
*/
|
|
387
|
+
readonly scopes: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
388
|
+
readonly permission: Schema.String;
|
|
389
|
+
readonly where: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
390
|
+
}>>>;
|
|
391
|
+
}>;
|
|
392
|
+
export type RoleManifest = typeof RoleManifest.Type;
|
|
393
|
+
/**
|
|
394
|
+
* A cron trigger of a workflow: the platform writes a Vercel cron for it, whose invocation starts the
|
|
395
|
+
* workflow with `input`, the wire form of the workflow's input, sent as it is.
|
|
396
|
+
*/
|
|
397
|
+
export declare const CronTriggerManifest: Schema.Struct<{
|
|
398
|
+
readonly kind: Schema.Literal<"cron">;
|
|
399
|
+
readonly name: Schema.String;
|
|
400
|
+
readonly description: Schema.String;
|
|
401
|
+
/** Five fields, UTC. */
|
|
402
|
+
readonly cron: Schema.String;
|
|
403
|
+
readonly input: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
404
|
+
}>;
|
|
405
|
+
export type CronTriggerManifest = typeof CronTriggerManifest.Type;
|
|
406
|
+
/**
|
|
407
|
+
* An action trigger of a workflow: the ontology service starts the workflow after an action of
|
|
408
|
+
* `entity` commits, `action` or, when it is absent, any of them. Wire names; the trigger's
|
|
409
|
+
* predicate and input mapping are code and never in the manifest.
|
|
410
|
+
*/
|
|
411
|
+
export declare const ActionTriggerManifest: Schema.Struct<{
|
|
412
|
+
readonly kind: Schema.Literal<"action">;
|
|
413
|
+
readonly name: Schema.String;
|
|
414
|
+
readonly description: Schema.String;
|
|
415
|
+
readonly entity: Schema.String;
|
|
416
|
+
readonly action: Schema.optionalKey<Schema.String>;
|
|
417
|
+
}>;
|
|
418
|
+
export type ActionTriggerManifest = typeof ActionTriggerManifest.Type;
|
|
419
|
+
/**
|
|
420
|
+
* A webhook trigger of a workflow: the ontology service starts the workflow for each genuine
|
|
421
|
+
* delivery to `/api/webhooks/<name>`. With `signature`, deliveries are checked with the provider's
|
|
422
|
+
* scheme against the named workspace secret; without it, the URL ends in a derived token.
|
|
423
|
+
* `verification` opts into a registration handshake; `headers` lists the request headers the
|
|
424
|
+
* delivery carries. Optional settings are written only when declared.
|
|
425
|
+
*/
|
|
426
|
+
export declare const WebhookTriggerManifest: Schema.Struct<{
|
|
427
|
+
readonly kind: Schema.Literal<"webhook">;
|
|
428
|
+
readonly name: Schema.String;
|
|
429
|
+
readonly description: Schema.String;
|
|
430
|
+
readonly signature: Schema.optionalKey<Schema.Struct<{
|
|
431
|
+
readonly scheme: Schema.String;
|
|
432
|
+
readonly secret: Schema.String;
|
|
433
|
+
}>>;
|
|
434
|
+
readonly verification: Schema.optionalKey<Schema.Struct<{
|
|
435
|
+
readonly scheme: Schema.String;
|
|
436
|
+
readonly verifyToken: Schema.String;
|
|
437
|
+
}>>;
|
|
438
|
+
readonly headers: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
439
|
+
}>;
|
|
440
|
+
export type WebhookTriggerManifest = typeof WebhookTriggerManifest.Type;
|
|
441
|
+
/**
|
|
442
|
+
* A trigger of a kind this reader does not know, kept as written: a manifest a later SDK built
|
|
443
|
+
* keeps its hash, and readers that present triggers drop it.
|
|
444
|
+
*/
|
|
445
|
+
export declare const OtherTriggerManifest: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
446
|
+
export type OtherTriggerManifest = typeof OtherTriggerManifest.Type;
|
|
447
|
+
/**
|
|
448
|
+
* A trigger of a workflow, by `kind`: `cron`, `action`, `webhook`, or a kind this reader keeps
|
|
449
|
+
* without knowing.
|
|
450
|
+
*/
|
|
451
|
+
export declare const WorkflowTriggerManifest: Schema.Union<readonly [Schema.Struct<{
|
|
452
|
+
readonly kind: Schema.Literal<"cron">;
|
|
453
|
+
readonly name: Schema.String;
|
|
454
|
+
readonly description: Schema.String;
|
|
455
|
+
/** Five fields, UTC. */
|
|
456
|
+
readonly cron: Schema.String;
|
|
457
|
+
readonly input: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
458
|
+
}>, Schema.Struct<{
|
|
459
|
+
readonly kind: Schema.Literal<"action">;
|
|
460
|
+
readonly name: Schema.String;
|
|
461
|
+
readonly description: Schema.String;
|
|
462
|
+
readonly entity: Schema.String;
|
|
463
|
+
readonly action: Schema.optionalKey<Schema.String>;
|
|
464
|
+
}>, Schema.Struct<{
|
|
465
|
+
readonly kind: Schema.Literal<"webhook">;
|
|
466
|
+
readonly name: Schema.String;
|
|
467
|
+
readonly description: Schema.String;
|
|
468
|
+
readonly signature: Schema.optionalKey<Schema.Struct<{
|
|
469
|
+
readonly scheme: Schema.String;
|
|
470
|
+
readonly secret: Schema.String;
|
|
471
|
+
}>>;
|
|
472
|
+
readonly verification: Schema.optionalKey<Schema.Struct<{
|
|
473
|
+
readonly scheme: Schema.String;
|
|
474
|
+
readonly verifyToken: Schema.String;
|
|
475
|
+
}>>;
|
|
476
|
+
readonly headers: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
477
|
+
}>, Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
|
|
478
|
+
export type WorkflowTriggerManifest = typeof WorkflowTriggerManifest.Type;
|
|
479
|
+
/** Whether a trigger is a cron trigger. */
|
|
480
|
+
export declare function isCronTrigger(trigger: WorkflowTriggerManifest): trigger is CronTriggerManifest;
|
|
481
|
+
/** Whether a trigger is an action trigger. */
|
|
482
|
+
export declare function isActionTrigger(trigger: WorkflowTriggerManifest): trigger is ActionTriggerManifest;
|
|
483
|
+
/** Whether a trigger is a webhook trigger. */
|
|
484
|
+
export declare function isWebhookTrigger(trigger: WorkflowTriggerManifest): trigger is WebhookTriggerManifest;
|
|
485
|
+
/**
|
|
486
|
+
* A workflow, `defineOntology({ workflows })`: a durable process the ontology service runs as the
|
|
487
|
+
* workflow's own service user holding `role`. Names are wire names; `input` is the JSON Schema of
|
|
488
|
+
* the workflow's input and `connections` the keys of the connections its steps call.
|
|
489
|
+
*/
|
|
490
|
+
export declare const WorkflowManifest: Schema.Struct<{
|
|
491
|
+
readonly name: Schema.String;
|
|
492
|
+
readonly description: Schema.String;
|
|
493
|
+
readonly role: Schema.String;
|
|
494
|
+
readonly input: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
495
|
+
readonly connections: Schema.$Array<Schema.String>;
|
|
496
|
+
readonly triggers: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
497
|
+
readonly kind: Schema.Literal<"cron">;
|
|
498
|
+
readonly name: Schema.String;
|
|
499
|
+
readonly description: Schema.String;
|
|
500
|
+
/** Five fields, UTC. */
|
|
501
|
+
readonly cron: Schema.String;
|
|
502
|
+
readonly input: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
503
|
+
}>, Schema.Struct<{
|
|
504
|
+
readonly kind: Schema.Literal<"action">;
|
|
505
|
+
readonly name: Schema.String;
|
|
506
|
+
readonly description: Schema.String;
|
|
507
|
+
readonly entity: Schema.String;
|
|
508
|
+
readonly action: Schema.optionalKey<Schema.String>;
|
|
509
|
+
}>, Schema.Struct<{
|
|
510
|
+
readonly kind: Schema.Literal<"webhook">;
|
|
511
|
+
readonly name: Schema.String;
|
|
512
|
+
readonly description: Schema.String;
|
|
513
|
+
readonly signature: Schema.optionalKey<Schema.Struct<{
|
|
514
|
+
readonly scheme: Schema.String;
|
|
515
|
+
readonly secret: Schema.String;
|
|
516
|
+
}>>;
|
|
517
|
+
readonly verification: Schema.optionalKey<Schema.Struct<{
|
|
518
|
+
readonly scheme: Schema.String;
|
|
519
|
+
readonly verifyToken: Schema.String;
|
|
520
|
+
}>>;
|
|
521
|
+
readonly headers: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
522
|
+
}>, Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>>;
|
|
523
|
+
}>;
|
|
524
|
+
export type WorkflowManifest = typeof WorkflowManifest.Type;
|
|
525
|
+
/** A workspace connection the ontology's actions call, by its key in `connections/connections.py`. */
|
|
526
|
+
export declare const ConnectionManifest: Schema.Struct<{
|
|
527
|
+
readonly key: Schema.String;
|
|
528
|
+
readonly description: Schema.String;
|
|
529
|
+
/** Written only when the ontology sends data out through the connection. */
|
|
530
|
+
readonly delivers: Schema.optionalKey<Schema.Literal<true>>;
|
|
531
|
+
}>;
|
|
532
|
+
export type ConnectionManifest = typeof ConnectionManifest.Type;
|
|
533
|
+
/**
|
|
534
|
+
* Who may become a member by signing in: `invited` or `open` as this SDK writes it. The policy is
|
|
535
|
+
* read as text, not as a closed set, because nothing is stored by it: a reader that meets a policy it
|
|
536
|
+
* does not know keeps the manifest and treats the policy as `invited`.
|
|
537
|
+
*/
|
|
538
|
+
export declare const BrowserSignInManifest: Schema.encodeKeys<Schema.Struct<{
|
|
539
|
+
readonly methods: Schema.$Array<Schema.String>;
|
|
540
|
+
readonly primary: Schema.String;
|
|
541
|
+
readonly autoRedirect: Schema.Boolean;
|
|
542
|
+
readonly local: Schema.optionalKey<Schema.Struct<{
|
|
543
|
+
readonly port: Schema.Int;
|
|
544
|
+
}>>;
|
|
545
|
+
}>, {
|
|
546
|
+
readonly autoRedirect: "auto_redirect";
|
|
547
|
+
}>;
|
|
548
|
+
export declare const SignInManifest: Schema.encodeKeys<Schema.Struct<{
|
|
549
|
+
readonly browser: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
550
|
+
readonly methods: Schema.$Array<Schema.String>;
|
|
551
|
+
readonly primary: Schema.String;
|
|
552
|
+
readonly autoRedirect: Schema.Boolean;
|
|
553
|
+
readonly local: Schema.optionalKey<Schema.Struct<{
|
|
554
|
+
readonly port: Schema.Int;
|
|
555
|
+
}>>;
|
|
556
|
+
}>, {
|
|
557
|
+
readonly autoRedirect: "auto_redirect";
|
|
558
|
+
}>>;
|
|
559
|
+
readonly policy: Schema.String;
|
|
560
|
+
readonly channels: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>;
|
|
561
|
+
readonly onNewUser: Schema.optionalKey<Schema.String>;
|
|
562
|
+
readonly codeLink: Schema.optionalKey<Schema.Boolean>;
|
|
563
|
+
}>, {
|
|
564
|
+
readonly onNewUser: "on_new_user";
|
|
565
|
+
readonly codeLink: "code_link";
|
|
566
|
+
}>;
|
|
567
|
+
export type SignInManifest = typeof SignInManifest.Type;
|
|
568
|
+
/** One of the workspace's emails, as `defineOntology({ emails })` declares it; see `EmailTemplate`. */
|
|
569
|
+
export declare const EmailTemplateManifest: Schema.encodeKeys<Schema.Struct<{
|
|
570
|
+
readonly subject: Schema.String;
|
|
571
|
+
readonly eyebrow: Schema.optionalKey<Schema.String>;
|
|
572
|
+
readonly heading: Schema.String;
|
|
573
|
+
readonly card: Schema.optionalKey<Schema.Struct<{
|
|
574
|
+
readonly title: Schema.String;
|
|
575
|
+
readonly detail: Schema.optionalKey<Schema.String>;
|
|
576
|
+
}>>;
|
|
577
|
+
readonly note: Schema.optionalKey<Schema.String>;
|
|
578
|
+
readonly paragraphs: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
579
|
+
readonly action: Schema.String;
|
|
580
|
+
readonly footer: Schema.optionalKey<Schema.String>;
|
|
581
|
+
readonly replyTo: Schema.optionalKey<Schema.String>;
|
|
582
|
+
}>, {
|
|
583
|
+
readonly replyTo: "reply_to";
|
|
584
|
+
}>;
|
|
585
|
+
export type EmailTemplateManifest = typeof EmailTemplateManifest.Type;
|
|
586
|
+
/** A property in the snake_case wire spelling, for records that store definitions. */
|
|
587
|
+
export declare const PropertyManifestWire: Schema.encodeKeys<Schema.Struct<{
|
|
588
|
+
readonly column: Schema.optionalKey<Schema.String>;
|
|
589
|
+
readonly scope: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
590
|
+
readonly name: Schema.String;
|
|
591
|
+
readonly type: Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>;
|
|
592
|
+
readonly label: Schema.String;
|
|
593
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
594
|
+
readonly optional: Schema.Boolean;
|
|
595
|
+
readonly unique: Schema.Boolean;
|
|
596
|
+
readonly managed: Schema.Boolean;
|
|
597
|
+
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
598
|
+
readonly display: Schema.optionalKey<Schema.String>;
|
|
599
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
600
|
+
readonly min: Schema.optionalKey<Schema.Number>;
|
|
601
|
+
readonly max: Schema.optionalKey<Schema.Number>;
|
|
602
|
+
readonly maxLength: Schema.optionalKey<Schema.Number>;
|
|
603
|
+
readonly accept: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
604
|
+
readonly maxBytes: Schema.optionalKey<Schema.Number>;
|
|
605
|
+
readonly options: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
606
|
+
readonly value: Schema.String;
|
|
607
|
+
readonly label: Schema.String;
|
|
608
|
+
readonly description: Schema.String;
|
|
609
|
+
}>>>;
|
|
610
|
+
/** The item type of a `list`, the built-in user's `roles`, which has no column. */
|
|
611
|
+
readonly items: Schema.optionalKey<Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>>;
|
|
612
|
+
}>, {
|
|
613
|
+
readonly renamedFrom: "renamed_from";
|
|
614
|
+
readonly maxLength: "max_length";
|
|
615
|
+
readonly maxBytes: "max_bytes";
|
|
616
|
+
}>;
|
|
617
|
+
/** A relationship in the snake_case wire spelling, for records that store definitions. */
|
|
618
|
+
export declare const RelationshipManifestWire: Schema.encodeKeys<Schema.Struct<{
|
|
619
|
+
readonly on: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
620
|
+
readonly property: Schema.String;
|
|
621
|
+
readonly targetProperty: Schema.String;
|
|
622
|
+
}>, {
|
|
623
|
+
readonly targetProperty: "target_property";
|
|
624
|
+
}>>;
|
|
625
|
+
readonly onDelete: Schema.optionalKey<Schema.decodeTo<Schema.Literals<readonly ["setNull", "cascade", "restrict"]>, Schema.Literals<readonly ["set_null", "cascade", "restrict"]>, never, never>>;
|
|
626
|
+
readonly name: Schema.String;
|
|
627
|
+
readonly to: Schema.String;
|
|
628
|
+
readonly inverse: Schema.String;
|
|
629
|
+
readonly cardinality: Schema.Literals<readonly ["one", "many"]>;
|
|
630
|
+
/** `rel.one` between stored entities only. */
|
|
631
|
+
readonly optional: Schema.optionalKey<Schema.Boolean>;
|
|
632
|
+
/** `rel.many` only. */
|
|
633
|
+
readonly ordered: Schema.optionalKey<Schema.Boolean>;
|
|
634
|
+
/** Forward and inverse phrases; unphrased directions read "has". */
|
|
635
|
+
readonly phrase: Schema.Tuple<readonly [Schema.String, Schema.String]>;
|
|
636
|
+
readonly description: Schema.String;
|
|
637
|
+
}>, {
|
|
638
|
+
readonly onDelete: "on_delete";
|
|
639
|
+
}>;
|
|
640
|
+
/** The JSON contract written since version 4; decoded SDK models remain camelCase. */
|
|
641
|
+
export declare const OntologyManifestWire: Schema.encodeKeys<Schema.Struct<{
|
|
642
|
+
readonly entities: Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
643
|
+
readonly metrics: Schema.optionalKey<Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
644
|
+
readonly name: Schema.String;
|
|
645
|
+
readonly label: Schema.String;
|
|
646
|
+
readonly description: Schema.String;
|
|
647
|
+
readonly unit: Schema.Literals<readonly ["number", "currency", "ratio", "percent"]>;
|
|
648
|
+
readonly format: Schema.Literals<readonly ["decimal", "currency", "percent"]>;
|
|
649
|
+
readonly expression: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
650
|
+
/**
|
|
651
|
+
* The column of the date or timestamp property a balance metric snapshots over; absent for
|
|
652
|
+
* additive metrics and in manifests before version 7. `balance_over` on the wire.
|
|
653
|
+
*/
|
|
654
|
+
readonly balanceOver: Schema.optionalKey<Schema.String>;
|
|
655
|
+
}>, {
|
|
656
|
+
readonly balanceOver: "balance_over";
|
|
657
|
+
}>>>;
|
|
658
|
+
readonly properties: Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
659
|
+
readonly column: Schema.optionalKey<Schema.String>;
|
|
660
|
+
readonly scope: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
661
|
+
readonly name: Schema.String;
|
|
662
|
+
readonly type: Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>;
|
|
663
|
+
readonly label: Schema.String;
|
|
664
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
665
|
+
readonly optional: Schema.Boolean;
|
|
666
|
+
readonly unique: Schema.Boolean;
|
|
667
|
+
readonly managed: Schema.Boolean;
|
|
668
|
+
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
669
|
+
readonly display: Schema.optionalKey<Schema.String>;
|
|
670
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
671
|
+
readonly min: Schema.optionalKey<Schema.Number>;
|
|
672
|
+
readonly max: Schema.optionalKey<Schema.Number>;
|
|
673
|
+
readonly maxLength: Schema.optionalKey<Schema.Number>;
|
|
674
|
+
readonly accept: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
675
|
+
readonly maxBytes: Schema.optionalKey<Schema.Number>;
|
|
676
|
+
readonly options: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
677
|
+
readonly value: Schema.String;
|
|
678
|
+
readonly label: Schema.String;
|
|
679
|
+
readonly description: Schema.String;
|
|
680
|
+
}>>>;
|
|
681
|
+
/** The item type of a `list`, the built-in user's `roles`, which has no column. */
|
|
682
|
+
readonly items: Schema.optionalKey<Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>>;
|
|
683
|
+
}>, {
|
|
684
|
+
readonly renamedFrom: "renamed_from";
|
|
685
|
+
readonly maxLength: "max_length";
|
|
686
|
+
readonly maxBytes: "max_bytes";
|
|
687
|
+
}>>;
|
|
688
|
+
readonly relationships: Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
689
|
+
readonly on: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
690
|
+
readonly property: Schema.String;
|
|
691
|
+
readonly targetProperty: Schema.String;
|
|
692
|
+
}>, {
|
|
693
|
+
readonly targetProperty: "target_property";
|
|
694
|
+
}>>;
|
|
695
|
+
readonly onDelete: Schema.optionalKey<Schema.decodeTo<Schema.Literals<readonly ["setNull", "cascade", "restrict"]>, Schema.Literals<readonly ["set_null", "cascade", "restrict"]>, never, never>>;
|
|
696
|
+
readonly name: Schema.String;
|
|
697
|
+
readonly to: Schema.String;
|
|
698
|
+
readonly inverse: Schema.String;
|
|
699
|
+
readonly cardinality: Schema.Literals<readonly ["one", "many"]>;
|
|
700
|
+
/** `rel.one` between stored entities only. */
|
|
701
|
+
readonly optional: Schema.optionalKey<Schema.Boolean>;
|
|
702
|
+
/** `rel.many` only. */
|
|
703
|
+
readonly ordered: Schema.optionalKey<Schema.Boolean>;
|
|
704
|
+
/** Forward and inverse phrases; unphrased directions read "has". */
|
|
705
|
+
readonly phrase: Schema.Tuple<readonly [Schema.String, Schema.String]>;
|
|
706
|
+
readonly description: Schema.String;
|
|
707
|
+
}>, {
|
|
708
|
+
readonly onDelete: "on_delete";
|
|
709
|
+
}>>;
|
|
710
|
+
readonly source: Schema.optionalKey<Schema.Struct<{
|
|
711
|
+
readonly asset: Schema.String;
|
|
712
|
+
readonly key: Schema.$Array<Schema.String>;
|
|
713
|
+
readonly currency: Schema.optionalKey<Schema.String>;
|
|
714
|
+
}>>;
|
|
715
|
+
readonly id: Schema.String;
|
|
716
|
+
readonly name: Schema.String;
|
|
717
|
+
readonly label: Schema.String;
|
|
718
|
+
readonly plural: Schema.String;
|
|
719
|
+
readonly title: Schema.String;
|
|
720
|
+
readonly description: Schema.String;
|
|
721
|
+
readonly builtIn: Schema.Boolean;
|
|
722
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
723
|
+
readonly guide: Schema.optionalKey<Schema.String>;
|
|
724
|
+
readonly indexes: Schema.$Array<Schema.Struct<{
|
|
725
|
+
readonly properties: Schema.$Array<Schema.String>;
|
|
726
|
+
readonly unique: Schema.Boolean;
|
|
727
|
+
}>>;
|
|
728
|
+
readonly actions: Schema.$Array<Schema.Struct<{
|
|
729
|
+
readonly name: Schema.String;
|
|
730
|
+
readonly description: Schema.String;
|
|
731
|
+
/**
|
|
732
|
+
* The permission a principal needs to run the action, for example `lead:changeStatus`. Always
|
|
733
|
+
* written; absent from version 1 manifests, where it reads as `<entity>:<action name>`.
|
|
734
|
+
*/
|
|
735
|
+
readonly permission: Schema.optionalKey<Schema.String>;
|
|
736
|
+
/** JSON Schema (draft 2020-12) of the input object. */
|
|
737
|
+
readonly input: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
738
|
+
/** Opt-in SQL handler replay after a confirmed deadlock rollback; absent means disabled. */
|
|
739
|
+
readonly retryOnDeadlock: Schema.optionalKey<Schema.Boolean>;
|
|
740
|
+
/**
|
|
741
|
+
* The entities the handler writes, by name, as the action declares them; the runtime refuses any
|
|
742
|
+
* other write. Absent means it declares none and may write any entity; `[]` writes nothing.
|
|
743
|
+
*/
|
|
744
|
+
readonly writes: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
745
|
+
/**
|
|
746
|
+
* The keys of the workspace connections the action calls before its transaction. Written only
|
|
747
|
+
* when there are some; absent reads as none.
|
|
748
|
+
*/
|
|
749
|
+
readonly connections: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
750
|
+
/** File writes declared in code; absence grants preparation no staging targets. */
|
|
751
|
+
readonly files: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
752
|
+
readonly entity: Schema.String;
|
|
753
|
+
readonly property: Schema.String;
|
|
754
|
+
}>>>;
|
|
755
|
+
/**
|
|
756
|
+
* How the action behaves, as MCP tool annotations tell agents. Written only when the action
|
|
757
|
+
* declares hints; absent safety labels require agent confirmation for compatibility.
|
|
758
|
+
*/
|
|
759
|
+
readonly hints: Schema.optionalKey<Schema.Struct<{
|
|
760
|
+
readonly readOnly: Schema.optionalKey<Schema.Boolean>;
|
|
761
|
+
readonly connectionsReadOnly: Schema.optionalKey<Schema.Boolean>;
|
|
762
|
+
readonly destructive: Schema.optionalKey<Schema.Boolean>;
|
|
763
|
+
readonly irreversible: Schema.optionalKey<Schema.Boolean>;
|
|
764
|
+
readonly idempotent: Schema.optionalKey<Schema.Boolean>;
|
|
765
|
+
}>>;
|
|
766
|
+
}>>;
|
|
767
|
+
/** Always written; absent from version 1 manifests. */
|
|
768
|
+
readonly permissions: Schema.optionalKey<Schema.Struct<{
|
|
769
|
+
readonly read: Schema.String;
|
|
770
|
+
readonly create: Schema.optionalKey<Schema.String>;
|
|
771
|
+
readonly update: Schema.optionalKey<Schema.String>;
|
|
772
|
+
readonly delete: Schema.optionalKey<Schema.String>;
|
|
773
|
+
readonly link: Schema.optionalKey<Schema.String>;
|
|
774
|
+
readonly unlink: Schema.optionalKey<Schema.String>;
|
|
775
|
+
}>>;
|
|
776
|
+
/**
|
|
777
|
+
* `"actions"` when only the entity's authored actions write its records, so it has no generated
|
|
778
|
+
* writes and its `permissions` hold only `read`. Absent means the generated writes exist.
|
|
779
|
+
*/
|
|
780
|
+
readonly writes: Schema.optionalKey<Schema.Literal<"actions">>;
|
|
781
|
+
}>, {
|
|
782
|
+
readonly builtIn: "built_in";
|
|
783
|
+
readonly renamedFrom: "renamed_from";
|
|
784
|
+
}>>;
|
|
785
|
+
readonly roles: Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
786
|
+
readonly name: Schema.String;
|
|
787
|
+
readonly description: Schema.String;
|
|
788
|
+
readonly builtIn: Schema.Boolean;
|
|
789
|
+
/**
|
|
790
|
+
* What the role may do, wildcards included; for the built-in `member`, what every active app user
|
|
791
|
+
* may do. Always written; absent from version 1 manifests.
|
|
792
|
+
*/
|
|
793
|
+
readonly permissions: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
794
|
+
/**
|
|
795
|
+
* The permissions the role holds only for the records their `where` matches, since version 10.
|
|
796
|
+
* Written only when there are some; absent reads as none.
|
|
797
|
+
*/
|
|
798
|
+
readonly scopes: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
799
|
+
readonly permission: Schema.String;
|
|
800
|
+
readonly where: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
801
|
+
}>>>;
|
|
802
|
+
}>, {
|
|
803
|
+
readonly builtIn: "built_in";
|
|
804
|
+
}>>;
|
|
805
|
+
/** Resolved feedback settings since version 11; absence preserves historical opt-in behavior. */
|
|
806
|
+
readonly feedback: Schema.optionalKey<Schema.Struct<{
|
|
807
|
+
readonly enabled: Schema.Boolean;
|
|
808
|
+
readonly files: Schema.Boolean;
|
|
809
|
+
readonly builders: Schema.$Array<Schema.String>;
|
|
810
|
+
readonly automaticFailureReports: Schema.optionalKey<Schema.Boolean>;
|
|
811
|
+
}>>;
|
|
812
|
+
readonly runtimeCapabilities: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
813
|
+
/** Written by ontology SDKs 0.86.0 to 0.88.0 and never read; decoded so their manifests encode back. */
|
|
814
|
+
readonly executionCompatibility: Schema.optionalKey<Schema.Struct<{
|
|
815
|
+
readonly version: Schema.Int;
|
|
816
|
+
readonly hash: Schema.String;
|
|
817
|
+
}>>;
|
|
818
|
+
readonly version: Schema.Int;
|
|
819
|
+
/** `sha256:` and the hex digest of the canonical JSON of the manifest without `hash`. */
|
|
820
|
+
readonly hash: Schema.String;
|
|
821
|
+
/** Always written; absent from manifests built before sign-in policies, which read as `invited`. */
|
|
822
|
+
readonly signIn: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
823
|
+
readonly browser: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
824
|
+
readonly methods: Schema.$Array<Schema.String>;
|
|
825
|
+
readonly primary: Schema.String;
|
|
826
|
+
readonly autoRedirect: Schema.Boolean;
|
|
827
|
+
readonly local: Schema.optionalKey<Schema.Struct<{
|
|
828
|
+
readonly port: Schema.Int;
|
|
829
|
+
}>>;
|
|
830
|
+
}>, {
|
|
831
|
+
readonly autoRedirect: "auto_redirect";
|
|
832
|
+
}>>;
|
|
833
|
+
readonly policy: Schema.String;
|
|
834
|
+
readonly channels: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>;
|
|
835
|
+
readonly onNewUser: Schema.optionalKey<Schema.String>;
|
|
836
|
+
readonly codeLink: Schema.optionalKey<Schema.Boolean>;
|
|
837
|
+
}>, {
|
|
838
|
+
readonly onNewUser: "on_new_user";
|
|
839
|
+
readonly codeLink: "code_link";
|
|
840
|
+
}>>;
|
|
841
|
+
/** The workspace's own emails by wire name. Written only when there are some; absent reads as none. */
|
|
842
|
+
readonly emails: Schema.optionalKey<Schema.$Record<Schema.String, Schema.encodeKeys<Schema.Struct<{
|
|
843
|
+
readonly subject: Schema.String;
|
|
844
|
+
readonly eyebrow: Schema.optionalKey<Schema.String>;
|
|
845
|
+
readonly heading: Schema.String;
|
|
846
|
+
readonly card: Schema.optionalKey<Schema.Struct<{
|
|
847
|
+
readonly title: Schema.String;
|
|
848
|
+
readonly detail: Schema.optionalKey<Schema.String>;
|
|
849
|
+
}>>;
|
|
850
|
+
readonly note: Schema.optionalKey<Schema.String>;
|
|
851
|
+
readonly paragraphs: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
852
|
+
readonly action: Schema.String;
|
|
853
|
+
readonly footer: Schema.optionalKey<Schema.String>;
|
|
854
|
+
readonly replyTo: Schema.optionalKey<Schema.String>;
|
|
855
|
+
}>, {
|
|
856
|
+
readonly replyTo: "reply_to";
|
|
857
|
+
}>>>;
|
|
858
|
+
/** The connections the actions call. Written only when there are some; absent reads as none. */
|
|
859
|
+
readonly connections: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
860
|
+
readonly key: Schema.String;
|
|
861
|
+
readonly description: Schema.String;
|
|
862
|
+
/** Written only when the ontology sends data out through the connection. */
|
|
863
|
+
readonly delivers: Schema.optionalKey<Schema.Literal<true>>;
|
|
864
|
+
}>>>;
|
|
865
|
+
readonly chat: Schema.optionalKey<Schema.Struct<{
|
|
866
|
+
readonly telegram: Schema.optionalKey<Schema.Struct<{
|
|
867
|
+
readonly connection: Schema.String;
|
|
868
|
+
}>>;
|
|
869
|
+
readonly attribution: Schema.optionalKey<Schema.Struct<{
|
|
870
|
+
readonly template: Schema.optionalKey<Schema.String>;
|
|
871
|
+
readonly separator: Schema.optionalKey<Schema.String>;
|
|
872
|
+
}>>;
|
|
873
|
+
}>>;
|
|
874
|
+
/**
|
|
875
|
+
* The metrics of the model, since version 8. Written only when there are some; absent reads as
|
|
876
|
+
* none.
|
|
877
|
+
*/
|
|
878
|
+
readonly metrics: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
879
|
+
readonly name: Schema.String;
|
|
880
|
+
readonly label: Schema.String;
|
|
881
|
+
readonly description: Schema.String;
|
|
882
|
+
readonly unit: Schema.Literals<readonly ["number", "currency", "ratio", "percent"]>;
|
|
883
|
+
readonly format: Schema.Literals<readonly ["decimal", "currency", "percent"]>;
|
|
884
|
+
readonly expression: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
885
|
+
/** The entity metrics the expression reads, `entity.metric`, each once, in reading order. */
|
|
886
|
+
readonly inputs: Schema.$Array<Schema.String>;
|
|
887
|
+
/**
|
|
888
|
+
* Groups of properties that stand for one another: each names every entity the metric reads,
|
|
889
|
+
* with a property or `null` for an entity without a counterpart.
|
|
890
|
+
*/
|
|
891
|
+
readonly align: Schema.$Array<Schema.$Record<Schema.String, Schema.NullOr<Schema.String>>>;
|
|
892
|
+
}>>>;
|
|
893
|
+
/**
|
|
894
|
+
* The workflows, since version 9. Written only when there are some; absent reads as none.
|
|
895
|
+
*/
|
|
896
|
+
readonly workflows: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
897
|
+
readonly name: Schema.String;
|
|
898
|
+
readonly description: Schema.String;
|
|
899
|
+
readonly role: Schema.String;
|
|
900
|
+
readonly input: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
901
|
+
readonly connections: Schema.$Array<Schema.String>;
|
|
902
|
+
readonly triggers: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
903
|
+
readonly kind: Schema.Literal<"cron">;
|
|
904
|
+
readonly name: Schema.String;
|
|
905
|
+
readonly description: Schema.String;
|
|
906
|
+
/** Five fields, UTC. */
|
|
907
|
+
readonly cron: Schema.String;
|
|
908
|
+
readonly input: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
909
|
+
}>, Schema.Struct<{
|
|
910
|
+
readonly kind: Schema.Literal<"action">;
|
|
911
|
+
readonly name: Schema.String;
|
|
912
|
+
readonly description: Schema.String;
|
|
913
|
+
readonly entity: Schema.String;
|
|
914
|
+
readonly action: Schema.optionalKey<Schema.String>;
|
|
915
|
+
}>, Schema.Struct<{
|
|
916
|
+
readonly kind: Schema.Literal<"webhook">;
|
|
917
|
+
readonly name: Schema.String;
|
|
918
|
+
readonly description: Schema.String;
|
|
919
|
+
readonly signature: Schema.optionalKey<Schema.Struct<{
|
|
920
|
+
readonly scheme: Schema.String;
|
|
921
|
+
readonly secret: Schema.String;
|
|
922
|
+
}>>;
|
|
923
|
+
readonly verification: Schema.optionalKey<Schema.Struct<{
|
|
924
|
+
readonly scheme: Schema.String;
|
|
925
|
+
readonly verifyToken: Schema.String;
|
|
926
|
+
}>>;
|
|
927
|
+
readonly headers: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
928
|
+
}>, Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>>;
|
|
929
|
+
}>>>;
|
|
930
|
+
}>, {
|
|
931
|
+
readonly signIn: "sign_in";
|
|
932
|
+
}>;
|
|
933
|
+
/**
|
|
934
|
+
* Historical readers accept either metadata spelling and any manifest version, with the names of
|
|
935
|
+
* metrics before version 14: every decode, of the type side too, reads a document through
|
|
936
|
+
* `withCurrentManifestNames`.
|
|
937
|
+
*/
|
|
938
|
+
export declare const OntologyManifest: Schema.declareConstructor<{
|
|
939
|
+
readonly version: number;
|
|
940
|
+
readonly hash: string;
|
|
941
|
+
readonly entities: readonly {
|
|
942
|
+
readonly id: string;
|
|
943
|
+
readonly name: string;
|
|
944
|
+
readonly description: string;
|
|
945
|
+
readonly label: string;
|
|
946
|
+
readonly properties: readonly {
|
|
947
|
+
readonly optional: boolean;
|
|
948
|
+
readonly name: string;
|
|
949
|
+
readonly label: string;
|
|
950
|
+
readonly type: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list";
|
|
951
|
+
readonly unique: boolean;
|
|
952
|
+
readonly managed: boolean;
|
|
953
|
+
readonly max?: number | undefined;
|
|
954
|
+
readonly description?: string | undefined;
|
|
955
|
+
readonly default?: Schema.Json | undefined;
|
|
956
|
+
readonly min?: number | undefined;
|
|
957
|
+
readonly column?: string | undefined;
|
|
958
|
+
readonly renamedFrom?: string | undefined;
|
|
959
|
+
readonly scope?: readonly string[] | undefined;
|
|
960
|
+
readonly display?: string | undefined;
|
|
961
|
+
readonly maxLength?: number | undefined;
|
|
962
|
+
readonly accept?: readonly string[] | undefined;
|
|
963
|
+
readonly maxBytes?: number | undefined;
|
|
964
|
+
readonly options?: readonly {
|
|
965
|
+
readonly value: string;
|
|
966
|
+
readonly label: string;
|
|
967
|
+
readonly description: string;
|
|
968
|
+
}[] | undefined;
|
|
969
|
+
readonly items?: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list" | undefined;
|
|
970
|
+
}[];
|
|
971
|
+
readonly relationships: readonly {
|
|
972
|
+
readonly name: string;
|
|
973
|
+
readonly description: string;
|
|
974
|
+
readonly to: string;
|
|
975
|
+
readonly cardinality: "one" | "many";
|
|
976
|
+
readonly phrase: readonly [string, string];
|
|
977
|
+
readonly inverse: string;
|
|
978
|
+
readonly optional?: boolean | undefined;
|
|
979
|
+
readonly on?: {
|
|
980
|
+
readonly property: string;
|
|
981
|
+
readonly targetProperty: string;
|
|
982
|
+
} | undefined;
|
|
983
|
+
readonly onDelete?: "setNull" | "cascade" | "restrict" | undefined;
|
|
984
|
+
readonly ordered?: boolean | undefined;
|
|
985
|
+
}[];
|
|
986
|
+
readonly indexes: readonly {
|
|
987
|
+
readonly properties: readonly string[];
|
|
988
|
+
readonly unique: boolean;
|
|
989
|
+
}[];
|
|
990
|
+
readonly actions: readonly {
|
|
991
|
+
readonly name: string;
|
|
992
|
+
readonly description: string;
|
|
993
|
+
readonly input: {
|
|
994
|
+
readonly [x: string]: Schema.Json;
|
|
995
|
+
};
|
|
996
|
+
readonly permission?: string | undefined;
|
|
997
|
+
readonly retryOnDeadlock?: boolean | undefined;
|
|
998
|
+
readonly writes?: readonly string[] | undefined;
|
|
999
|
+
readonly connections?: readonly string[] | undefined;
|
|
1000
|
+
readonly files?: readonly {
|
|
1001
|
+
readonly entity: string;
|
|
1002
|
+
readonly property: string;
|
|
1003
|
+
}[] | undefined;
|
|
1004
|
+
readonly hints?: {
|
|
1005
|
+
readonly readOnly?: boolean | undefined;
|
|
1006
|
+
readonly connectionsReadOnly?: boolean | undefined;
|
|
1007
|
+
readonly destructive?: boolean | undefined;
|
|
1008
|
+
readonly irreversible?: boolean | undefined;
|
|
1009
|
+
readonly idempotent?: boolean | undefined;
|
|
1010
|
+
} | undefined;
|
|
1011
|
+
}[];
|
|
1012
|
+
readonly plural: string;
|
|
1013
|
+
readonly title: string;
|
|
1014
|
+
readonly builtIn: boolean;
|
|
1015
|
+
readonly source?: {
|
|
1016
|
+
readonly key: readonly string[];
|
|
1017
|
+
readonly asset: string;
|
|
1018
|
+
readonly currency?: string | undefined;
|
|
1019
|
+
} | undefined;
|
|
1020
|
+
readonly metrics?: readonly {
|
|
1021
|
+
readonly name: string;
|
|
1022
|
+
readonly description: string;
|
|
1023
|
+
readonly label: string;
|
|
1024
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
1025
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
1026
|
+
readonly expression: Schema.Json;
|
|
1027
|
+
readonly balanceOver?: string | undefined;
|
|
1028
|
+
}[] | undefined;
|
|
1029
|
+
readonly renamedFrom?: string | undefined;
|
|
1030
|
+
readonly guide?: string | undefined;
|
|
1031
|
+
readonly writes?: "actions" | undefined;
|
|
1032
|
+
readonly permissions?: {
|
|
1033
|
+
readonly read: string;
|
|
1034
|
+
readonly create?: string | undefined;
|
|
1035
|
+
readonly update?: string | undefined;
|
|
1036
|
+
readonly delete?: string | undefined;
|
|
1037
|
+
readonly link?: string | undefined;
|
|
1038
|
+
readonly unlink?: string | undefined;
|
|
1039
|
+
} | undefined;
|
|
1040
|
+
}[];
|
|
1041
|
+
readonly roles: readonly {
|
|
1042
|
+
readonly name: string;
|
|
1043
|
+
readonly description: string;
|
|
1044
|
+
readonly builtIn: boolean;
|
|
1045
|
+
readonly scopes?: readonly {
|
|
1046
|
+
readonly permission: string;
|
|
1047
|
+
readonly where: {
|
|
1048
|
+
readonly [x: string]: Schema.Json;
|
|
1049
|
+
};
|
|
1050
|
+
}[] | undefined;
|
|
1051
|
+
readonly permissions?: readonly string[] | undefined;
|
|
1052
|
+
}[];
|
|
1053
|
+
readonly chat?: {
|
|
1054
|
+
readonly telegram?: {
|
|
1055
|
+
readonly connection: string;
|
|
1056
|
+
} | undefined;
|
|
1057
|
+
readonly attribution?: {
|
|
1058
|
+
readonly template?: string | undefined;
|
|
1059
|
+
readonly separator?: string | undefined;
|
|
1060
|
+
} | undefined;
|
|
1061
|
+
} | undefined;
|
|
1062
|
+
readonly workflows?: readonly {
|
|
1063
|
+
readonly name: string;
|
|
1064
|
+
readonly description: string;
|
|
1065
|
+
readonly role: string;
|
|
1066
|
+
readonly input: {
|
|
1067
|
+
readonly [x: string]: Schema.Json;
|
|
1068
|
+
};
|
|
1069
|
+
readonly connections: readonly string[];
|
|
1070
|
+
readonly triggers: readonly ({
|
|
1071
|
+
readonly kind: "cron";
|
|
1072
|
+
readonly name: string;
|
|
1073
|
+
readonly description: string;
|
|
1074
|
+
readonly cron: string;
|
|
1075
|
+
readonly input: Schema.Json;
|
|
1076
|
+
} | {
|
|
1077
|
+
readonly kind: "action";
|
|
1078
|
+
readonly entity: string;
|
|
1079
|
+
readonly name: string;
|
|
1080
|
+
readonly description: string;
|
|
1081
|
+
readonly action?: string | undefined;
|
|
1082
|
+
} | {
|
|
1083
|
+
readonly kind: "webhook";
|
|
1084
|
+
readonly name: string;
|
|
1085
|
+
readonly description: string;
|
|
1086
|
+
readonly signature?: {
|
|
1087
|
+
readonly scheme: string;
|
|
1088
|
+
readonly secret: string;
|
|
1089
|
+
} | undefined;
|
|
1090
|
+
readonly verification?: {
|
|
1091
|
+
readonly scheme: string;
|
|
1092
|
+
readonly verifyToken: string;
|
|
1093
|
+
} | undefined;
|
|
1094
|
+
readonly headers?: readonly string[] | undefined;
|
|
1095
|
+
} | {
|
|
1096
|
+
readonly [x: string]: Schema.Json;
|
|
1097
|
+
})[];
|
|
1098
|
+
}[] | undefined;
|
|
1099
|
+
readonly metrics?: readonly {
|
|
1100
|
+
readonly name: string;
|
|
1101
|
+
readonly label: string;
|
|
1102
|
+
readonly description: string;
|
|
1103
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
1104
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
1105
|
+
readonly expression: Schema.Json;
|
|
1106
|
+
readonly inputs: readonly string[];
|
|
1107
|
+
readonly align: readonly {
|
|
1108
|
+
readonly [x: string]: string | null;
|
|
1109
|
+
}[];
|
|
1110
|
+
}[] | undefined;
|
|
1111
|
+
readonly connections?: readonly {
|
|
1112
|
+
readonly description: string;
|
|
1113
|
+
readonly key: string;
|
|
1114
|
+
readonly delivers?: true | undefined;
|
|
1115
|
+
}[] | undefined;
|
|
1116
|
+
readonly feedback?: {
|
|
1117
|
+
readonly files: boolean;
|
|
1118
|
+
readonly builders: readonly string[];
|
|
1119
|
+
readonly enabled: boolean;
|
|
1120
|
+
readonly automaticFailureReports?: boolean | undefined;
|
|
1121
|
+
} | undefined;
|
|
1122
|
+
readonly runtimeCapabilities?: readonly string[] | undefined;
|
|
1123
|
+
readonly executionCompatibility?: {
|
|
1124
|
+
readonly version: number;
|
|
1125
|
+
readonly hash: string;
|
|
1126
|
+
} | undefined;
|
|
1127
|
+
readonly signIn?: {
|
|
1128
|
+
readonly policy: string;
|
|
1129
|
+
readonly browser?: {
|
|
1130
|
+
readonly methods: readonly string[];
|
|
1131
|
+
readonly primary: string;
|
|
1132
|
+
readonly autoRedirect: boolean;
|
|
1133
|
+
readonly local?: {
|
|
1134
|
+
readonly port: number;
|
|
1135
|
+
} | undefined;
|
|
1136
|
+
} | undefined;
|
|
1137
|
+
readonly channels?: {
|
|
1138
|
+
readonly [x: string]: unknown;
|
|
1139
|
+
} | undefined;
|
|
1140
|
+
readonly onNewUser?: string | undefined;
|
|
1141
|
+
readonly codeLink?: boolean | undefined;
|
|
1142
|
+
} | undefined;
|
|
1143
|
+
readonly emails?: {
|
|
1144
|
+
readonly [x: string]: {
|
|
1145
|
+
readonly subject: string;
|
|
1146
|
+
readonly action: string;
|
|
1147
|
+
readonly heading: string;
|
|
1148
|
+
readonly replyTo?: string | undefined;
|
|
1149
|
+
readonly eyebrow?: string | undefined;
|
|
1150
|
+
readonly card?: {
|
|
1151
|
+
readonly title: string;
|
|
1152
|
+
readonly detail?: string | undefined;
|
|
1153
|
+
} | undefined;
|
|
1154
|
+
readonly note?: string | undefined;
|
|
1155
|
+
readonly paragraphs?: readonly string[] | undefined;
|
|
1156
|
+
readonly footer?: string | undefined;
|
|
1157
|
+
};
|
|
1158
|
+
} | undefined;
|
|
1159
|
+
} | {
|
|
1160
|
+
readonly version: number;
|
|
1161
|
+
readonly hash: string;
|
|
1162
|
+
readonly entities: readonly {
|
|
1163
|
+
readonly id: string;
|
|
1164
|
+
readonly name: string;
|
|
1165
|
+
readonly description: string;
|
|
1166
|
+
readonly label: string;
|
|
1167
|
+
readonly properties: readonly {
|
|
1168
|
+
readonly optional: boolean;
|
|
1169
|
+
readonly name: string;
|
|
1170
|
+
readonly label: string;
|
|
1171
|
+
readonly type: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list";
|
|
1172
|
+
readonly unique: boolean;
|
|
1173
|
+
readonly managed: boolean;
|
|
1174
|
+
readonly max?: number | undefined;
|
|
1175
|
+
readonly description?: string | undefined;
|
|
1176
|
+
readonly default?: Schema.Json | undefined;
|
|
1177
|
+
readonly min?: number | undefined;
|
|
1178
|
+
readonly column?: string | undefined;
|
|
1179
|
+
readonly renamedFrom?: string | undefined;
|
|
1180
|
+
readonly scope?: readonly string[] | undefined;
|
|
1181
|
+
readonly display?: string | undefined;
|
|
1182
|
+
readonly maxLength?: number | undefined;
|
|
1183
|
+
readonly accept?: readonly string[] | undefined;
|
|
1184
|
+
readonly maxBytes?: number | undefined;
|
|
1185
|
+
readonly options?: readonly {
|
|
1186
|
+
readonly value: string;
|
|
1187
|
+
readonly label: string;
|
|
1188
|
+
readonly description: string;
|
|
1189
|
+
}[] | undefined;
|
|
1190
|
+
readonly items?: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list" | undefined;
|
|
1191
|
+
}[];
|
|
1192
|
+
readonly relationships: readonly {
|
|
1193
|
+
readonly name: string;
|
|
1194
|
+
readonly description: string;
|
|
1195
|
+
readonly to: string;
|
|
1196
|
+
readonly cardinality: "one" | "many";
|
|
1197
|
+
readonly phrase: readonly [string, string];
|
|
1198
|
+
readonly inverse: string;
|
|
1199
|
+
readonly optional?: boolean | undefined;
|
|
1200
|
+
readonly on?: {
|
|
1201
|
+
readonly property: string;
|
|
1202
|
+
readonly targetProperty: string;
|
|
1203
|
+
} | undefined;
|
|
1204
|
+
readonly onDelete?: "setNull" | "cascade" | "restrict" | undefined;
|
|
1205
|
+
readonly ordered?: boolean | undefined;
|
|
1206
|
+
}[];
|
|
1207
|
+
readonly indexes: readonly {
|
|
1208
|
+
readonly properties: readonly string[];
|
|
1209
|
+
readonly unique: boolean;
|
|
1210
|
+
}[];
|
|
1211
|
+
readonly actions: readonly {
|
|
1212
|
+
readonly name: string;
|
|
1213
|
+
readonly description: string;
|
|
1214
|
+
readonly input: {
|
|
1215
|
+
readonly [x: string]: Schema.Json;
|
|
1216
|
+
};
|
|
1217
|
+
readonly permission?: string | undefined;
|
|
1218
|
+
readonly retryOnDeadlock?: boolean | undefined;
|
|
1219
|
+
readonly writes?: readonly string[] | undefined;
|
|
1220
|
+
readonly connections?: readonly string[] | undefined;
|
|
1221
|
+
readonly files?: readonly {
|
|
1222
|
+
readonly entity: string;
|
|
1223
|
+
readonly property: string;
|
|
1224
|
+
}[] | undefined;
|
|
1225
|
+
readonly hints?: {
|
|
1226
|
+
readonly readOnly?: boolean | undefined;
|
|
1227
|
+
readonly connectionsReadOnly?: boolean | undefined;
|
|
1228
|
+
readonly destructive?: boolean | undefined;
|
|
1229
|
+
readonly irreversible?: boolean | undefined;
|
|
1230
|
+
readonly idempotent?: boolean | undefined;
|
|
1231
|
+
} | undefined;
|
|
1232
|
+
}[];
|
|
1233
|
+
readonly plural: string;
|
|
1234
|
+
readonly title: string;
|
|
1235
|
+
readonly builtIn: boolean;
|
|
1236
|
+
readonly source?: {
|
|
1237
|
+
readonly key: readonly string[];
|
|
1238
|
+
readonly asset: string;
|
|
1239
|
+
readonly currency?: string | undefined;
|
|
1240
|
+
} | undefined;
|
|
1241
|
+
readonly metrics?: readonly {
|
|
1242
|
+
readonly name: string;
|
|
1243
|
+
readonly description: string;
|
|
1244
|
+
readonly label: string;
|
|
1245
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
1246
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
1247
|
+
readonly expression: Schema.Json;
|
|
1248
|
+
readonly balanceOver?: string | undefined;
|
|
1249
|
+
}[] | undefined;
|
|
1250
|
+
readonly renamedFrom?: string | undefined;
|
|
1251
|
+
readonly guide?: string | undefined;
|
|
1252
|
+
readonly writes?: "actions" | undefined;
|
|
1253
|
+
readonly permissions?: {
|
|
1254
|
+
readonly read: string;
|
|
1255
|
+
readonly create?: string | undefined;
|
|
1256
|
+
readonly update?: string | undefined;
|
|
1257
|
+
readonly delete?: string | undefined;
|
|
1258
|
+
readonly link?: string | undefined;
|
|
1259
|
+
readonly unlink?: string | undefined;
|
|
1260
|
+
} | undefined;
|
|
1261
|
+
}[];
|
|
1262
|
+
readonly roles: readonly {
|
|
1263
|
+
readonly name: string;
|
|
1264
|
+
readonly description: string;
|
|
1265
|
+
readonly builtIn: boolean;
|
|
1266
|
+
readonly scopes?: readonly {
|
|
1267
|
+
readonly permission: string;
|
|
1268
|
+
readonly where: {
|
|
1269
|
+
readonly [x: string]: Schema.Json;
|
|
1270
|
+
};
|
|
1271
|
+
}[] | undefined;
|
|
1272
|
+
readonly permissions?: readonly string[] | undefined;
|
|
1273
|
+
}[];
|
|
1274
|
+
readonly chat?: {
|
|
1275
|
+
readonly telegram?: {
|
|
1276
|
+
readonly connection: string;
|
|
1277
|
+
} | undefined;
|
|
1278
|
+
readonly attribution?: {
|
|
1279
|
+
readonly template?: string | undefined;
|
|
1280
|
+
readonly separator?: string | undefined;
|
|
1281
|
+
} | undefined;
|
|
1282
|
+
} | undefined;
|
|
1283
|
+
readonly workflows?: readonly {
|
|
1284
|
+
readonly name: string;
|
|
1285
|
+
readonly description: string;
|
|
1286
|
+
readonly role: string;
|
|
1287
|
+
readonly input: {
|
|
1288
|
+
readonly [x: string]: Schema.Json;
|
|
1289
|
+
};
|
|
1290
|
+
readonly connections: readonly string[];
|
|
1291
|
+
readonly triggers: readonly ({
|
|
1292
|
+
readonly kind: "cron";
|
|
1293
|
+
readonly name: string;
|
|
1294
|
+
readonly description: string;
|
|
1295
|
+
readonly cron: string;
|
|
1296
|
+
readonly input: Schema.Json;
|
|
1297
|
+
} | {
|
|
1298
|
+
readonly kind: "action";
|
|
1299
|
+
readonly entity: string;
|
|
1300
|
+
readonly name: string;
|
|
1301
|
+
readonly description: string;
|
|
1302
|
+
readonly action?: string | undefined;
|
|
1303
|
+
} | {
|
|
1304
|
+
readonly kind: "webhook";
|
|
1305
|
+
readonly name: string;
|
|
1306
|
+
readonly description: string;
|
|
1307
|
+
readonly signature?: {
|
|
1308
|
+
readonly scheme: string;
|
|
1309
|
+
readonly secret: string;
|
|
1310
|
+
} | undefined;
|
|
1311
|
+
readonly verification?: {
|
|
1312
|
+
readonly scheme: string;
|
|
1313
|
+
readonly verifyToken: string;
|
|
1314
|
+
} | undefined;
|
|
1315
|
+
readonly headers?: readonly string[] | undefined;
|
|
1316
|
+
} | {
|
|
1317
|
+
readonly [x: string]: Schema.Json;
|
|
1318
|
+
})[];
|
|
1319
|
+
}[] | undefined;
|
|
1320
|
+
readonly metrics?: readonly {
|
|
1321
|
+
readonly name: string;
|
|
1322
|
+
readonly label: string;
|
|
1323
|
+
readonly description: string;
|
|
1324
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
1325
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
1326
|
+
readonly expression: Schema.Json;
|
|
1327
|
+
readonly inputs: readonly string[];
|
|
1328
|
+
readonly align: readonly {
|
|
1329
|
+
readonly [x: string]: string | null;
|
|
1330
|
+
}[];
|
|
1331
|
+
}[] | undefined;
|
|
1332
|
+
readonly connections?: readonly {
|
|
1333
|
+
readonly description: string;
|
|
1334
|
+
readonly key: string;
|
|
1335
|
+
readonly delivers?: true | undefined;
|
|
1336
|
+
}[] | undefined;
|
|
1337
|
+
readonly feedback?: {
|
|
1338
|
+
readonly files: boolean;
|
|
1339
|
+
readonly builders: readonly string[];
|
|
1340
|
+
readonly enabled: boolean;
|
|
1341
|
+
readonly automaticFailureReports?: boolean | undefined;
|
|
1342
|
+
} | undefined;
|
|
1343
|
+
readonly runtimeCapabilities?: readonly string[] | undefined;
|
|
1344
|
+
readonly executionCompatibility?: {
|
|
1345
|
+
readonly version: number;
|
|
1346
|
+
readonly hash: string;
|
|
1347
|
+
} | undefined;
|
|
1348
|
+
readonly signIn?: {
|
|
1349
|
+
readonly policy: string;
|
|
1350
|
+
readonly browser?: {
|
|
1351
|
+
readonly methods: readonly string[];
|
|
1352
|
+
readonly primary: string;
|
|
1353
|
+
readonly autoRedirect: boolean;
|
|
1354
|
+
readonly local?: {
|
|
1355
|
+
readonly port: number;
|
|
1356
|
+
} | undefined;
|
|
1357
|
+
} | undefined;
|
|
1358
|
+
readonly channels?: {
|
|
1359
|
+
readonly [x: string]: unknown;
|
|
1360
|
+
} | undefined;
|
|
1361
|
+
readonly onNewUser?: string | undefined;
|
|
1362
|
+
readonly codeLink?: boolean | undefined;
|
|
1363
|
+
} | undefined;
|
|
1364
|
+
readonly emails?: {
|
|
1365
|
+
readonly [x: string]: {
|
|
1366
|
+
readonly subject: string;
|
|
1367
|
+
readonly action: string;
|
|
1368
|
+
readonly heading: string;
|
|
1369
|
+
readonly replyTo?: string | undefined;
|
|
1370
|
+
readonly eyebrow?: string | undefined;
|
|
1371
|
+
readonly card?: {
|
|
1372
|
+
readonly title: string;
|
|
1373
|
+
readonly detail?: string | undefined;
|
|
1374
|
+
} | undefined;
|
|
1375
|
+
readonly note?: string | undefined;
|
|
1376
|
+
readonly paragraphs?: readonly string[] | undefined;
|
|
1377
|
+
readonly footer?: string | undefined;
|
|
1378
|
+
};
|
|
1379
|
+
} | undefined;
|
|
1380
|
+
}, {
|
|
1381
|
+
readonly version: number;
|
|
1382
|
+
readonly hash: string;
|
|
1383
|
+
readonly entities: readonly {
|
|
1384
|
+
readonly id: string;
|
|
1385
|
+
readonly name: string;
|
|
1386
|
+
readonly description: string;
|
|
1387
|
+
readonly label: string;
|
|
1388
|
+
readonly properties: readonly {
|
|
1389
|
+
readonly optional: boolean;
|
|
1390
|
+
readonly name: string;
|
|
1391
|
+
readonly label: string;
|
|
1392
|
+
readonly type: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list";
|
|
1393
|
+
readonly unique: boolean;
|
|
1394
|
+
readonly managed: boolean;
|
|
1395
|
+
readonly max?: number | undefined;
|
|
1396
|
+
readonly description?: string | undefined;
|
|
1397
|
+
readonly default?: Schema.Json | undefined;
|
|
1398
|
+
readonly min?: number | undefined;
|
|
1399
|
+
readonly column?: string | undefined;
|
|
1400
|
+
readonly scope?: readonly string[] | undefined;
|
|
1401
|
+
readonly display?: string | undefined;
|
|
1402
|
+
readonly accept?: readonly string[] | undefined;
|
|
1403
|
+
readonly options?: readonly {
|
|
1404
|
+
readonly value: string;
|
|
1405
|
+
readonly label: string;
|
|
1406
|
+
readonly description: string;
|
|
1407
|
+
}[] | undefined;
|
|
1408
|
+
readonly items?: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list" | undefined;
|
|
1409
|
+
readonly renamed_from?: string | undefined;
|
|
1410
|
+
readonly max_length?: number | undefined;
|
|
1411
|
+
readonly max_bytes?: number | undefined;
|
|
1412
|
+
}[];
|
|
1413
|
+
readonly relationships: readonly {
|
|
1414
|
+
readonly name: string;
|
|
1415
|
+
readonly description: string;
|
|
1416
|
+
readonly to: string;
|
|
1417
|
+
readonly cardinality: "one" | "many";
|
|
1418
|
+
readonly phrase: readonly [string, string];
|
|
1419
|
+
readonly inverse: string;
|
|
1420
|
+
readonly optional?: boolean | undefined;
|
|
1421
|
+
readonly on?: {
|
|
1422
|
+
readonly property: string;
|
|
1423
|
+
readonly target_property: string;
|
|
1424
|
+
} | undefined;
|
|
1425
|
+
readonly ordered?: boolean | undefined;
|
|
1426
|
+
readonly on_delete?: "cascade" | "restrict" | "set_null" | undefined;
|
|
1427
|
+
}[];
|
|
1428
|
+
readonly indexes: readonly {
|
|
1429
|
+
readonly properties: readonly string[];
|
|
1430
|
+
readonly unique: boolean;
|
|
1431
|
+
}[];
|
|
1432
|
+
readonly actions: readonly {
|
|
1433
|
+
readonly name: string;
|
|
1434
|
+
readonly description: string;
|
|
1435
|
+
readonly input: {
|
|
1436
|
+
readonly [x: string]: Schema.Json;
|
|
1437
|
+
};
|
|
1438
|
+
readonly permission?: string | undefined;
|
|
1439
|
+
readonly retryOnDeadlock?: boolean | undefined;
|
|
1440
|
+
readonly writes?: readonly string[] | undefined;
|
|
1441
|
+
readonly connections?: readonly string[] | undefined;
|
|
1442
|
+
readonly files?: readonly {
|
|
1443
|
+
readonly entity: string;
|
|
1444
|
+
readonly property: string;
|
|
1445
|
+
}[] | undefined;
|
|
1446
|
+
readonly hints?: {
|
|
1447
|
+
readonly readOnly?: boolean | undefined;
|
|
1448
|
+
readonly connectionsReadOnly?: boolean | undefined;
|
|
1449
|
+
readonly destructive?: boolean | undefined;
|
|
1450
|
+
readonly irreversible?: boolean | undefined;
|
|
1451
|
+
readonly idempotent?: boolean | undefined;
|
|
1452
|
+
} | undefined;
|
|
1453
|
+
}[];
|
|
1454
|
+
readonly plural: string;
|
|
1455
|
+
readonly title: string;
|
|
1456
|
+
readonly built_in: boolean;
|
|
1457
|
+
readonly source?: {
|
|
1458
|
+
readonly key: readonly string[];
|
|
1459
|
+
readonly asset: string;
|
|
1460
|
+
readonly currency?: string | undefined;
|
|
1461
|
+
} | undefined;
|
|
1462
|
+
readonly metrics?: readonly {
|
|
1463
|
+
readonly name: string;
|
|
1464
|
+
readonly description: string;
|
|
1465
|
+
readonly label: string;
|
|
1466
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
1467
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
1468
|
+
readonly expression: Schema.Json;
|
|
1469
|
+
readonly balance_over?: string | undefined;
|
|
1470
|
+
}[] | undefined;
|
|
1471
|
+
readonly guide?: string | undefined;
|
|
1472
|
+
readonly writes?: "actions" | undefined;
|
|
1473
|
+
readonly permissions?: {
|
|
1474
|
+
readonly read: string;
|
|
1475
|
+
readonly create?: string | undefined;
|
|
1476
|
+
readonly update?: string | undefined;
|
|
1477
|
+
readonly delete?: string | undefined;
|
|
1478
|
+
readonly link?: string | undefined;
|
|
1479
|
+
readonly unlink?: string | undefined;
|
|
1480
|
+
} | undefined;
|
|
1481
|
+
readonly renamed_from?: string | undefined;
|
|
1482
|
+
}[];
|
|
1483
|
+
readonly roles: readonly {
|
|
1484
|
+
readonly name: string;
|
|
1485
|
+
readonly description: string;
|
|
1486
|
+
readonly built_in: boolean;
|
|
1487
|
+
readonly scopes?: readonly {
|
|
1488
|
+
readonly permission: string;
|
|
1489
|
+
readonly where: {
|
|
1490
|
+
readonly [x: string]: Schema.Json;
|
|
1491
|
+
};
|
|
1492
|
+
}[] | undefined;
|
|
1493
|
+
readonly permissions?: readonly string[] | undefined;
|
|
1494
|
+
}[];
|
|
1495
|
+
readonly chat?: {
|
|
1496
|
+
readonly telegram?: {
|
|
1497
|
+
readonly connection: string;
|
|
1498
|
+
} | undefined;
|
|
1499
|
+
readonly attribution?: {
|
|
1500
|
+
readonly template?: string | undefined;
|
|
1501
|
+
readonly separator?: string | undefined;
|
|
1502
|
+
} | undefined;
|
|
1503
|
+
} | undefined;
|
|
1504
|
+
readonly workflows?: readonly {
|
|
1505
|
+
readonly name: string;
|
|
1506
|
+
readonly description: string;
|
|
1507
|
+
readonly role: string;
|
|
1508
|
+
readonly input: {
|
|
1509
|
+
readonly [x: string]: Schema.Json;
|
|
1510
|
+
};
|
|
1511
|
+
readonly connections: readonly string[];
|
|
1512
|
+
readonly triggers: readonly ({
|
|
1513
|
+
readonly [x: string]: Schema.Json;
|
|
1514
|
+
} | {
|
|
1515
|
+
readonly kind: "cron";
|
|
1516
|
+
readonly name: string;
|
|
1517
|
+
readonly description: string;
|
|
1518
|
+
readonly cron: string;
|
|
1519
|
+
readonly input: Schema.Json;
|
|
1520
|
+
} | {
|
|
1521
|
+
readonly kind: "action";
|
|
1522
|
+
readonly entity: string;
|
|
1523
|
+
readonly name: string;
|
|
1524
|
+
readonly description: string;
|
|
1525
|
+
readonly action?: string | undefined;
|
|
1526
|
+
} | {
|
|
1527
|
+
readonly kind: "webhook";
|
|
1528
|
+
readonly name: string;
|
|
1529
|
+
readonly description: string;
|
|
1530
|
+
readonly signature?: {
|
|
1531
|
+
readonly scheme: string;
|
|
1532
|
+
readonly secret: string;
|
|
1533
|
+
} | undefined;
|
|
1534
|
+
readonly verification?: {
|
|
1535
|
+
readonly scheme: string;
|
|
1536
|
+
readonly verifyToken: string;
|
|
1537
|
+
} | undefined;
|
|
1538
|
+
readonly headers?: readonly string[] | undefined;
|
|
1539
|
+
})[];
|
|
1540
|
+
}[] | undefined;
|
|
1541
|
+
readonly metrics?: readonly {
|
|
1542
|
+
readonly name: string;
|
|
1543
|
+
readonly label: string;
|
|
1544
|
+
readonly description: string;
|
|
1545
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
1546
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
1547
|
+
readonly expression: Schema.Json;
|
|
1548
|
+
readonly inputs: readonly string[];
|
|
1549
|
+
readonly align: readonly {
|
|
1550
|
+
readonly [x: string]: string | null;
|
|
1551
|
+
}[];
|
|
1552
|
+
}[] | undefined;
|
|
1553
|
+
readonly connections?: readonly {
|
|
1554
|
+
readonly description: string;
|
|
1555
|
+
readonly key: string;
|
|
1556
|
+
readonly delivers?: true | undefined;
|
|
1557
|
+
}[] | undefined;
|
|
1558
|
+
readonly feedback?: {
|
|
1559
|
+
readonly files: boolean;
|
|
1560
|
+
readonly builders: readonly string[];
|
|
1561
|
+
readonly enabled: boolean;
|
|
1562
|
+
readonly automaticFailureReports?: boolean | undefined;
|
|
1563
|
+
} | undefined;
|
|
1564
|
+
readonly runtimeCapabilities?: readonly string[] | undefined;
|
|
1565
|
+
readonly executionCompatibility?: {
|
|
1566
|
+
readonly version: number;
|
|
1567
|
+
readonly hash: string;
|
|
1568
|
+
} | undefined;
|
|
1569
|
+
readonly emails?: {
|
|
1570
|
+
readonly [x: string]: {
|
|
1571
|
+
readonly subject: string;
|
|
1572
|
+
readonly action: string;
|
|
1573
|
+
readonly heading: string;
|
|
1574
|
+
readonly eyebrow?: string | undefined;
|
|
1575
|
+
readonly card?: {
|
|
1576
|
+
readonly title: string;
|
|
1577
|
+
readonly detail?: string | undefined;
|
|
1578
|
+
} | undefined;
|
|
1579
|
+
readonly note?: string | undefined;
|
|
1580
|
+
readonly paragraphs?: readonly string[] | undefined;
|
|
1581
|
+
readonly footer?: string | undefined;
|
|
1582
|
+
readonly reply_to?: string | undefined;
|
|
1583
|
+
};
|
|
1584
|
+
} | undefined;
|
|
1585
|
+
readonly sign_in?: {
|
|
1586
|
+
readonly policy: string;
|
|
1587
|
+
readonly browser?: {
|
|
1588
|
+
readonly methods: readonly string[];
|
|
1589
|
+
readonly primary: string;
|
|
1590
|
+
readonly auto_redirect: boolean;
|
|
1591
|
+
readonly local?: {
|
|
1592
|
+
readonly port: number;
|
|
1593
|
+
} | undefined;
|
|
1594
|
+
} | undefined;
|
|
1595
|
+
readonly channels?: {
|
|
1596
|
+
readonly [x: string]: unknown;
|
|
1597
|
+
} | undefined;
|
|
1598
|
+
readonly on_new_user?: string | undefined;
|
|
1599
|
+
readonly code_link?: boolean | undefined;
|
|
1600
|
+
} | undefined;
|
|
1601
|
+
} | {
|
|
1602
|
+
readonly version: number;
|
|
1603
|
+
readonly hash: string;
|
|
1604
|
+
readonly entities: readonly {
|
|
1605
|
+
readonly id: string;
|
|
1606
|
+
readonly name: string;
|
|
1607
|
+
readonly description: string;
|
|
1608
|
+
readonly label: string;
|
|
1609
|
+
readonly properties: readonly {
|
|
1610
|
+
readonly optional: boolean;
|
|
1611
|
+
readonly name: string;
|
|
1612
|
+
readonly label: string;
|
|
1613
|
+
readonly type: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list";
|
|
1614
|
+
readonly unique: boolean;
|
|
1615
|
+
readonly managed: boolean;
|
|
1616
|
+
readonly max?: number | undefined;
|
|
1617
|
+
readonly description?: string | undefined;
|
|
1618
|
+
readonly default?: Schema.Json | undefined;
|
|
1619
|
+
readonly min?: number | undefined;
|
|
1620
|
+
readonly column?: string | undefined;
|
|
1621
|
+
readonly renamedFrom?: string | undefined;
|
|
1622
|
+
readonly scope?: readonly string[] | undefined;
|
|
1623
|
+
readonly display?: string | undefined;
|
|
1624
|
+
readonly maxLength?: number | undefined;
|
|
1625
|
+
readonly accept?: readonly string[] | undefined;
|
|
1626
|
+
readonly maxBytes?: number | undefined;
|
|
1627
|
+
readonly options?: readonly {
|
|
1628
|
+
readonly value: string;
|
|
1629
|
+
readonly label: string;
|
|
1630
|
+
readonly description: string;
|
|
1631
|
+
}[] | undefined;
|
|
1632
|
+
readonly items?: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list" | undefined;
|
|
1633
|
+
}[];
|
|
1634
|
+
readonly relationships: readonly {
|
|
1635
|
+
readonly name: string;
|
|
1636
|
+
readonly description: string;
|
|
1637
|
+
readonly to: string;
|
|
1638
|
+
readonly cardinality: "one" | "many";
|
|
1639
|
+
readonly phrase: readonly [string, string];
|
|
1640
|
+
readonly inverse: string;
|
|
1641
|
+
readonly optional?: boolean | undefined;
|
|
1642
|
+
readonly on?: {
|
|
1643
|
+
readonly property: string;
|
|
1644
|
+
readonly targetProperty: string;
|
|
1645
|
+
} | undefined;
|
|
1646
|
+
readonly onDelete?: "setNull" | "cascade" | "restrict" | undefined;
|
|
1647
|
+
readonly ordered?: boolean | undefined;
|
|
1648
|
+
}[];
|
|
1649
|
+
readonly indexes: readonly {
|
|
1650
|
+
readonly properties: readonly string[];
|
|
1651
|
+
readonly unique: boolean;
|
|
1652
|
+
}[];
|
|
1653
|
+
readonly actions: readonly {
|
|
1654
|
+
readonly name: string;
|
|
1655
|
+
readonly description: string;
|
|
1656
|
+
readonly input: {
|
|
1657
|
+
readonly [x: string]: Schema.Json;
|
|
1658
|
+
};
|
|
1659
|
+
readonly permission?: string | undefined;
|
|
1660
|
+
readonly retryOnDeadlock?: boolean | undefined;
|
|
1661
|
+
readonly writes?: readonly string[] | undefined;
|
|
1662
|
+
readonly connections?: readonly string[] | undefined;
|
|
1663
|
+
readonly files?: readonly {
|
|
1664
|
+
readonly entity: string;
|
|
1665
|
+
readonly property: string;
|
|
1666
|
+
}[] | undefined;
|
|
1667
|
+
readonly hints?: {
|
|
1668
|
+
readonly readOnly?: boolean | undefined;
|
|
1669
|
+
readonly connectionsReadOnly?: boolean | undefined;
|
|
1670
|
+
readonly destructive?: boolean | undefined;
|
|
1671
|
+
readonly irreversible?: boolean | undefined;
|
|
1672
|
+
readonly idempotent?: boolean | undefined;
|
|
1673
|
+
} | undefined;
|
|
1674
|
+
}[];
|
|
1675
|
+
readonly plural: string;
|
|
1676
|
+
readonly title: string;
|
|
1677
|
+
readonly builtIn: boolean;
|
|
1678
|
+
readonly source?: {
|
|
1679
|
+
readonly key: readonly string[];
|
|
1680
|
+
readonly asset: string;
|
|
1681
|
+
readonly currency?: string | undefined;
|
|
1682
|
+
} | undefined;
|
|
1683
|
+
readonly metrics?: readonly {
|
|
1684
|
+
readonly name: string;
|
|
1685
|
+
readonly description: string;
|
|
1686
|
+
readonly label: string;
|
|
1687
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
1688
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
1689
|
+
readonly expression: Schema.Json;
|
|
1690
|
+
readonly balanceOver?: string | undefined;
|
|
1691
|
+
}[] | undefined;
|
|
1692
|
+
readonly renamedFrom?: string | undefined;
|
|
1693
|
+
readonly guide?: string | undefined;
|
|
1694
|
+
readonly writes?: "actions" | undefined;
|
|
1695
|
+
readonly permissions?: {
|
|
1696
|
+
readonly read: string;
|
|
1697
|
+
readonly create?: string | undefined;
|
|
1698
|
+
readonly update?: string | undefined;
|
|
1699
|
+
readonly delete?: string | undefined;
|
|
1700
|
+
readonly link?: string | undefined;
|
|
1701
|
+
readonly unlink?: string | undefined;
|
|
1702
|
+
} | undefined;
|
|
1703
|
+
}[];
|
|
1704
|
+
readonly roles: readonly {
|
|
1705
|
+
readonly name: string;
|
|
1706
|
+
readonly description: string;
|
|
1707
|
+
readonly builtIn: boolean;
|
|
1708
|
+
readonly scopes?: readonly {
|
|
1709
|
+
readonly permission: string;
|
|
1710
|
+
readonly where: {
|
|
1711
|
+
readonly [x: string]: Schema.Json;
|
|
1712
|
+
};
|
|
1713
|
+
}[] | undefined;
|
|
1714
|
+
readonly permissions?: readonly string[] | undefined;
|
|
1715
|
+
}[];
|
|
1716
|
+
readonly chat?: {
|
|
1717
|
+
readonly telegram?: {
|
|
1718
|
+
readonly connection: string;
|
|
1719
|
+
} | undefined;
|
|
1720
|
+
readonly attribution?: {
|
|
1721
|
+
readonly template?: string | undefined;
|
|
1722
|
+
readonly separator?: string | undefined;
|
|
1723
|
+
} | undefined;
|
|
1724
|
+
} | undefined;
|
|
1725
|
+
readonly workflows?: readonly {
|
|
1726
|
+
readonly name: string;
|
|
1727
|
+
readonly description: string;
|
|
1728
|
+
readonly role: string;
|
|
1729
|
+
readonly input: {
|
|
1730
|
+
readonly [x: string]: Schema.Json;
|
|
1731
|
+
};
|
|
1732
|
+
readonly connections: readonly string[];
|
|
1733
|
+
readonly triggers: readonly ({
|
|
1734
|
+
readonly [x: string]: Schema.Json;
|
|
1735
|
+
} | {
|
|
1736
|
+
readonly kind: "cron";
|
|
1737
|
+
readonly name: string;
|
|
1738
|
+
readonly description: string;
|
|
1739
|
+
readonly cron: string;
|
|
1740
|
+
readonly input: Schema.Json;
|
|
1741
|
+
} | {
|
|
1742
|
+
readonly kind: "action";
|
|
1743
|
+
readonly entity: string;
|
|
1744
|
+
readonly name: string;
|
|
1745
|
+
readonly description: string;
|
|
1746
|
+
readonly action?: string | undefined;
|
|
1747
|
+
} | {
|
|
1748
|
+
readonly kind: "webhook";
|
|
1749
|
+
readonly name: string;
|
|
1750
|
+
readonly description: string;
|
|
1751
|
+
readonly signature?: {
|
|
1752
|
+
readonly scheme: string;
|
|
1753
|
+
readonly secret: string;
|
|
1754
|
+
} | undefined;
|
|
1755
|
+
readonly verification?: {
|
|
1756
|
+
readonly scheme: string;
|
|
1757
|
+
readonly verifyToken: string;
|
|
1758
|
+
} | undefined;
|
|
1759
|
+
readonly headers?: readonly string[] | undefined;
|
|
1760
|
+
})[];
|
|
1761
|
+
}[] | undefined;
|
|
1762
|
+
readonly metrics?: readonly {
|
|
1763
|
+
readonly name: string;
|
|
1764
|
+
readonly label: string;
|
|
1765
|
+
readonly description: string;
|
|
1766
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
1767
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
1768
|
+
readonly expression: Schema.Json;
|
|
1769
|
+
readonly inputs: readonly string[];
|
|
1770
|
+
readonly align: readonly {
|
|
1771
|
+
readonly [x: string]: string | null;
|
|
1772
|
+
}[];
|
|
1773
|
+
}[] | undefined;
|
|
1774
|
+
readonly connections?: readonly {
|
|
1775
|
+
readonly description: string;
|
|
1776
|
+
readonly key: string;
|
|
1777
|
+
readonly delivers?: true | undefined;
|
|
1778
|
+
}[] | undefined;
|
|
1779
|
+
readonly feedback?: {
|
|
1780
|
+
readonly files: boolean;
|
|
1781
|
+
readonly builders: readonly string[];
|
|
1782
|
+
readonly enabled: boolean;
|
|
1783
|
+
readonly automaticFailureReports?: boolean | undefined;
|
|
1784
|
+
} | undefined;
|
|
1785
|
+
readonly runtimeCapabilities?: readonly string[] | undefined;
|
|
1786
|
+
readonly executionCompatibility?: {
|
|
1787
|
+
readonly version: number;
|
|
1788
|
+
readonly hash: string;
|
|
1789
|
+
} | undefined;
|
|
1790
|
+
readonly signIn?: {
|
|
1791
|
+
readonly policy: string;
|
|
1792
|
+
readonly browser?: {
|
|
1793
|
+
readonly methods: readonly string[];
|
|
1794
|
+
readonly primary: string;
|
|
1795
|
+
readonly auto_redirect: boolean;
|
|
1796
|
+
readonly local?: {
|
|
1797
|
+
readonly port: number;
|
|
1798
|
+
} | undefined;
|
|
1799
|
+
} | undefined;
|
|
1800
|
+
readonly channels?: {
|
|
1801
|
+
readonly [x: string]: unknown;
|
|
1802
|
+
} | undefined;
|
|
1803
|
+
readonly on_new_user?: string | undefined;
|
|
1804
|
+
readonly code_link?: boolean | undefined;
|
|
1805
|
+
} | undefined;
|
|
1806
|
+
readonly emails?: {
|
|
1807
|
+
readonly [x: string]: {
|
|
1808
|
+
readonly subject: string;
|
|
1809
|
+
readonly action: string;
|
|
1810
|
+
readonly heading: string;
|
|
1811
|
+
readonly eyebrow?: string | undefined;
|
|
1812
|
+
readonly card?: {
|
|
1813
|
+
readonly title: string;
|
|
1814
|
+
readonly detail?: string | undefined;
|
|
1815
|
+
} | undefined;
|
|
1816
|
+
readonly note?: string | undefined;
|
|
1817
|
+
readonly paragraphs?: readonly string[] | undefined;
|
|
1818
|
+
readonly footer?: string | undefined;
|
|
1819
|
+
readonly reply_to?: string | undefined;
|
|
1820
|
+
};
|
|
1821
|
+
} | undefined;
|
|
1822
|
+
}, readonly [Schema.Union<readonly [Schema.encodeKeys<Schema.Struct<{
|
|
1823
|
+
readonly entities: Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
1824
|
+
readonly metrics: Schema.optionalKey<Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
1825
|
+
readonly name: Schema.String;
|
|
1826
|
+
readonly label: Schema.String;
|
|
1827
|
+
readonly description: Schema.String;
|
|
1828
|
+
readonly unit: Schema.Literals<readonly ["number", "currency", "ratio", "percent"]>;
|
|
1829
|
+
readonly format: Schema.Literals<readonly ["decimal", "currency", "percent"]>;
|
|
1830
|
+
readonly expression: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
1831
|
+
/**
|
|
1832
|
+
* The column of the date or timestamp property a balance metric snapshots over; absent for
|
|
1833
|
+
* additive metrics and in manifests before version 7. `balance_over` on the wire.
|
|
1834
|
+
*/
|
|
1835
|
+
readonly balanceOver: Schema.optionalKey<Schema.String>;
|
|
1836
|
+
}>, {
|
|
1837
|
+
readonly balanceOver: "balance_over";
|
|
1838
|
+
}>>>;
|
|
1839
|
+
readonly properties: Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
1840
|
+
readonly column: Schema.optionalKey<Schema.String>;
|
|
1841
|
+
readonly scope: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1842
|
+
readonly name: Schema.String;
|
|
1843
|
+
readonly type: Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>;
|
|
1844
|
+
readonly label: Schema.String;
|
|
1845
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
1846
|
+
readonly optional: Schema.Boolean;
|
|
1847
|
+
readonly unique: Schema.Boolean;
|
|
1848
|
+
readonly managed: Schema.Boolean;
|
|
1849
|
+
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
1850
|
+
readonly display: Schema.optionalKey<Schema.String>;
|
|
1851
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
1852
|
+
readonly min: Schema.optionalKey<Schema.Number>;
|
|
1853
|
+
readonly max: Schema.optionalKey<Schema.Number>;
|
|
1854
|
+
readonly maxLength: Schema.optionalKey<Schema.Number>;
|
|
1855
|
+
readonly accept: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1856
|
+
readonly maxBytes: Schema.optionalKey<Schema.Number>;
|
|
1857
|
+
readonly options: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
1858
|
+
readonly value: Schema.String;
|
|
1859
|
+
readonly label: Schema.String;
|
|
1860
|
+
readonly description: Schema.String;
|
|
1861
|
+
}>>>;
|
|
1862
|
+
/** The item type of a `list`, the built-in user's `roles`, which has no column. */
|
|
1863
|
+
readonly items: Schema.optionalKey<Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>>;
|
|
1864
|
+
}>, {
|
|
1865
|
+
readonly renamedFrom: "renamed_from";
|
|
1866
|
+
readonly maxLength: "max_length";
|
|
1867
|
+
readonly maxBytes: "max_bytes";
|
|
1868
|
+
}>>;
|
|
1869
|
+
readonly relationships: Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
1870
|
+
readonly on: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
1871
|
+
readonly property: Schema.String;
|
|
1872
|
+
readonly targetProperty: Schema.String;
|
|
1873
|
+
}>, {
|
|
1874
|
+
readonly targetProperty: "target_property";
|
|
1875
|
+
}>>;
|
|
1876
|
+
readonly onDelete: Schema.optionalKey<Schema.decodeTo<Schema.Literals<readonly ["setNull", "cascade", "restrict"]>, Schema.Literals<readonly ["set_null", "cascade", "restrict"]>, never, never>>;
|
|
1877
|
+
readonly name: Schema.String;
|
|
1878
|
+
readonly to: Schema.String;
|
|
1879
|
+
readonly inverse: Schema.String;
|
|
1880
|
+
readonly cardinality: Schema.Literals<readonly ["one", "many"]>;
|
|
1881
|
+
/** `rel.one` between stored entities only. */
|
|
1882
|
+
readonly optional: Schema.optionalKey<Schema.Boolean>;
|
|
1883
|
+
/** `rel.many` only. */
|
|
1884
|
+
readonly ordered: Schema.optionalKey<Schema.Boolean>;
|
|
1885
|
+
/** Forward and inverse phrases; unphrased directions read "has". */
|
|
1886
|
+
readonly phrase: Schema.Tuple<readonly [Schema.String, Schema.String]>;
|
|
1887
|
+
readonly description: Schema.String;
|
|
1888
|
+
}>, {
|
|
1889
|
+
readonly onDelete: "on_delete";
|
|
1890
|
+
}>>;
|
|
1891
|
+
readonly source: Schema.optionalKey<Schema.Struct<{
|
|
1892
|
+
readonly asset: Schema.String;
|
|
1893
|
+
readonly key: Schema.$Array<Schema.String>;
|
|
1894
|
+
readonly currency: Schema.optionalKey<Schema.String>;
|
|
1895
|
+
}>>;
|
|
1896
|
+
readonly id: Schema.String;
|
|
1897
|
+
readonly name: Schema.String;
|
|
1898
|
+
readonly label: Schema.String;
|
|
1899
|
+
readonly plural: Schema.String;
|
|
1900
|
+
readonly title: Schema.String;
|
|
1901
|
+
readonly description: Schema.String;
|
|
1902
|
+
readonly builtIn: Schema.Boolean;
|
|
1903
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
1904
|
+
readonly guide: Schema.optionalKey<Schema.String>;
|
|
1905
|
+
readonly indexes: Schema.$Array<Schema.Struct<{
|
|
1906
|
+
readonly properties: Schema.$Array<Schema.String>;
|
|
1907
|
+
readonly unique: Schema.Boolean;
|
|
1908
|
+
}>>;
|
|
1909
|
+
readonly actions: Schema.$Array<Schema.Struct<{
|
|
1910
|
+
readonly name: Schema.String;
|
|
1911
|
+
readonly description: Schema.String;
|
|
1912
|
+
/**
|
|
1913
|
+
* The permission a principal needs to run the action, for example `lead:changeStatus`. Always
|
|
1914
|
+
* written; absent from version 1 manifests, where it reads as `<entity>:<action name>`.
|
|
1915
|
+
*/
|
|
1916
|
+
readonly permission: Schema.optionalKey<Schema.String>;
|
|
1917
|
+
/** JSON Schema (draft 2020-12) of the input object. */
|
|
1918
|
+
readonly input: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
1919
|
+
/** Opt-in SQL handler replay after a confirmed deadlock rollback; absent means disabled. */
|
|
1920
|
+
readonly retryOnDeadlock: Schema.optionalKey<Schema.Boolean>;
|
|
1921
|
+
/**
|
|
1922
|
+
* The entities the handler writes, by name, as the action declares them; the runtime refuses any
|
|
1923
|
+
* other write. Absent means it declares none and may write any entity; `[]` writes nothing.
|
|
1924
|
+
*/
|
|
1925
|
+
readonly writes: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1926
|
+
/**
|
|
1927
|
+
* The keys of the workspace connections the action calls before its transaction. Written only
|
|
1928
|
+
* when there are some; absent reads as none.
|
|
1929
|
+
*/
|
|
1930
|
+
readonly connections: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1931
|
+
/** File writes declared in code; absence grants preparation no staging targets. */
|
|
1932
|
+
readonly files: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
1933
|
+
readonly entity: Schema.String;
|
|
1934
|
+
readonly property: Schema.String;
|
|
1935
|
+
}>>>;
|
|
1936
|
+
/**
|
|
1937
|
+
* How the action behaves, as MCP tool annotations tell agents. Written only when the action
|
|
1938
|
+
* declares hints; absent safety labels require agent confirmation for compatibility.
|
|
1939
|
+
*/
|
|
1940
|
+
readonly hints: Schema.optionalKey<Schema.Struct<{
|
|
1941
|
+
readonly readOnly: Schema.optionalKey<Schema.Boolean>;
|
|
1942
|
+
readonly connectionsReadOnly: Schema.optionalKey<Schema.Boolean>;
|
|
1943
|
+
readonly destructive: Schema.optionalKey<Schema.Boolean>;
|
|
1944
|
+
readonly irreversible: Schema.optionalKey<Schema.Boolean>;
|
|
1945
|
+
readonly idempotent: Schema.optionalKey<Schema.Boolean>;
|
|
1946
|
+
}>>;
|
|
1947
|
+
}>>;
|
|
1948
|
+
/** Always written; absent from version 1 manifests. */
|
|
1949
|
+
readonly permissions: Schema.optionalKey<Schema.Struct<{
|
|
1950
|
+
readonly read: Schema.String;
|
|
1951
|
+
readonly create: Schema.optionalKey<Schema.String>;
|
|
1952
|
+
readonly update: Schema.optionalKey<Schema.String>;
|
|
1953
|
+
readonly delete: Schema.optionalKey<Schema.String>;
|
|
1954
|
+
readonly link: Schema.optionalKey<Schema.String>;
|
|
1955
|
+
readonly unlink: Schema.optionalKey<Schema.String>;
|
|
1956
|
+
}>>;
|
|
1957
|
+
/**
|
|
1958
|
+
* `"actions"` when only the entity's authored actions write its records, so it has no generated
|
|
1959
|
+
* writes and its `permissions` hold only `read`. Absent means the generated writes exist.
|
|
1960
|
+
*/
|
|
1961
|
+
readonly writes: Schema.optionalKey<Schema.Literal<"actions">>;
|
|
1962
|
+
}>, {
|
|
1963
|
+
readonly builtIn: "built_in";
|
|
1964
|
+
readonly renamedFrom: "renamed_from";
|
|
1965
|
+
}>>;
|
|
1966
|
+
readonly roles: Schema.$Array<Schema.encodeKeys<Schema.Struct<{
|
|
1967
|
+
readonly name: Schema.String;
|
|
1968
|
+
readonly description: Schema.String;
|
|
1969
|
+
readonly builtIn: Schema.Boolean;
|
|
1970
|
+
/**
|
|
1971
|
+
* What the role may do, wildcards included; for the built-in `member`, what every active app user
|
|
1972
|
+
* may do. Always written; absent from version 1 manifests.
|
|
1973
|
+
*/
|
|
1974
|
+
readonly permissions: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1975
|
+
/**
|
|
1976
|
+
* The permissions the role holds only for the records their `where` matches, since version 10.
|
|
1977
|
+
* Written only when there are some; absent reads as none.
|
|
1978
|
+
*/
|
|
1979
|
+
readonly scopes: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
1980
|
+
readonly permission: Schema.String;
|
|
1981
|
+
readonly where: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
1982
|
+
}>>>;
|
|
1983
|
+
}>, {
|
|
1984
|
+
readonly builtIn: "built_in";
|
|
1985
|
+
}>>;
|
|
1986
|
+
/** Resolved feedback settings since version 11; absence preserves historical opt-in behavior. */
|
|
1987
|
+
readonly feedback: Schema.optionalKey<Schema.Struct<{
|
|
1988
|
+
readonly enabled: Schema.Boolean;
|
|
1989
|
+
readonly files: Schema.Boolean;
|
|
1990
|
+
readonly builders: Schema.$Array<Schema.String>;
|
|
1991
|
+
readonly automaticFailureReports: Schema.optionalKey<Schema.Boolean>;
|
|
1992
|
+
}>>;
|
|
1993
|
+
readonly runtimeCapabilities: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1994
|
+
/** Written by ontology SDKs 0.86.0 to 0.88.0 and never read; decoded so their manifests encode back. */
|
|
1995
|
+
readonly executionCompatibility: Schema.optionalKey<Schema.Struct<{
|
|
1996
|
+
readonly version: Schema.Int;
|
|
1997
|
+
readonly hash: Schema.String;
|
|
1998
|
+
}>>;
|
|
1999
|
+
readonly version: Schema.Int;
|
|
2000
|
+
/** `sha256:` and the hex digest of the canonical JSON of the manifest without `hash`. */
|
|
2001
|
+
readonly hash: Schema.String;
|
|
2002
|
+
/** Always written; absent from manifests built before sign-in policies, which read as `invited`. */
|
|
2003
|
+
readonly signIn: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
2004
|
+
readonly browser: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
2005
|
+
readonly methods: Schema.$Array<Schema.String>;
|
|
2006
|
+
readonly primary: Schema.String;
|
|
2007
|
+
readonly autoRedirect: Schema.Boolean;
|
|
2008
|
+
readonly local: Schema.optionalKey<Schema.Struct<{
|
|
2009
|
+
readonly port: Schema.Int;
|
|
2010
|
+
}>>;
|
|
2011
|
+
}>, {
|
|
2012
|
+
readonly autoRedirect: "auto_redirect";
|
|
2013
|
+
}>>;
|
|
2014
|
+
readonly policy: Schema.String;
|
|
2015
|
+
readonly channels: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>;
|
|
2016
|
+
readonly onNewUser: Schema.optionalKey<Schema.String>;
|
|
2017
|
+
readonly codeLink: Schema.optionalKey<Schema.Boolean>;
|
|
2018
|
+
}>, {
|
|
2019
|
+
readonly onNewUser: "on_new_user";
|
|
2020
|
+
readonly codeLink: "code_link";
|
|
2021
|
+
}>>;
|
|
2022
|
+
/** The workspace's own emails by wire name. Written only when there are some; absent reads as none. */
|
|
2023
|
+
readonly emails: Schema.optionalKey<Schema.$Record<Schema.String, Schema.encodeKeys<Schema.Struct<{
|
|
2024
|
+
readonly subject: Schema.String;
|
|
2025
|
+
readonly eyebrow: Schema.optionalKey<Schema.String>;
|
|
2026
|
+
readonly heading: Schema.String;
|
|
2027
|
+
readonly card: Schema.optionalKey<Schema.Struct<{
|
|
2028
|
+
readonly title: Schema.String;
|
|
2029
|
+
readonly detail: Schema.optionalKey<Schema.String>;
|
|
2030
|
+
}>>;
|
|
2031
|
+
readonly note: Schema.optionalKey<Schema.String>;
|
|
2032
|
+
readonly paragraphs: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2033
|
+
readonly action: Schema.String;
|
|
2034
|
+
readonly footer: Schema.optionalKey<Schema.String>;
|
|
2035
|
+
readonly replyTo: Schema.optionalKey<Schema.String>;
|
|
2036
|
+
}>, {
|
|
2037
|
+
readonly replyTo: "reply_to";
|
|
2038
|
+
}>>>;
|
|
2039
|
+
/** The connections the actions call. Written only when there are some; absent reads as none. */
|
|
2040
|
+
readonly connections: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2041
|
+
readonly key: Schema.String;
|
|
2042
|
+
readonly description: Schema.String;
|
|
2043
|
+
/** Written only when the ontology sends data out through the connection. */
|
|
2044
|
+
readonly delivers: Schema.optionalKey<Schema.Literal<true>>;
|
|
2045
|
+
}>>>;
|
|
2046
|
+
readonly chat: Schema.optionalKey<Schema.Struct<{
|
|
2047
|
+
readonly telegram: Schema.optionalKey<Schema.Struct<{
|
|
2048
|
+
readonly connection: Schema.String;
|
|
2049
|
+
}>>;
|
|
2050
|
+
readonly attribution: Schema.optionalKey<Schema.Struct<{
|
|
2051
|
+
readonly template: Schema.optionalKey<Schema.String>;
|
|
2052
|
+
readonly separator: Schema.optionalKey<Schema.String>;
|
|
2053
|
+
}>>;
|
|
2054
|
+
}>>;
|
|
2055
|
+
/**
|
|
2056
|
+
* The metrics of the model, since version 8. Written only when there are some; absent reads as
|
|
2057
|
+
* none.
|
|
2058
|
+
*/
|
|
2059
|
+
readonly metrics: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2060
|
+
readonly name: Schema.String;
|
|
2061
|
+
readonly label: Schema.String;
|
|
2062
|
+
readonly description: Schema.String;
|
|
2063
|
+
readonly unit: Schema.Literals<readonly ["number", "currency", "ratio", "percent"]>;
|
|
2064
|
+
readonly format: Schema.Literals<readonly ["decimal", "currency", "percent"]>;
|
|
2065
|
+
readonly expression: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
2066
|
+
/** The entity metrics the expression reads, `entity.metric`, each once, in reading order. */
|
|
2067
|
+
readonly inputs: Schema.$Array<Schema.String>;
|
|
2068
|
+
/**
|
|
2069
|
+
* Groups of properties that stand for one another: each names every entity the metric reads,
|
|
2070
|
+
* with a property or `null` for an entity without a counterpart.
|
|
2071
|
+
*/
|
|
2072
|
+
readonly align: Schema.$Array<Schema.$Record<Schema.String, Schema.NullOr<Schema.String>>>;
|
|
2073
|
+
}>>>;
|
|
2074
|
+
/**
|
|
2075
|
+
* The workflows, since version 9. Written only when there are some; absent reads as none.
|
|
2076
|
+
*/
|
|
2077
|
+
readonly workflows: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2078
|
+
readonly name: Schema.String;
|
|
2079
|
+
readonly description: Schema.String;
|
|
2080
|
+
readonly role: Schema.String;
|
|
2081
|
+
readonly input: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
2082
|
+
readonly connections: Schema.$Array<Schema.String>;
|
|
2083
|
+
readonly triggers: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
2084
|
+
readonly kind: Schema.Literal<"cron">;
|
|
2085
|
+
readonly name: Schema.String;
|
|
2086
|
+
readonly description: Schema.String;
|
|
2087
|
+
/** Five fields, UTC. */
|
|
2088
|
+
readonly cron: Schema.String;
|
|
2089
|
+
readonly input: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
2090
|
+
}>, Schema.Struct<{
|
|
2091
|
+
readonly kind: Schema.Literal<"action">;
|
|
2092
|
+
readonly name: Schema.String;
|
|
2093
|
+
readonly description: Schema.String;
|
|
2094
|
+
readonly entity: Schema.String;
|
|
2095
|
+
readonly action: Schema.optionalKey<Schema.String>;
|
|
2096
|
+
}>, Schema.Struct<{
|
|
2097
|
+
readonly kind: Schema.Literal<"webhook">;
|
|
2098
|
+
readonly name: Schema.String;
|
|
2099
|
+
readonly description: Schema.String;
|
|
2100
|
+
readonly signature: Schema.optionalKey<Schema.Struct<{
|
|
2101
|
+
readonly scheme: Schema.String;
|
|
2102
|
+
readonly secret: Schema.String;
|
|
2103
|
+
}>>;
|
|
2104
|
+
readonly verification: Schema.optionalKey<Schema.Struct<{
|
|
2105
|
+
readonly scheme: Schema.String;
|
|
2106
|
+
readonly verifyToken: Schema.String;
|
|
2107
|
+
}>>;
|
|
2108
|
+
readonly headers: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2109
|
+
}>, Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>>;
|
|
2110
|
+
}>>>;
|
|
2111
|
+
}>, {
|
|
2112
|
+
readonly signIn: "sign_in";
|
|
2113
|
+
}>, Schema.Struct<{
|
|
2114
|
+
/** Resolved feedback settings since version 11; absence preserves historical opt-in behavior. */
|
|
2115
|
+
readonly feedback: Schema.optionalKey<Schema.Struct<{
|
|
2116
|
+
readonly enabled: Schema.Boolean;
|
|
2117
|
+
readonly files: Schema.Boolean;
|
|
2118
|
+
readonly builders: Schema.$Array<Schema.String>;
|
|
2119
|
+
readonly automaticFailureReports: Schema.optionalKey<Schema.Boolean>;
|
|
2120
|
+
}>>;
|
|
2121
|
+
readonly runtimeCapabilities: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2122
|
+
/** Written by ontology SDKs 0.86.0 to 0.88.0 and never read; decoded so their manifests encode back. */
|
|
2123
|
+
readonly executionCompatibility: Schema.optionalKey<Schema.Struct<{
|
|
2124
|
+
readonly version: Schema.Int;
|
|
2125
|
+
readonly hash: Schema.String;
|
|
2126
|
+
}>>;
|
|
2127
|
+
readonly version: Schema.Int;
|
|
2128
|
+
/** `sha256:` and the hex digest of the canonical JSON of the manifest without `hash`. */
|
|
2129
|
+
readonly hash: Schema.String;
|
|
2130
|
+
readonly entities: Schema.$Array<Schema.Struct<{
|
|
2131
|
+
readonly source: Schema.optionalKey<Schema.Struct<{
|
|
2132
|
+
readonly asset: Schema.String;
|
|
2133
|
+
readonly key: Schema.$Array<Schema.String>;
|
|
2134
|
+
readonly currency: Schema.optionalKey<Schema.String>;
|
|
2135
|
+
}>>;
|
|
2136
|
+
readonly metrics: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2137
|
+
readonly name: Schema.String;
|
|
2138
|
+
readonly label: Schema.String;
|
|
2139
|
+
readonly description: Schema.String;
|
|
2140
|
+
readonly unit: Schema.Literals<readonly ["number", "currency", "ratio", "percent"]>;
|
|
2141
|
+
readonly format: Schema.Literals<readonly ["decimal", "currency", "percent"]>;
|
|
2142
|
+
readonly expression: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
2143
|
+
/**
|
|
2144
|
+
* The column of the date or timestamp property a balance metric snapshots over; absent for
|
|
2145
|
+
* additive metrics and in manifests before version 7. `balance_over` on the wire.
|
|
2146
|
+
*/
|
|
2147
|
+
readonly balanceOver: Schema.optionalKey<Schema.String>;
|
|
2148
|
+
}>>>;
|
|
2149
|
+
readonly id: Schema.String;
|
|
2150
|
+
readonly name: Schema.String;
|
|
2151
|
+
readonly label: Schema.String;
|
|
2152
|
+
readonly plural: Schema.String;
|
|
2153
|
+
readonly title: Schema.String;
|
|
2154
|
+
readonly description: Schema.String;
|
|
2155
|
+
readonly builtIn: Schema.Boolean;
|
|
2156
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
2157
|
+
readonly guide: Schema.optionalKey<Schema.String>;
|
|
2158
|
+
readonly properties: Schema.$Array<Schema.Struct<{
|
|
2159
|
+
readonly column: Schema.optionalKey<Schema.String>;
|
|
2160
|
+
readonly scope: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2161
|
+
readonly name: Schema.String;
|
|
2162
|
+
readonly type: Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>;
|
|
2163
|
+
readonly label: Schema.String;
|
|
2164
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
2165
|
+
readonly optional: Schema.Boolean;
|
|
2166
|
+
readonly unique: Schema.Boolean;
|
|
2167
|
+
readonly managed: Schema.Boolean;
|
|
2168
|
+
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
2169
|
+
readonly display: Schema.optionalKey<Schema.String>;
|
|
2170
|
+
readonly renamedFrom: Schema.optionalKey<Schema.String>;
|
|
2171
|
+
readonly min: Schema.optionalKey<Schema.Number>;
|
|
2172
|
+
readonly max: Schema.optionalKey<Schema.Number>;
|
|
2173
|
+
readonly maxLength: Schema.optionalKey<Schema.Number>;
|
|
2174
|
+
readonly accept: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2175
|
+
readonly maxBytes: Schema.optionalKey<Schema.Number>;
|
|
2176
|
+
readonly options: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2177
|
+
readonly value: Schema.String;
|
|
2178
|
+
readonly label: Schema.String;
|
|
2179
|
+
readonly description: Schema.String;
|
|
2180
|
+
}>>>;
|
|
2181
|
+
/** The item type of a `list`, the built-in user's `roles`, which has no column. */
|
|
2182
|
+
readonly items: Schema.optionalKey<Schema.Literals<readonly ["text", "email", "url", "integer", "number", "boolean", "date", "timestamp", "select", "json", "blob", "list"]>>;
|
|
2183
|
+
}>>;
|
|
2184
|
+
readonly relationships: Schema.$Array<Schema.Struct<{
|
|
2185
|
+
/**
|
|
2186
|
+
* The property pair of a value-matched relationship, one with a warehouse-backed end. Absent
|
|
2187
|
+
* between stored entities, which use a `<name>_id` key instead.
|
|
2188
|
+
*/
|
|
2189
|
+
readonly on: Schema.optionalKey<Schema.Struct<{
|
|
2190
|
+
readonly property: Schema.String;
|
|
2191
|
+
readonly targetProperty: Schema.String;
|
|
2192
|
+
}>>;
|
|
2193
|
+
readonly name: Schema.String;
|
|
2194
|
+
readonly to: Schema.String;
|
|
2195
|
+
readonly inverse: Schema.String;
|
|
2196
|
+
readonly cardinality: Schema.Literals<readonly ["one", "many"]>;
|
|
2197
|
+
/** `rel.one` between stored entities only. */
|
|
2198
|
+
readonly optional: Schema.optionalKey<Schema.Boolean>;
|
|
2199
|
+
/**
|
|
2200
|
+
* `rel.one` between stored entities only. Before version 5, warehouse → stored relationships
|
|
2201
|
+
* carried it too, as `restrict`, though nothing enforced it.
|
|
2202
|
+
*/
|
|
2203
|
+
readonly onDelete: Schema.optionalKey<Schema.Literals<readonly ["setNull", "cascade", "restrict"]>>;
|
|
2204
|
+
/** `rel.many` only. */
|
|
2205
|
+
readonly ordered: Schema.optionalKey<Schema.Boolean>;
|
|
2206
|
+
/** Forward and inverse phrases; unphrased directions read "has". */
|
|
2207
|
+
readonly phrase: Schema.Tuple<readonly [Schema.String, Schema.String]>;
|
|
2208
|
+
readonly description: Schema.String;
|
|
2209
|
+
}>>;
|
|
2210
|
+
readonly indexes: Schema.$Array<Schema.Struct<{
|
|
2211
|
+
readonly properties: Schema.$Array<Schema.String>;
|
|
2212
|
+
readonly unique: Schema.Boolean;
|
|
2213
|
+
}>>;
|
|
2214
|
+
readonly actions: Schema.$Array<Schema.Struct<{
|
|
2215
|
+
readonly name: Schema.String;
|
|
2216
|
+
readonly description: Schema.String;
|
|
2217
|
+
/**
|
|
2218
|
+
* The permission a principal needs to run the action, for example `lead:changeStatus`. Always
|
|
2219
|
+
* written; absent from version 1 manifests, where it reads as `<entity>:<action name>`.
|
|
2220
|
+
*/
|
|
2221
|
+
readonly permission: Schema.optionalKey<Schema.String>;
|
|
2222
|
+
/** JSON Schema (draft 2020-12) of the input object. */
|
|
2223
|
+
readonly input: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
2224
|
+
/** Opt-in SQL handler replay after a confirmed deadlock rollback; absent means disabled. */
|
|
2225
|
+
readonly retryOnDeadlock: Schema.optionalKey<Schema.Boolean>;
|
|
2226
|
+
/**
|
|
2227
|
+
* The entities the handler writes, by name, as the action declares them; the runtime refuses any
|
|
2228
|
+
* other write. Absent means it declares none and may write any entity; `[]` writes nothing.
|
|
2229
|
+
*/
|
|
2230
|
+
readonly writes: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2231
|
+
/**
|
|
2232
|
+
* The keys of the workspace connections the action calls before its transaction. Written only
|
|
2233
|
+
* when there are some; absent reads as none.
|
|
2234
|
+
*/
|
|
2235
|
+
readonly connections: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2236
|
+
/** File writes declared in code; absence grants preparation no staging targets. */
|
|
2237
|
+
readonly files: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2238
|
+
readonly entity: Schema.String;
|
|
2239
|
+
readonly property: Schema.String;
|
|
2240
|
+
}>>>;
|
|
2241
|
+
/**
|
|
2242
|
+
* How the action behaves, as MCP tool annotations tell agents. Written only when the action
|
|
2243
|
+
* declares hints; absent safety labels require agent confirmation for compatibility.
|
|
2244
|
+
*/
|
|
2245
|
+
readonly hints: Schema.optionalKey<Schema.Struct<{
|
|
2246
|
+
readonly readOnly: Schema.optionalKey<Schema.Boolean>;
|
|
2247
|
+
readonly connectionsReadOnly: Schema.optionalKey<Schema.Boolean>;
|
|
2248
|
+
readonly destructive: Schema.optionalKey<Schema.Boolean>;
|
|
2249
|
+
readonly irreversible: Schema.optionalKey<Schema.Boolean>;
|
|
2250
|
+
readonly idempotent: Schema.optionalKey<Schema.Boolean>;
|
|
2251
|
+
}>>;
|
|
2252
|
+
}>>;
|
|
2253
|
+
/** Always written; absent from version 1 manifests. */
|
|
2254
|
+
readonly permissions: Schema.optionalKey<Schema.Struct<{
|
|
2255
|
+
readonly read: Schema.String;
|
|
2256
|
+
readonly create: Schema.optionalKey<Schema.String>;
|
|
2257
|
+
readonly update: Schema.optionalKey<Schema.String>;
|
|
2258
|
+
readonly delete: Schema.optionalKey<Schema.String>;
|
|
2259
|
+
readonly link: Schema.optionalKey<Schema.String>;
|
|
2260
|
+
readonly unlink: Schema.optionalKey<Schema.String>;
|
|
2261
|
+
}>>;
|
|
2262
|
+
/**
|
|
2263
|
+
* `"actions"` when only the entity's authored actions write its records, so it has no generated
|
|
2264
|
+
* writes and its `permissions` hold only `read`. Absent means the generated writes exist.
|
|
2265
|
+
*/
|
|
2266
|
+
readonly writes: Schema.optionalKey<Schema.Literal<"actions">>;
|
|
2267
|
+
}>>;
|
|
2268
|
+
readonly roles: Schema.$Array<Schema.Struct<{
|
|
2269
|
+
readonly name: Schema.String;
|
|
2270
|
+
readonly description: Schema.String;
|
|
2271
|
+
readonly builtIn: Schema.Boolean;
|
|
2272
|
+
/**
|
|
2273
|
+
* What the role may do, wildcards included; for the built-in `member`, what every active app user
|
|
2274
|
+
* may do. Always written; absent from version 1 manifests.
|
|
2275
|
+
*/
|
|
2276
|
+
readonly permissions: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2277
|
+
/**
|
|
2278
|
+
* The permissions the role holds only for the records their `where` matches, since version 10.
|
|
2279
|
+
* Written only when there are some; absent reads as none.
|
|
2280
|
+
*/
|
|
2281
|
+
readonly scopes: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2282
|
+
readonly permission: Schema.String;
|
|
2283
|
+
readonly where: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
2284
|
+
}>>>;
|
|
2285
|
+
}>>;
|
|
2286
|
+
/** Always written; absent from manifests built before sign-in policies, which read as `invited`. */
|
|
2287
|
+
readonly signIn: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
2288
|
+
readonly browser: Schema.optionalKey<Schema.encodeKeys<Schema.Struct<{
|
|
2289
|
+
readonly methods: Schema.$Array<Schema.String>;
|
|
2290
|
+
readonly primary: Schema.String;
|
|
2291
|
+
readonly autoRedirect: Schema.Boolean;
|
|
2292
|
+
readonly local: Schema.optionalKey<Schema.Struct<{
|
|
2293
|
+
readonly port: Schema.Int;
|
|
2294
|
+
}>>;
|
|
2295
|
+
}>, {
|
|
2296
|
+
readonly autoRedirect: "auto_redirect";
|
|
2297
|
+
}>>;
|
|
2298
|
+
readonly policy: Schema.String;
|
|
2299
|
+
readonly channels: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>;
|
|
2300
|
+
readonly onNewUser: Schema.optionalKey<Schema.String>;
|
|
2301
|
+
readonly codeLink: Schema.optionalKey<Schema.Boolean>;
|
|
2302
|
+
}>, {
|
|
2303
|
+
readonly onNewUser: "on_new_user";
|
|
2304
|
+
readonly codeLink: "code_link";
|
|
2305
|
+
}>>;
|
|
2306
|
+
/** The workspace's own emails by wire name. Written only when there are some; absent reads as none. */
|
|
2307
|
+
readonly emails: Schema.optionalKey<Schema.$Record<Schema.String, Schema.encodeKeys<Schema.Struct<{
|
|
2308
|
+
readonly subject: Schema.String;
|
|
2309
|
+
readonly eyebrow: Schema.optionalKey<Schema.String>;
|
|
2310
|
+
readonly heading: Schema.String;
|
|
2311
|
+
readonly card: Schema.optionalKey<Schema.Struct<{
|
|
2312
|
+
readonly title: Schema.String;
|
|
2313
|
+
readonly detail: Schema.optionalKey<Schema.String>;
|
|
2314
|
+
}>>;
|
|
2315
|
+
readonly note: Schema.optionalKey<Schema.String>;
|
|
2316
|
+
readonly paragraphs: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2317
|
+
readonly action: Schema.String;
|
|
2318
|
+
readonly footer: Schema.optionalKey<Schema.String>;
|
|
2319
|
+
readonly replyTo: Schema.optionalKey<Schema.String>;
|
|
2320
|
+
}>, {
|
|
2321
|
+
readonly replyTo: "reply_to";
|
|
2322
|
+
}>>>;
|
|
2323
|
+
/** The connections the actions call. Written only when there are some; absent reads as none. */
|
|
2324
|
+
readonly connections: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2325
|
+
readonly key: Schema.String;
|
|
2326
|
+
readonly description: Schema.String;
|
|
2327
|
+
/** Written only when the ontology sends data out through the connection. */
|
|
2328
|
+
readonly delivers: Schema.optionalKey<Schema.Literal<true>>;
|
|
2329
|
+
}>>>;
|
|
2330
|
+
readonly chat: Schema.optionalKey<Schema.Struct<{
|
|
2331
|
+
readonly telegram: Schema.optionalKey<Schema.Struct<{
|
|
2332
|
+
readonly connection: Schema.String;
|
|
2333
|
+
}>>;
|
|
2334
|
+
readonly attribution: Schema.optionalKey<Schema.Struct<{
|
|
2335
|
+
readonly template: Schema.optionalKey<Schema.String>;
|
|
2336
|
+
readonly separator: Schema.optionalKey<Schema.String>;
|
|
2337
|
+
}>>;
|
|
2338
|
+
}>>;
|
|
2339
|
+
/**
|
|
2340
|
+
* The metrics of the model, since version 8. Written only when there are some; absent reads as
|
|
2341
|
+
* none.
|
|
2342
|
+
*/
|
|
2343
|
+
readonly metrics: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2344
|
+
readonly name: Schema.String;
|
|
2345
|
+
readonly label: Schema.String;
|
|
2346
|
+
readonly description: Schema.String;
|
|
2347
|
+
readonly unit: Schema.Literals<readonly ["number", "currency", "ratio", "percent"]>;
|
|
2348
|
+
readonly format: Schema.Literals<readonly ["decimal", "currency", "percent"]>;
|
|
2349
|
+
readonly expression: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
2350
|
+
/** The entity metrics the expression reads, `entity.metric`, each once, in reading order. */
|
|
2351
|
+
readonly inputs: Schema.$Array<Schema.String>;
|
|
2352
|
+
/**
|
|
2353
|
+
* Groups of properties that stand for one another: each names every entity the metric reads,
|
|
2354
|
+
* with a property or `null` for an entity without a counterpart.
|
|
2355
|
+
*/
|
|
2356
|
+
readonly align: Schema.$Array<Schema.$Record<Schema.String, Schema.NullOr<Schema.String>>>;
|
|
2357
|
+
}>>>;
|
|
2358
|
+
/**
|
|
2359
|
+
* The workflows, since version 9. Written only when there are some; absent reads as none.
|
|
2360
|
+
*/
|
|
2361
|
+
readonly workflows: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
2362
|
+
readonly name: Schema.String;
|
|
2363
|
+
readonly description: Schema.String;
|
|
2364
|
+
readonly role: Schema.String;
|
|
2365
|
+
readonly input: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
|
|
2366
|
+
readonly connections: Schema.$Array<Schema.String>;
|
|
2367
|
+
readonly triggers: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
2368
|
+
readonly kind: Schema.Literal<"cron">;
|
|
2369
|
+
readonly name: Schema.String;
|
|
2370
|
+
readonly description: Schema.String;
|
|
2371
|
+
/** Five fields, UTC. */
|
|
2372
|
+
readonly cron: Schema.String;
|
|
2373
|
+
readonly input: Schema.Codec<Schema.Json, Schema.Json, never, never>;
|
|
2374
|
+
}>, Schema.Struct<{
|
|
2375
|
+
readonly kind: Schema.Literal<"action">;
|
|
2376
|
+
readonly name: Schema.String;
|
|
2377
|
+
readonly description: Schema.String;
|
|
2378
|
+
readonly entity: Schema.String;
|
|
2379
|
+
readonly action: Schema.optionalKey<Schema.String>;
|
|
2380
|
+
}>, Schema.Struct<{
|
|
2381
|
+
readonly kind: Schema.Literal<"webhook">;
|
|
2382
|
+
readonly name: Schema.String;
|
|
2383
|
+
readonly description: Schema.String;
|
|
2384
|
+
readonly signature: Schema.optionalKey<Schema.Struct<{
|
|
2385
|
+
readonly scheme: Schema.String;
|
|
2386
|
+
readonly secret: Schema.String;
|
|
2387
|
+
}>>;
|
|
2388
|
+
readonly verification: Schema.optionalKey<Schema.Struct<{
|
|
2389
|
+
readonly scheme: Schema.String;
|
|
2390
|
+
readonly verifyToken: Schema.String;
|
|
2391
|
+
}>>;
|
|
2392
|
+
readonly headers: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
2393
|
+
}>, Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>>;
|
|
2394
|
+
}>>>;
|
|
2395
|
+
}>]>], {
|
|
2396
|
+
readonly version: number;
|
|
2397
|
+
readonly hash: string;
|
|
2398
|
+
readonly entities: readonly {
|
|
2399
|
+
readonly id: string;
|
|
2400
|
+
readonly name: string;
|
|
2401
|
+
readonly description: string;
|
|
2402
|
+
readonly label: string;
|
|
2403
|
+
readonly properties: readonly {
|
|
2404
|
+
readonly optional: boolean;
|
|
2405
|
+
readonly name: string;
|
|
2406
|
+
readonly label: string;
|
|
2407
|
+
readonly type: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list";
|
|
2408
|
+
readonly unique: boolean;
|
|
2409
|
+
readonly managed: boolean;
|
|
2410
|
+
readonly max?: number | undefined;
|
|
2411
|
+
readonly description?: string | undefined;
|
|
2412
|
+
readonly default?: Schema.Json | undefined;
|
|
2413
|
+
readonly min?: number | undefined;
|
|
2414
|
+
readonly column?: string | undefined;
|
|
2415
|
+
readonly renamedFrom?: string | undefined;
|
|
2416
|
+
readonly scope?: readonly string[] | undefined;
|
|
2417
|
+
readonly display?: string | undefined;
|
|
2418
|
+
readonly maxLength?: number | undefined;
|
|
2419
|
+
readonly accept?: readonly string[] | undefined;
|
|
2420
|
+
readonly maxBytes?: number | undefined;
|
|
2421
|
+
readonly options?: readonly {
|
|
2422
|
+
readonly value: string;
|
|
2423
|
+
readonly label: string;
|
|
2424
|
+
readonly description: string;
|
|
2425
|
+
}[] | undefined;
|
|
2426
|
+
readonly items?: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list" | undefined;
|
|
2427
|
+
}[];
|
|
2428
|
+
readonly relationships: readonly {
|
|
2429
|
+
readonly name: string;
|
|
2430
|
+
readonly description: string;
|
|
2431
|
+
readonly to: string;
|
|
2432
|
+
readonly cardinality: "one" | "many";
|
|
2433
|
+
readonly phrase: readonly [string, string];
|
|
2434
|
+
readonly inverse: string;
|
|
2435
|
+
readonly optional?: boolean | undefined;
|
|
2436
|
+
readonly on?: {
|
|
2437
|
+
readonly property: string;
|
|
2438
|
+
readonly targetProperty: string;
|
|
2439
|
+
} | undefined;
|
|
2440
|
+
readonly onDelete?: "setNull" | "cascade" | "restrict" | undefined;
|
|
2441
|
+
readonly ordered?: boolean | undefined;
|
|
2442
|
+
}[];
|
|
2443
|
+
readonly indexes: readonly {
|
|
2444
|
+
readonly properties: readonly string[];
|
|
2445
|
+
readonly unique: boolean;
|
|
2446
|
+
}[];
|
|
2447
|
+
readonly actions: readonly {
|
|
2448
|
+
readonly name: string;
|
|
2449
|
+
readonly description: string;
|
|
2450
|
+
readonly input: {
|
|
2451
|
+
readonly [x: string]: Schema.Json;
|
|
2452
|
+
};
|
|
2453
|
+
readonly permission?: string | undefined;
|
|
2454
|
+
readonly retryOnDeadlock?: boolean | undefined;
|
|
2455
|
+
readonly writes?: readonly string[] | undefined;
|
|
2456
|
+
readonly connections?: readonly string[] | undefined;
|
|
2457
|
+
readonly files?: readonly {
|
|
2458
|
+
readonly entity: string;
|
|
2459
|
+
readonly property: string;
|
|
2460
|
+
}[] | undefined;
|
|
2461
|
+
readonly hints?: {
|
|
2462
|
+
readonly readOnly?: boolean | undefined;
|
|
2463
|
+
readonly connectionsReadOnly?: boolean | undefined;
|
|
2464
|
+
readonly destructive?: boolean | undefined;
|
|
2465
|
+
readonly irreversible?: boolean | undefined;
|
|
2466
|
+
readonly idempotent?: boolean | undefined;
|
|
2467
|
+
} | undefined;
|
|
2468
|
+
}[];
|
|
2469
|
+
readonly plural: string;
|
|
2470
|
+
readonly title: string;
|
|
2471
|
+
readonly builtIn: boolean;
|
|
2472
|
+
readonly source?: {
|
|
2473
|
+
readonly key: readonly string[];
|
|
2474
|
+
readonly asset: string;
|
|
2475
|
+
readonly currency?: string | undefined;
|
|
2476
|
+
} | undefined;
|
|
2477
|
+
readonly metrics?: readonly {
|
|
2478
|
+
readonly name: string;
|
|
2479
|
+
readonly description: string;
|
|
2480
|
+
readonly label: string;
|
|
2481
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
2482
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
2483
|
+
readonly expression: Schema.Json;
|
|
2484
|
+
readonly balanceOver?: string | undefined;
|
|
2485
|
+
}[] | undefined;
|
|
2486
|
+
readonly renamedFrom?: string | undefined;
|
|
2487
|
+
readonly guide?: string | undefined;
|
|
2488
|
+
readonly writes?: "actions" | undefined;
|
|
2489
|
+
readonly permissions?: {
|
|
2490
|
+
readonly read: string;
|
|
2491
|
+
readonly create?: string | undefined;
|
|
2492
|
+
readonly update?: string | undefined;
|
|
2493
|
+
readonly delete?: string | undefined;
|
|
2494
|
+
readonly link?: string | undefined;
|
|
2495
|
+
readonly unlink?: string | undefined;
|
|
2496
|
+
} | undefined;
|
|
2497
|
+
}[];
|
|
2498
|
+
readonly roles: readonly {
|
|
2499
|
+
readonly name: string;
|
|
2500
|
+
readonly description: string;
|
|
2501
|
+
readonly builtIn: boolean;
|
|
2502
|
+
readonly scopes?: readonly {
|
|
2503
|
+
readonly permission: string;
|
|
2504
|
+
readonly where: {
|
|
2505
|
+
readonly [x: string]: Schema.Json;
|
|
2506
|
+
};
|
|
2507
|
+
}[] | undefined;
|
|
2508
|
+
readonly permissions?: readonly string[] | undefined;
|
|
2509
|
+
}[];
|
|
2510
|
+
readonly chat?: {
|
|
2511
|
+
readonly telegram?: {
|
|
2512
|
+
readonly connection: string;
|
|
2513
|
+
} | undefined;
|
|
2514
|
+
readonly attribution?: {
|
|
2515
|
+
readonly template?: string | undefined;
|
|
2516
|
+
readonly separator?: string | undefined;
|
|
2517
|
+
} | undefined;
|
|
2518
|
+
} | undefined;
|
|
2519
|
+
readonly workflows?: readonly {
|
|
2520
|
+
readonly name: string;
|
|
2521
|
+
readonly description: string;
|
|
2522
|
+
readonly role: string;
|
|
2523
|
+
readonly input: {
|
|
2524
|
+
readonly [x: string]: Schema.Json;
|
|
2525
|
+
};
|
|
2526
|
+
readonly connections: readonly string[];
|
|
2527
|
+
readonly triggers: readonly ({
|
|
2528
|
+
readonly kind: "cron";
|
|
2529
|
+
readonly name: string;
|
|
2530
|
+
readonly description: string;
|
|
2531
|
+
readonly cron: string;
|
|
2532
|
+
readonly input: Schema.Json;
|
|
2533
|
+
} | {
|
|
2534
|
+
readonly kind: "action";
|
|
2535
|
+
readonly entity: string;
|
|
2536
|
+
readonly name: string;
|
|
2537
|
+
readonly description: string;
|
|
2538
|
+
readonly action?: string | undefined;
|
|
2539
|
+
} | {
|
|
2540
|
+
readonly kind: "webhook";
|
|
2541
|
+
readonly name: string;
|
|
2542
|
+
readonly description: string;
|
|
2543
|
+
readonly signature?: {
|
|
2544
|
+
readonly scheme: string;
|
|
2545
|
+
readonly secret: string;
|
|
2546
|
+
} | undefined;
|
|
2547
|
+
readonly verification?: {
|
|
2548
|
+
readonly scheme: string;
|
|
2549
|
+
readonly verifyToken: string;
|
|
2550
|
+
} | undefined;
|
|
2551
|
+
readonly headers?: readonly string[] | undefined;
|
|
2552
|
+
} | {
|
|
2553
|
+
readonly [x: string]: Schema.Json;
|
|
2554
|
+
})[];
|
|
2555
|
+
}[] | undefined;
|
|
2556
|
+
readonly metrics?: readonly {
|
|
2557
|
+
readonly name: string;
|
|
2558
|
+
readonly label: string;
|
|
2559
|
+
readonly description: string;
|
|
2560
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
2561
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
2562
|
+
readonly expression: Schema.Json;
|
|
2563
|
+
readonly inputs: readonly string[];
|
|
2564
|
+
readonly align: readonly {
|
|
2565
|
+
readonly [x: string]: string | null;
|
|
2566
|
+
}[];
|
|
2567
|
+
}[] | undefined;
|
|
2568
|
+
readonly connections?: readonly {
|
|
2569
|
+
readonly description: string;
|
|
2570
|
+
readonly key: string;
|
|
2571
|
+
readonly delivers?: true | undefined;
|
|
2572
|
+
}[] | undefined;
|
|
2573
|
+
readonly feedback?: {
|
|
2574
|
+
readonly files: boolean;
|
|
2575
|
+
readonly builders: readonly string[];
|
|
2576
|
+
readonly enabled: boolean;
|
|
2577
|
+
readonly automaticFailureReports?: boolean | undefined;
|
|
2578
|
+
} | undefined;
|
|
2579
|
+
readonly runtimeCapabilities?: readonly string[] | undefined;
|
|
2580
|
+
readonly executionCompatibility?: {
|
|
2581
|
+
readonly version: number;
|
|
2582
|
+
readonly hash: string;
|
|
2583
|
+
} | undefined;
|
|
2584
|
+
readonly signIn?: {
|
|
2585
|
+
readonly policy: string;
|
|
2586
|
+
readonly browser?: {
|
|
2587
|
+
readonly methods: readonly string[];
|
|
2588
|
+
readonly primary: string;
|
|
2589
|
+
readonly autoRedirect: boolean;
|
|
2590
|
+
readonly local?: {
|
|
2591
|
+
readonly port: number;
|
|
2592
|
+
} | undefined;
|
|
2593
|
+
} | undefined;
|
|
2594
|
+
readonly channels?: {
|
|
2595
|
+
readonly [x: string]: unknown;
|
|
2596
|
+
} | undefined;
|
|
2597
|
+
readonly onNewUser?: string | undefined;
|
|
2598
|
+
readonly codeLink?: boolean | undefined;
|
|
2599
|
+
} | undefined;
|
|
2600
|
+
readonly emails?: {
|
|
2601
|
+
readonly [x: string]: {
|
|
2602
|
+
readonly subject: string;
|
|
2603
|
+
readonly action: string;
|
|
2604
|
+
readonly heading: string;
|
|
2605
|
+
readonly replyTo?: string | undefined;
|
|
2606
|
+
readonly eyebrow?: string | undefined;
|
|
2607
|
+
readonly card?: {
|
|
2608
|
+
readonly title: string;
|
|
2609
|
+
readonly detail?: string | undefined;
|
|
2610
|
+
} | undefined;
|
|
2611
|
+
readonly note?: string | undefined;
|
|
2612
|
+
readonly paragraphs?: readonly string[] | undefined;
|
|
2613
|
+
readonly footer?: string | undefined;
|
|
2614
|
+
};
|
|
2615
|
+
} | undefined;
|
|
2616
|
+
} | {
|
|
2617
|
+
readonly version: number;
|
|
2618
|
+
readonly hash: string;
|
|
2619
|
+
readonly entities: readonly {
|
|
2620
|
+
readonly id: string;
|
|
2621
|
+
readonly name: string;
|
|
2622
|
+
readonly description: string;
|
|
2623
|
+
readonly label: string;
|
|
2624
|
+
readonly properties: readonly {
|
|
2625
|
+
readonly optional: boolean;
|
|
2626
|
+
readonly name: string;
|
|
2627
|
+
readonly label: string;
|
|
2628
|
+
readonly type: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list";
|
|
2629
|
+
readonly unique: boolean;
|
|
2630
|
+
readonly managed: boolean;
|
|
2631
|
+
readonly max?: number | undefined;
|
|
2632
|
+
readonly description?: string | undefined;
|
|
2633
|
+
readonly default?: Schema.Json | undefined;
|
|
2634
|
+
readonly min?: number | undefined;
|
|
2635
|
+
readonly column?: string | undefined;
|
|
2636
|
+
readonly renamedFrom?: string | undefined;
|
|
2637
|
+
readonly scope?: readonly string[] | undefined;
|
|
2638
|
+
readonly display?: string | undefined;
|
|
2639
|
+
readonly maxLength?: number | undefined;
|
|
2640
|
+
readonly accept?: readonly string[] | undefined;
|
|
2641
|
+
readonly maxBytes?: number | undefined;
|
|
2642
|
+
readonly options?: readonly {
|
|
2643
|
+
readonly value: string;
|
|
2644
|
+
readonly label: string;
|
|
2645
|
+
readonly description: string;
|
|
2646
|
+
}[] | undefined;
|
|
2647
|
+
readonly items?: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list" | undefined;
|
|
2648
|
+
}[];
|
|
2649
|
+
readonly relationships: readonly {
|
|
2650
|
+
readonly name: string;
|
|
2651
|
+
readonly description: string;
|
|
2652
|
+
readonly to: string;
|
|
2653
|
+
readonly cardinality: "one" | "many";
|
|
2654
|
+
readonly phrase: readonly [string, string];
|
|
2655
|
+
readonly inverse: string;
|
|
2656
|
+
readonly optional?: boolean | undefined;
|
|
2657
|
+
readonly on?: {
|
|
2658
|
+
readonly property: string;
|
|
2659
|
+
readonly targetProperty: string;
|
|
2660
|
+
} | undefined;
|
|
2661
|
+
readonly onDelete?: "setNull" | "cascade" | "restrict" | undefined;
|
|
2662
|
+
readonly ordered?: boolean | undefined;
|
|
2663
|
+
}[];
|
|
2664
|
+
readonly indexes: readonly {
|
|
2665
|
+
readonly properties: readonly string[];
|
|
2666
|
+
readonly unique: boolean;
|
|
2667
|
+
}[];
|
|
2668
|
+
readonly actions: readonly {
|
|
2669
|
+
readonly name: string;
|
|
2670
|
+
readonly description: string;
|
|
2671
|
+
readonly input: {
|
|
2672
|
+
readonly [x: string]: Schema.Json;
|
|
2673
|
+
};
|
|
2674
|
+
readonly permission?: string | undefined;
|
|
2675
|
+
readonly retryOnDeadlock?: boolean | undefined;
|
|
2676
|
+
readonly writes?: readonly string[] | undefined;
|
|
2677
|
+
readonly connections?: readonly string[] | undefined;
|
|
2678
|
+
readonly files?: readonly {
|
|
2679
|
+
readonly entity: string;
|
|
2680
|
+
readonly property: string;
|
|
2681
|
+
}[] | undefined;
|
|
2682
|
+
readonly hints?: {
|
|
2683
|
+
readonly readOnly?: boolean | undefined;
|
|
2684
|
+
readonly connectionsReadOnly?: boolean | undefined;
|
|
2685
|
+
readonly destructive?: boolean | undefined;
|
|
2686
|
+
readonly irreversible?: boolean | undefined;
|
|
2687
|
+
readonly idempotent?: boolean | undefined;
|
|
2688
|
+
} | undefined;
|
|
2689
|
+
}[];
|
|
2690
|
+
readonly plural: string;
|
|
2691
|
+
readonly title: string;
|
|
2692
|
+
readonly builtIn: boolean;
|
|
2693
|
+
readonly source?: {
|
|
2694
|
+
readonly key: readonly string[];
|
|
2695
|
+
readonly asset: string;
|
|
2696
|
+
readonly currency?: string | undefined;
|
|
2697
|
+
} | undefined;
|
|
2698
|
+
readonly metrics?: readonly {
|
|
2699
|
+
readonly name: string;
|
|
2700
|
+
readonly description: string;
|
|
2701
|
+
readonly label: string;
|
|
2702
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
2703
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
2704
|
+
readonly expression: Schema.Json;
|
|
2705
|
+
readonly balanceOver?: string | undefined;
|
|
2706
|
+
}[] | undefined;
|
|
2707
|
+
readonly renamedFrom?: string | undefined;
|
|
2708
|
+
readonly guide?: string | undefined;
|
|
2709
|
+
readonly writes?: "actions" | undefined;
|
|
2710
|
+
readonly permissions?: {
|
|
2711
|
+
readonly read: string;
|
|
2712
|
+
readonly create?: string | undefined;
|
|
2713
|
+
readonly update?: string | undefined;
|
|
2714
|
+
readonly delete?: string | undefined;
|
|
2715
|
+
readonly link?: string | undefined;
|
|
2716
|
+
readonly unlink?: string | undefined;
|
|
2717
|
+
} | undefined;
|
|
2718
|
+
}[];
|
|
2719
|
+
readonly roles: readonly {
|
|
2720
|
+
readonly name: string;
|
|
2721
|
+
readonly description: string;
|
|
2722
|
+
readonly builtIn: boolean;
|
|
2723
|
+
readonly scopes?: readonly {
|
|
2724
|
+
readonly permission: string;
|
|
2725
|
+
readonly where: {
|
|
2726
|
+
readonly [x: string]: Schema.Json;
|
|
2727
|
+
};
|
|
2728
|
+
}[] | undefined;
|
|
2729
|
+
readonly permissions?: readonly string[] | undefined;
|
|
2730
|
+
}[];
|
|
2731
|
+
readonly chat?: {
|
|
2732
|
+
readonly telegram?: {
|
|
2733
|
+
readonly connection: string;
|
|
2734
|
+
} | undefined;
|
|
2735
|
+
readonly attribution?: {
|
|
2736
|
+
readonly template?: string | undefined;
|
|
2737
|
+
readonly separator?: string | undefined;
|
|
2738
|
+
} | undefined;
|
|
2739
|
+
} | undefined;
|
|
2740
|
+
readonly workflows?: readonly {
|
|
2741
|
+
readonly name: string;
|
|
2742
|
+
readonly description: string;
|
|
2743
|
+
readonly role: string;
|
|
2744
|
+
readonly input: {
|
|
2745
|
+
readonly [x: string]: Schema.Json;
|
|
2746
|
+
};
|
|
2747
|
+
readonly connections: readonly string[];
|
|
2748
|
+
readonly triggers: readonly ({
|
|
2749
|
+
readonly kind: "cron";
|
|
2750
|
+
readonly name: string;
|
|
2751
|
+
readonly description: string;
|
|
2752
|
+
readonly cron: string;
|
|
2753
|
+
readonly input: Schema.Json;
|
|
2754
|
+
} | {
|
|
2755
|
+
readonly kind: "action";
|
|
2756
|
+
readonly entity: string;
|
|
2757
|
+
readonly name: string;
|
|
2758
|
+
readonly description: string;
|
|
2759
|
+
readonly action?: string | undefined;
|
|
2760
|
+
} | {
|
|
2761
|
+
readonly kind: "webhook";
|
|
2762
|
+
readonly name: string;
|
|
2763
|
+
readonly description: string;
|
|
2764
|
+
readonly signature?: {
|
|
2765
|
+
readonly scheme: string;
|
|
2766
|
+
readonly secret: string;
|
|
2767
|
+
} | undefined;
|
|
2768
|
+
readonly verification?: {
|
|
2769
|
+
readonly scheme: string;
|
|
2770
|
+
readonly verifyToken: string;
|
|
2771
|
+
} | undefined;
|
|
2772
|
+
readonly headers?: readonly string[] | undefined;
|
|
2773
|
+
} | {
|
|
2774
|
+
readonly [x: string]: Schema.Json;
|
|
2775
|
+
})[];
|
|
2776
|
+
}[] | undefined;
|
|
2777
|
+
readonly metrics?: readonly {
|
|
2778
|
+
readonly name: string;
|
|
2779
|
+
readonly label: string;
|
|
2780
|
+
readonly description: string;
|
|
2781
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
2782
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
2783
|
+
readonly expression: Schema.Json;
|
|
2784
|
+
readonly inputs: readonly string[];
|
|
2785
|
+
readonly align: readonly {
|
|
2786
|
+
readonly [x: string]: string | null;
|
|
2787
|
+
}[];
|
|
2788
|
+
}[] | undefined;
|
|
2789
|
+
readonly connections?: readonly {
|
|
2790
|
+
readonly description: string;
|
|
2791
|
+
readonly key: string;
|
|
2792
|
+
readonly delivers?: true | undefined;
|
|
2793
|
+
}[] | undefined;
|
|
2794
|
+
readonly feedback?: {
|
|
2795
|
+
readonly files: boolean;
|
|
2796
|
+
readonly builders: readonly string[];
|
|
2797
|
+
readonly enabled: boolean;
|
|
2798
|
+
readonly automaticFailureReports?: boolean | undefined;
|
|
2799
|
+
} | undefined;
|
|
2800
|
+
readonly runtimeCapabilities?: readonly string[] | undefined;
|
|
2801
|
+
readonly executionCompatibility?: {
|
|
2802
|
+
readonly version: number;
|
|
2803
|
+
readonly hash: string;
|
|
2804
|
+
} | undefined;
|
|
2805
|
+
readonly signIn?: {
|
|
2806
|
+
readonly policy: string;
|
|
2807
|
+
readonly browser?: {
|
|
2808
|
+
readonly methods: readonly string[];
|
|
2809
|
+
readonly primary: string;
|
|
2810
|
+
readonly autoRedirect: boolean;
|
|
2811
|
+
readonly local?: {
|
|
2812
|
+
readonly port: number;
|
|
2813
|
+
} | undefined;
|
|
2814
|
+
} | undefined;
|
|
2815
|
+
readonly channels?: {
|
|
2816
|
+
readonly [x: string]: unknown;
|
|
2817
|
+
} | undefined;
|
|
2818
|
+
readonly onNewUser?: string | undefined;
|
|
2819
|
+
readonly codeLink?: boolean | undefined;
|
|
2820
|
+
} | undefined;
|
|
2821
|
+
readonly emails?: {
|
|
2822
|
+
readonly [x: string]: {
|
|
2823
|
+
readonly subject: string;
|
|
2824
|
+
readonly action: string;
|
|
2825
|
+
readonly heading: string;
|
|
2826
|
+
readonly replyTo?: string | undefined;
|
|
2827
|
+
readonly eyebrow?: string | undefined;
|
|
2828
|
+
readonly card?: {
|
|
2829
|
+
readonly title: string;
|
|
2830
|
+
readonly detail?: string | undefined;
|
|
2831
|
+
} | undefined;
|
|
2832
|
+
readonly note?: string | undefined;
|
|
2833
|
+
readonly paragraphs?: readonly string[] | undefined;
|
|
2834
|
+
readonly footer?: string | undefined;
|
|
2835
|
+
};
|
|
2836
|
+
} | undefined;
|
|
2837
|
+
}>;
|
|
2838
|
+
export type OntologyManifest = typeof OntologyManifest.Type;
|
|
2839
|
+
/**
|
|
2840
|
+
* Retain the complete document when decoding a persisted or published manifest: encoding the decoded
|
|
2841
|
+
* manifest returns it untouched, earlier names included, so its hash still verifies.
|
|
2842
|
+
*/
|
|
2843
|
+
export declare const decodeManifestDocument: (value: unknown) => Effect.Effect<{
|
|
2844
|
+
readonly version: number;
|
|
2845
|
+
readonly hash: string;
|
|
2846
|
+
readonly entities: readonly {
|
|
2847
|
+
readonly id: string;
|
|
2848
|
+
readonly name: string;
|
|
2849
|
+
readonly description: string;
|
|
2850
|
+
readonly label: string;
|
|
2851
|
+
readonly properties: readonly {
|
|
2852
|
+
readonly optional: boolean;
|
|
2853
|
+
readonly name: string;
|
|
2854
|
+
readonly label: string;
|
|
2855
|
+
readonly type: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list";
|
|
2856
|
+
readonly unique: boolean;
|
|
2857
|
+
readonly managed: boolean;
|
|
2858
|
+
readonly max?: number | undefined;
|
|
2859
|
+
readonly description?: string | undefined;
|
|
2860
|
+
readonly default?: Schema.Json | undefined;
|
|
2861
|
+
readonly min?: number | undefined;
|
|
2862
|
+
readonly column?: string | undefined;
|
|
2863
|
+
readonly renamedFrom?: string | undefined;
|
|
2864
|
+
readonly scope?: readonly string[] | undefined;
|
|
2865
|
+
readonly display?: string | undefined;
|
|
2866
|
+
readonly maxLength?: number | undefined;
|
|
2867
|
+
readonly accept?: readonly string[] | undefined;
|
|
2868
|
+
readonly maxBytes?: number | undefined;
|
|
2869
|
+
readonly options?: readonly {
|
|
2870
|
+
readonly value: string;
|
|
2871
|
+
readonly label: string;
|
|
2872
|
+
readonly description: string;
|
|
2873
|
+
}[] | undefined;
|
|
2874
|
+
readonly items?: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list" | undefined;
|
|
2875
|
+
}[];
|
|
2876
|
+
readonly relationships: readonly {
|
|
2877
|
+
readonly name: string;
|
|
2878
|
+
readonly description: string;
|
|
2879
|
+
readonly to: string;
|
|
2880
|
+
readonly cardinality: "one" | "many";
|
|
2881
|
+
readonly phrase: readonly [string, string];
|
|
2882
|
+
readonly inverse: string;
|
|
2883
|
+
readonly optional?: boolean | undefined;
|
|
2884
|
+
readonly on?: {
|
|
2885
|
+
readonly property: string;
|
|
2886
|
+
readonly targetProperty: string;
|
|
2887
|
+
} | undefined;
|
|
2888
|
+
readonly onDelete?: "setNull" | "cascade" | "restrict" | undefined;
|
|
2889
|
+
readonly ordered?: boolean | undefined;
|
|
2890
|
+
}[];
|
|
2891
|
+
readonly indexes: readonly {
|
|
2892
|
+
readonly properties: readonly string[];
|
|
2893
|
+
readonly unique: boolean;
|
|
2894
|
+
}[];
|
|
2895
|
+
readonly actions: readonly {
|
|
2896
|
+
readonly name: string;
|
|
2897
|
+
readonly description: string;
|
|
2898
|
+
readonly input: {
|
|
2899
|
+
readonly [x: string]: Schema.Json;
|
|
2900
|
+
};
|
|
2901
|
+
readonly permission?: string | undefined;
|
|
2902
|
+
readonly retryOnDeadlock?: boolean | undefined;
|
|
2903
|
+
readonly writes?: readonly string[] | undefined;
|
|
2904
|
+
readonly connections?: readonly string[] | undefined;
|
|
2905
|
+
readonly files?: readonly {
|
|
2906
|
+
readonly entity: string;
|
|
2907
|
+
readonly property: string;
|
|
2908
|
+
}[] | undefined;
|
|
2909
|
+
readonly hints?: {
|
|
2910
|
+
readonly readOnly?: boolean | undefined;
|
|
2911
|
+
readonly connectionsReadOnly?: boolean | undefined;
|
|
2912
|
+
readonly destructive?: boolean | undefined;
|
|
2913
|
+
readonly irreversible?: boolean | undefined;
|
|
2914
|
+
readonly idempotent?: boolean | undefined;
|
|
2915
|
+
} | undefined;
|
|
2916
|
+
}[];
|
|
2917
|
+
readonly plural: string;
|
|
2918
|
+
readonly title: string;
|
|
2919
|
+
readonly builtIn: boolean;
|
|
2920
|
+
readonly source?: {
|
|
2921
|
+
readonly key: readonly string[];
|
|
2922
|
+
readonly asset: string;
|
|
2923
|
+
readonly currency?: string | undefined;
|
|
2924
|
+
} | undefined;
|
|
2925
|
+
readonly metrics?: readonly {
|
|
2926
|
+
readonly name: string;
|
|
2927
|
+
readonly description: string;
|
|
2928
|
+
readonly label: string;
|
|
2929
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
2930
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
2931
|
+
readonly expression: Schema.Json;
|
|
2932
|
+
readonly balanceOver?: string | undefined;
|
|
2933
|
+
}[] | undefined;
|
|
2934
|
+
readonly renamedFrom?: string | undefined;
|
|
2935
|
+
readonly guide?: string | undefined;
|
|
2936
|
+
readonly writes?: "actions" | undefined;
|
|
2937
|
+
readonly permissions?: {
|
|
2938
|
+
readonly read: string;
|
|
2939
|
+
readonly create?: string | undefined;
|
|
2940
|
+
readonly update?: string | undefined;
|
|
2941
|
+
readonly delete?: string | undefined;
|
|
2942
|
+
readonly link?: string | undefined;
|
|
2943
|
+
readonly unlink?: string | undefined;
|
|
2944
|
+
} | undefined;
|
|
2945
|
+
}[];
|
|
2946
|
+
readonly roles: readonly {
|
|
2947
|
+
readonly name: string;
|
|
2948
|
+
readonly description: string;
|
|
2949
|
+
readonly builtIn: boolean;
|
|
2950
|
+
readonly scopes?: readonly {
|
|
2951
|
+
readonly permission: string;
|
|
2952
|
+
readonly where: {
|
|
2953
|
+
readonly [x: string]: Schema.Json;
|
|
2954
|
+
};
|
|
2955
|
+
}[] | undefined;
|
|
2956
|
+
readonly permissions?: readonly string[] | undefined;
|
|
2957
|
+
}[];
|
|
2958
|
+
readonly chat?: {
|
|
2959
|
+
readonly telegram?: {
|
|
2960
|
+
readonly connection: string;
|
|
2961
|
+
} | undefined;
|
|
2962
|
+
readonly attribution?: {
|
|
2963
|
+
readonly template?: string | undefined;
|
|
2964
|
+
readonly separator?: string | undefined;
|
|
2965
|
+
} | undefined;
|
|
2966
|
+
} | undefined;
|
|
2967
|
+
readonly workflows?: readonly {
|
|
2968
|
+
readonly name: string;
|
|
2969
|
+
readonly description: string;
|
|
2970
|
+
readonly role: string;
|
|
2971
|
+
readonly input: {
|
|
2972
|
+
readonly [x: string]: Schema.Json;
|
|
2973
|
+
};
|
|
2974
|
+
readonly connections: readonly string[];
|
|
2975
|
+
readonly triggers: readonly ({
|
|
2976
|
+
readonly kind: "cron";
|
|
2977
|
+
readonly name: string;
|
|
2978
|
+
readonly description: string;
|
|
2979
|
+
readonly cron: string;
|
|
2980
|
+
readonly input: Schema.Json;
|
|
2981
|
+
} | {
|
|
2982
|
+
readonly kind: "action";
|
|
2983
|
+
readonly entity: string;
|
|
2984
|
+
readonly name: string;
|
|
2985
|
+
readonly description: string;
|
|
2986
|
+
readonly action?: string | undefined;
|
|
2987
|
+
} | {
|
|
2988
|
+
readonly kind: "webhook";
|
|
2989
|
+
readonly name: string;
|
|
2990
|
+
readonly description: string;
|
|
2991
|
+
readonly signature?: {
|
|
2992
|
+
readonly scheme: string;
|
|
2993
|
+
readonly secret: string;
|
|
2994
|
+
} | undefined;
|
|
2995
|
+
readonly verification?: {
|
|
2996
|
+
readonly scheme: string;
|
|
2997
|
+
readonly verifyToken: string;
|
|
2998
|
+
} | undefined;
|
|
2999
|
+
readonly headers?: readonly string[] | undefined;
|
|
3000
|
+
} | {
|
|
3001
|
+
readonly [x: string]: Schema.Json;
|
|
3002
|
+
})[];
|
|
3003
|
+
}[] | undefined;
|
|
3004
|
+
readonly metrics?: readonly {
|
|
3005
|
+
readonly name: string;
|
|
3006
|
+
readonly label: string;
|
|
3007
|
+
readonly description: string;
|
|
3008
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
3009
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
3010
|
+
readonly expression: Schema.Json;
|
|
3011
|
+
readonly inputs: readonly string[];
|
|
3012
|
+
readonly align: readonly {
|
|
3013
|
+
readonly [x: string]: string | null;
|
|
3014
|
+
}[];
|
|
3015
|
+
}[] | undefined;
|
|
3016
|
+
readonly connections?: readonly {
|
|
3017
|
+
readonly description: string;
|
|
3018
|
+
readonly key: string;
|
|
3019
|
+
readonly delivers?: true | undefined;
|
|
3020
|
+
}[] | undefined;
|
|
3021
|
+
readonly feedback?: {
|
|
3022
|
+
readonly files: boolean;
|
|
3023
|
+
readonly builders: readonly string[];
|
|
3024
|
+
readonly enabled: boolean;
|
|
3025
|
+
readonly automaticFailureReports?: boolean | undefined;
|
|
3026
|
+
} | undefined;
|
|
3027
|
+
readonly runtimeCapabilities?: readonly string[] | undefined;
|
|
3028
|
+
readonly executionCompatibility?: {
|
|
3029
|
+
readonly version: number;
|
|
3030
|
+
readonly hash: string;
|
|
3031
|
+
} | undefined;
|
|
3032
|
+
readonly signIn?: {
|
|
3033
|
+
readonly policy: string;
|
|
3034
|
+
readonly browser?: {
|
|
3035
|
+
readonly methods: readonly string[];
|
|
3036
|
+
readonly primary: string;
|
|
3037
|
+
readonly autoRedirect: boolean;
|
|
3038
|
+
readonly local?: {
|
|
3039
|
+
readonly port: number;
|
|
3040
|
+
} | undefined;
|
|
3041
|
+
} | undefined;
|
|
3042
|
+
readonly channels?: {
|
|
3043
|
+
readonly [x: string]: unknown;
|
|
3044
|
+
} | undefined;
|
|
3045
|
+
readonly onNewUser?: string | undefined;
|
|
3046
|
+
readonly codeLink?: boolean | undefined;
|
|
3047
|
+
} | undefined;
|
|
3048
|
+
readonly emails?: {
|
|
3049
|
+
readonly [x: string]: {
|
|
3050
|
+
readonly subject: string;
|
|
3051
|
+
readonly action: string;
|
|
3052
|
+
readonly heading: string;
|
|
3053
|
+
readonly replyTo?: string | undefined;
|
|
3054
|
+
readonly eyebrow?: string | undefined;
|
|
3055
|
+
readonly card?: {
|
|
3056
|
+
readonly title: string;
|
|
3057
|
+
readonly detail?: string | undefined;
|
|
3058
|
+
} | undefined;
|
|
3059
|
+
readonly note?: string | undefined;
|
|
3060
|
+
readonly paragraphs?: readonly string[] | undefined;
|
|
3061
|
+
readonly footer?: string | undefined;
|
|
3062
|
+
};
|
|
3063
|
+
} | undefined;
|
|
3064
|
+
} | {
|
|
3065
|
+
readonly version: number;
|
|
3066
|
+
readonly hash: string;
|
|
3067
|
+
readonly entities: readonly {
|
|
3068
|
+
readonly id: string;
|
|
3069
|
+
readonly name: string;
|
|
3070
|
+
readonly description: string;
|
|
3071
|
+
readonly label: string;
|
|
3072
|
+
readonly properties: readonly {
|
|
3073
|
+
readonly optional: boolean;
|
|
3074
|
+
readonly name: string;
|
|
3075
|
+
readonly label: string;
|
|
3076
|
+
readonly type: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list";
|
|
3077
|
+
readonly unique: boolean;
|
|
3078
|
+
readonly managed: boolean;
|
|
3079
|
+
readonly max?: number | undefined;
|
|
3080
|
+
readonly description?: string | undefined;
|
|
3081
|
+
readonly default?: Schema.Json | undefined;
|
|
3082
|
+
readonly min?: number | undefined;
|
|
3083
|
+
readonly column?: string | undefined;
|
|
3084
|
+
readonly renamedFrom?: string | undefined;
|
|
3085
|
+
readonly scope?: readonly string[] | undefined;
|
|
3086
|
+
readonly display?: string | undefined;
|
|
3087
|
+
readonly maxLength?: number | undefined;
|
|
3088
|
+
readonly accept?: readonly string[] | undefined;
|
|
3089
|
+
readonly maxBytes?: number | undefined;
|
|
3090
|
+
readonly options?: readonly {
|
|
3091
|
+
readonly value: string;
|
|
3092
|
+
readonly label: string;
|
|
3093
|
+
readonly description: string;
|
|
3094
|
+
}[] | undefined;
|
|
3095
|
+
readonly items?: "number" | "boolean" | "email" | "text" | "url" | "date" | "timestamp" | "select" | "integer" | "json" | "blob" | "list" | undefined;
|
|
3096
|
+
}[];
|
|
3097
|
+
readonly relationships: readonly {
|
|
3098
|
+
readonly name: string;
|
|
3099
|
+
readonly description: string;
|
|
3100
|
+
readonly to: string;
|
|
3101
|
+
readonly cardinality: "one" | "many";
|
|
3102
|
+
readonly phrase: readonly [string, string];
|
|
3103
|
+
readonly inverse: string;
|
|
3104
|
+
readonly optional?: boolean | undefined;
|
|
3105
|
+
readonly on?: {
|
|
3106
|
+
readonly property: string;
|
|
3107
|
+
readonly targetProperty: string;
|
|
3108
|
+
} | undefined;
|
|
3109
|
+
readonly onDelete?: "setNull" | "cascade" | "restrict" | undefined;
|
|
3110
|
+
readonly ordered?: boolean | undefined;
|
|
3111
|
+
}[];
|
|
3112
|
+
readonly indexes: readonly {
|
|
3113
|
+
readonly properties: readonly string[];
|
|
3114
|
+
readonly unique: boolean;
|
|
3115
|
+
}[];
|
|
3116
|
+
readonly actions: readonly {
|
|
3117
|
+
readonly name: string;
|
|
3118
|
+
readonly description: string;
|
|
3119
|
+
readonly input: {
|
|
3120
|
+
readonly [x: string]: Schema.Json;
|
|
3121
|
+
};
|
|
3122
|
+
readonly permission?: string | undefined;
|
|
3123
|
+
readonly retryOnDeadlock?: boolean | undefined;
|
|
3124
|
+
readonly writes?: readonly string[] | undefined;
|
|
3125
|
+
readonly connections?: readonly string[] | undefined;
|
|
3126
|
+
readonly files?: readonly {
|
|
3127
|
+
readonly entity: string;
|
|
3128
|
+
readonly property: string;
|
|
3129
|
+
}[] | undefined;
|
|
3130
|
+
readonly hints?: {
|
|
3131
|
+
readonly readOnly?: boolean | undefined;
|
|
3132
|
+
readonly connectionsReadOnly?: boolean | undefined;
|
|
3133
|
+
readonly destructive?: boolean | undefined;
|
|
3134
|
+
readonly irreversible?: boolean | undefined;
|
|
3135
|
+
readonly idempotent?: boolean | undefined;
|
|
3136
|
+
} | undefined;
|
|
3137
|
+
}[];
|
|
3138
|
+
readonly plural: string;
|
|
3139
|
+
readonly title: string;
|
|
3140
|
+
readonly builtIn: boolean;
|
|
3141
|
+
readonly source?: {
|
|
3142
|
+
readonly key: readonly string[];
|
|
3143
|
+
readonly asset: string;
|
|
3144
|
+
readonly currency?: string | undefined;
|
|
3145
|
+
} | undefined;
|
|
3146
|
+
readonly metrics?: readonly {
|
|
3147
|
+
readonly name: string;
|
|
3148
|
+
readonly description: string;
|
|
3149
|
+
readonly label: string;
|
|
3150
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
3151
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
3152
|
+
readonly expression: Schema.Json;
|
|
3153
|
+
readonly balanceOver?: string | undefined;
|
|
3154
|
+
}[] | undefined;
|
|
3155
|
+
readonly renamedFrom?: string | undefined;
|
|
3156
|
+
readonly guide?: string | undefined;
|
|
3157
|
+
readonly writes?: "actions" | undefined;
|
|
3158
|
+
readonly permissions?: {
|
|
3159
|
+
readonly read: string;
|
|
3160
|
+
readonly create?: string | undefined;
|
|
3161
|
+
readonly update?: string | undefined;
|
|
3162
|
+
readonly delete?: string | undefined;
|
|
3163
|
+
readonly link?: string | undefined;
|
|
3164
|
+
readonly unlink?: string | undefined;
|
|
3165
|
+
} | undefined;
|
|
3166
|
+
}[];
|
|
3167
|
+
readonly roles: readonly {
|
|
3168
|
+
readonly name: string;
|
|
3169
|
+
readonly description: string;
|
|
3170
|
+
readonly builtIn: boolean;
|
|
3171
|
+
readonly scopes?: readonly {
|
|
3172
|
+
readonly permission: string;
|
|
3173
|
+
readonly where: {
|
|
3174
|
+
readonly [x: string]: Schema.Json;
|
|
3175
|
+
};
|
|
3176
|
+
}[] | undefined;
|
|
3177
|
+
readonly permissions?: readonly string[] | undefined;
|
|
3178
|
+
}[];
|
|
3179
|
+
readonly chat?: {
|
|
3180
|
+
readonly telegram?: {
|
|
3181
|
+
readonly connection: string;
|
|
3182
|
+
} | undefined;
|
|
3183
|
+
readonly attribution?: {
|
|
3184
|
+
readonly template?: string | undefined;
|
|
3185
|
+
readonly separator?: string | undefined;
|
|
3186
|
+
} | undefined;
|
|
3187
|
+
} | undefined;
|
|
3188
|
+
readonly workflows?: readonly {
|
|
3189
|
+
readonly name: string;
|
|
3190
|
+
readonly description: string;
|
|
3191
|
+
readonly role: string;
|
|
3192
|
+
readonly input: {
|
|
3193
|
+
readonly [x: string]: Schema.Json;
|
|
3194
|
+
};
|
|
3195
|
+
readonly connections: readonly string[];
|
|
3196
|
+
readonly triggers: readonly ({
|
|
3197
|
+
readonly kind: "cron";
|
|
3198
|
+
readonly name: string;
|
|
3199
|
+
readonly description: string;
|
|
3200
|
+
readonly cron: string;
|
|
3201
|
+
readonly input: Schema.Json;
|
|
3202
|
+
} | {
|
|
3203
|
+
readonly kind: "action";
|
|
3204
|
+
readonly entity: string;
|
|
3205
|
+
readonly name: string;
|
|
3206
|
+
readonly description: string;
|
|
3207
|
+
readonly action?: string | undefined;
|
|
3208
|
+
} | {
|
|
3209
|
+
readonly kind: "webhook";
|
|
3210
|
+
readonly name: string;
|
|
3211
|
+
readonly description: string;
|
|
3212
|
+
readonly signature?: {
|
|
3213
|
+
readonly scheme: string;
|
|
3214
|
+
readonly secret: string;
|
|
3215
|
+
} | undefined;
|
|
3216
|
+
readonly verification?: {
|
|
3217
|
+
readonly scheme: string;
|
|
3218
|
+
readonly verifyToken: string;
|
|
3219
|
+
} | undefined;
|
|
3220
|
+
readonly headers?: readonly string[] | undefined;
|
|
3221
|
+
} | {
|
|
3222
|
+
readonly [x: string]: Schema.Json;
|
|
3223
|
+
})[];
|
|
3224
|
+
}[] | undefined;
|
|
3225
|
+
readonly metrics?: readonly {
|
|
3226
|
+
readonly name: string;
|
|
3227
|
+
readonly label: string;
|
|
3228
|
+
readonly description: string;
|
|
3229
|
+
readonly unit: "number" | "currency" | "ratio" | "percent";
|
|
3230
|
+
readonly format: "decimal" | "currency" | "percent";
|
|
3231
|
+
readonly expression: Schema.Json;
|
|
3232
|
+
readonly inputs: readonly string[];
|
|
3233
|
+
readonly align: readonly {
|
|
3234
|
+
readonly [x: string]: string | null;
|
|
3235
|
+
}[];
|
|
3236
|
+
}[] | undefined;
|
|
3237
|
+
readonly connections?: readonly {
|
|
3238
|
+
readonly description: string;
|
|
3239
|
+
readonly key: string;
|
|
3240
|
+
readonly delivers?: true | undefined;
|
|
3241
|
+
}[] | undefined;
|
|
3242
|
+
readonly feedback?: {
|
|
3243
|
+
readonly files: boolean;
|
|
3244
|
+
readonly builders: readonly string[];
|
|
3245
|
+
readonly enabled: boolean;
|
|
3246
|
+
readonly automaticFailureReports?: boolean | undefined;
|
|
3247
|
+
} | undefined;
|
|
3248
|
+
readonly runtimeCapabilities?: readonly string[] | undefined;
|
|
3249
|
+
readonly executionCompatibility?: {
|
|
3250
|
+
readonly version: number;
|
|
3251
|
+
readonly hash: string;
|
|
3252
|
+
} | undefined;
|
|
3253
|
+
readonly signIn?: {
|
|
3254
|
+
readonly policy: string;
|
|
3255
|
+
readonly browser?: {
|
|
3256
|
+
readonly methods: readonly string[];
|
|
3257
|
+
readonly primary: string;
|
|
3258
|
+
readonly autoRedirect: boolean;
|
|
3259
|
+
readonly local?: {
|
|
3260
|
+
readonly port: number;
|
|
3261
|
+
} | undefined;
|
|
3262
|
+
} | undefined;
|
|
3263
|
+
readonly channels?: {
|
|
3264
|
+
readonly [x: string]: unknown;
|
|
3265
|
+
} | undefined;
|
|
3266
|
+
readonly onNewUser?: string | undefined;
|
|
3267
|
+
readonly codeLink?: boolean | undefined;
|
|
3268
|
+
} | undefined;
|
|
3269
|
+
readonly emails?: {
|
|
3270
|
+
readonly [x: string]: {
|
|
3271
|
+
readonly subject: string;
|
|
3272
|
+
readonly action: string;
|
|
3273
|
+
readonly heading: string;
|
|
3274
|
+
readonly replyTo?: string | undefined;
|
|
3275
|
+
readonly eyebrow?: string | undefined;
|
|
3276
|
+
readonly card?: {
|
|
3277
|
+
readonly title: string;
|
|
3278
|
+
readonly detail?: string | undefined;
|
|
3279
|
+
} | undefined;
|
|
3280
|
+
readonly note?: string | undefined;
|
|
3281
|
+
readonly paragraphs?: readonly string[] | undefined;
|
|
3282
|
+
readonly footer?: string | undefined;
|
|
3283
|
+
};
|
|
3284
|
+
} | undefined;
|
|
3285
|
+
}, Schema.SchemaError, never>;
|
|
3286
|
+
/** Encode only ontology-owned metadata. JSON values and JSON Schema keywords remain opaque. */
|
|
3287
|
+
export declare function encodeManifest(manifest: OntologyManifest): Readonly<Record<string, unknown>>;
|
|
3288
|
+
/**
|
|
3289
|
+
* The sign-in policy a manifest declares. A manifest without one, or with a policy this reader does
|
|
3290
|
+
* not know, reads as `invited`: the closed choice, so that a misread never lets strangers in.
|
|
3291
|
+
*/
|
|
3292
|
+
export declare function signInPolicyOf(manifest: Pick<OntologyManifest, "signIn">): SignInPolicy;
|
|
3293
|
+
/** Unsupported providers and missing or unknown channel policies require invitation. */
|
|
3294
|
+
export declare function channelPolicyOf(manifest: Pick<OntologyManifest, "signIn">, provider: string): SignInPolicy;
|
|
3295
|
+
/** JSON with object keys sorted at every level and no whitespace: the input of the manifest hash. */
|
|
3296
|
+
export declare function canonicalJson(value: unknown): string;
|
|
3297
|
+
/** The manifest as a file: canonical key order, two-space indentation and a final newline. */
|
|
3298
|
+
export declare function formatManifest(manifest: OntologyManifest): string;
|
|
3299
|
+
/** The hash of a manifest, computed over its canonical JSON without the `hash` field. */
|
|
3300
|
+
export declare function manifestHash(manifest: Readonly<Record<string, unknown>>): string;
|
|
3301
|
+
/**
|
|
3302
|
+
* The metrics of an entity, of one that passed `check`. A warehouse-backed property's column is its
|
|
3303
|
+
* `column`; a stored property has none, and its column in the replication view is its wire name.
|
|
3304
|
+
* Conditions name columns too, and so does `balanceOver`, which comes from the metric's own
|
|
3305
|
+
* aggregates, top-level or inside arithmetic: `check` lets them name one property at most.
|
|
3306
|
+
*/
|
|
3307
|
+
export declare function metricsManifest(resolved: ResolvedEntity): ReadonlyArray<MetricManifest>;
|
|
3308
|
+
/** Builds the manifest of a resolved ontology that passed `check`. */
|
|
3309
|
+
export declare function buildManifest(input: {
|
|
3310
|
+
readonly feedback?: ResolvedFeedback;
|
|
3311
|
+
readonly chat?: {
|
|
3312
|
+
readonly telegram?: {
|
|
3313
|
+
readonly connection: string;
|
|
3314
|
+
};
|
|
3315
|
+
readonly attribution?: ChatAttributionSettings;
|
|
3316
|
+
};
|
|
3317
|
+
readonly entities: ReadonlyArray<ResolvedEntity>;
|
|
3318
|
+
readonly roles: ReadonlyArray<Role>;
|
|
3319
|
+
readonly signIn: SignInOptions;
|
|
3320
|
+
/** The workspace's own emails by wire name. */
|
|
3321
|
+
readonly emails?: Readonly<Record<string, EmailTemplateManifest>>;
|
|
3322
|
+
readonly connections?: ReadonlyArray<ResolvedConnection>;
|
|
3323
|
+
/** The metrics of the model, resolved to their manifest form. */
|
|
3324
|
+
readonly metrics?: ReadonlyArray<ModelMetricManifest>;
|
|
3325
|
+
/** The workflows, resolved to their manifest form. */
|
|
3326
|
+
readonly workflows?: ReadonlyArray<WorkflowManifest>;
|
|
3327
|
+
}): OntologyManifest;
|
|
3328
|
+
/** The keys of every connection the manifest's actions call, without duplicates. */
|
|
3329
|
+
export declare function actionConnectionKeys(manifest: Pick<OntologyManifest, "entities">): Array<string>;
|