@rox-one/sdk 0.0.0-stage → 0.7.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/CALLS.md +82 -0
- package/README.md +1259 -2
- package/dist/chunk-AOHK5YXC.js +5585 -0
- package/dist/chunk-CATFKTFD.js +80 -0
- package/dist/chunk-FQGPXWPJ.js +1491 -0
- package/dist/chunk-G43PLP2U.js +1087 -0
- package/dist/chunk-LMJW65ML.js +836 -0
- package/dist/chunk-MCSQNZ4E.js +836 -0
- package/dist/chunk-NSJ3GKUC.js +1552 -0
- package/dist/chunk-OGFKJOK7.js +2068 -0
- package/dist/chunk-RDEJZJBZ.js +1351 -0
- package/dist/chunk-TMTYN2UK.js +1128 -0
- package/dist/chunk-V45LUJDI.js +838 -0
- package/dist/chunk-YRUXFEZM.js +1044 -0
- package/dist/chunk-ZYBAKW25.js +994 -0
- package/dist/generated/agent-fold/index.d.ts +4520 -0
- package/dist/generated/agent-fold/index.js +0 -0
- package/dist/generated/agent-harness/client/client.gen.d.ts +2 -0
- package/dist/generated/agent-harness/client/index.d.ts +10 -0
- package/dist/generated/agent-harness/client/types.gen.d.ts +120 -0
- package/dist/generated/agent-harness/client/utils.gen.d.ts +37 -0
- package/dist/generated/agent-harness/client.gen.d.ts +12 -0
- package/dist/generated/agent-harness/core/auth.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/params.gen.d.ts +43 -0
- package/dist/generated/agent-harness/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/agent-harness/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/agent-harness/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/agent-harness/core/types.gen.d.ts +83 -0
- package/dist/generated/agent-harness/core/utils.gen.d.ts +19 -0
- package/dist/generated/agent-harness/index.d.ts +2 -0
- package/dist/generated/agent-harness/index.js +6 -0
- package/dist/generated/agent-harness/sdk.gen.d.ts +375 -0
- package/dist/generated/agent-harness/types.gen.d.ts +4725 -0
- package/dist/generated/agent-reviews/index.d.ts +895 -0
- package/dist/generated/agent-reviews/index.js +0 -0
- package/dist/generated/auth/client/client.gen.d.ts +2 -0
- package/dist/generated/auth/client/index.d.ts +10 -0
- package/dist/generated/auth/client/types.gen.d.ts +120 -0
- package/dist/generated/auth/client/utils.gen.d.ts +37 -0
- package/dist/generated/auth/client.gen.d.ts +12 -0
- package/dist/generated/auth/core/auth.gen.d.ts +25 -0
- package/dist/generated/auth/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/auth/core/params.gen.d.ts +43 -0
- package/dist/generated/auth/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/auth/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/auth/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/auth/core/types.gen.d.ts +83 -0
- package/dist/generated/auth/core/utils.gen.d.ts +19 -0
- package/dist/generated/auth/index.d.ts +2 -0
- package/dist/generated/auth/index.js +6 -0
- package/dist/generated/auth/sdk.gen.d.ts +674 -0
- package/dist/generated/auth/types.gen.d.ts +5233 -0
- package/dist/generated/calendar/client/client.gen.d.ts +2 -0
- package/dist/generated/calendar/client/index.d.ts +10 -0
- package/dist/generated/calendar/client/types.gen.d.ts +120 -0
- package/dist/generated/calendar/client/utils.gen.d.ts +37 -0
- package/dist/generated/calendar/client.gen.d.ts +12 -0
- package/dist/generated/calendar/core/auth.gen.d.ts +25 -0
- package/dist/generated/calendar/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/calendar/core/params.gen.d.ts +43 -0
- package/dist/generated/calendar/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/calendar/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/calendar/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/calendar/core/types.gen.d.ts +83 -0
- package/dist/generated/calendar/core/utils.gen.d.ts +19 -0
- package/dist/generated/calendar/index.d.ts +2 -0
- package/dist/generated/calendar/index.js +6 -0
- package/dist/generated/calendar/sdk.gen.d.ts +157 -0
- package/dist/generated/calendar/types.gen.d.ts +2333 -0
- package/dist/generated/cognition/client/client.gen.d.ts +2 -0
- package/dist/generated/cognition/client/index.d.ts +10 -0
- package/dist/generated/cognition/client/types.gen.d.ts +120 -0
- package/dist/generated/cognition/client/utils.gen.d.ts +37 -0
- package/dist/generated/cognition/client.gen.d.ts +12 -0
- package/dist/generated/cognition/core/auth.gen.d.ts +25 -0
- package/dist/generated/cognition/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/cognition/core/params.gen.d.ts +43 -0
- package/dist/generated/cognition/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/cognition/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/cognition/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/cognition/core/types.gen.d.ts +83 -0
- package/dist/generated/cognition/core/utils.gen.d.ts +19 -0
- package/dist/generated/cognition/index.d.ts +2 -0
- package/dist/generated/cognition/index.js +6 -0
- package/dist/generated/cognition/sdk.gen.d.ts +348 -0
- package/dist/generated/cognition/types.gen.d.ts +4228 -0
- package/dist/generated/connection/client/client.gen.d.ts +2 -0
- package/dist/generated/connection/client/index.d.ts +10 -0
- package/dist/generated/connection/client/types.gen.d.ts +120 -0
- package/dist/generated/connection/client/utils.gen.d.ts +37 -0
- package/dist/generated/connection/client.gen.d.ts +12 -0
- package/dist/generated/connection/core/auth.gen.d.ts +25 -0
- package/dist/generated/connection/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/connection/core/params.gen.d.ts +43 -0
- package/dist/generated/connection/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/connection/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/connection/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/connection/core/types.gen.d.ts +83 -0
- package/dist/generated/connection/core/utils.gen.d.ts +19 -0
- package/dist/generated/connection/index.d.ts +2 -0
- package/dist/generated/connection/index.js +854 -0
- package/dist/generated/connection/sdk.gen.d.ts +43 -0
- package/dist/generated/connection/types.gen.d.ts +252 -0
- package/dist/generated/contacts/client/client.gen.d.ts +2 -0
- package/dist/generated/contacts/client/index.d.ts +10 -0
- package/dist/generated/contacts/client/types.gen.d.ts +120 -0
- package/dist/generated/contacts/client/utils.gen.d.ts +37 -0
- package/dist/generated/contacts/client.gen.d.ts +12 -0
- package/dist/generated/contacts/core/auth.gen.d.ts +25 -0
- package/dist/generated/contacts/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/contacts/core/params.gen.d.ts +43 -0
- package/dist/generated/contacts/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/contacts/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/contacts/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/contacts/core/types.gen.d.ts +83 -0
- package/dist/generated/contacts/core/utils.gen.d.ts +19 -0
- package/dist/generated/contacts/index.d.ts +2 -0
- package/dist/generated/contacts/index.js +6 -0
- package/dist/generated/contacts/sdk.gen.d.ts +47 -0
- package/dist/generated/contacts/types.gen.d.ts +108 -0
- package/dist/generated/email/client/client.gen.d.ts +2 -0
- package/dist/generated/email/client/index.d.ts +10 -0
- package/dist/generated/email/client/types.gen.d.ts +120 -0
- package/dist/generated/email/client/utils.gen.d.ts +37 -0
- package/dist/generated/email/client.gen.d.ts +12 -0
- package/dist/generated/email/core/auth.gen.d.ts +25 -0
- package/dist/generated/email/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/email/core/params.gen.d.ts +43 -0
- package/dist/generated/email/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/email/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/email/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/email/core/types.gen.d.ts +83 -0
- package/dist/generated/email/core/utils.gen.d.ts +19 -0
- package/dist/generated/email/index.d.ts +2 -0
- package/dist/generated/email/index.js +6 -0
- package/dist/generated/email/sdk.gen.d.ts +301 -0
- package/dist/generated/email/types.gen.d.ts +3262 -0
- package/dist/generated/notification/client/client.gen.d.ts +2 -0
- package/dist/generated/notification/client/index.d.ts +10 -0
- package/dist/generated/notification/client/types.gen.d.ts +120 -0
- package/dist/generated/notification/client/utils.gen.d.ts +37 -0
- package/dist/generated/notification/client.gen.d.ts +12 -0
- package/dist/generated/notification/core/auth.gen.d.ts +25 -0
- package/dist/generated/notification/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/notification/core/params.gen.d.ts +43 -0
- package/dist/generated/notification/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/notification/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/notification/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/notification/core/types.gen.d.ts +83 -0
- package/dist/generated/notification/core/utils.gen.d.ts +19 -0
- package/dist/generated/notification/index.d.ts +2 -0
- package/dist/generated/notification/index.js +6 -0
- package/dist/generated/notification/sdk.gen.d.ts +127 -0
- package/dist/generated/notification/types.gen.d.ts +2084 -0
- package/dist/generated/properties/client/client.gen.d.ts +2 -0
- package/dist/generated/properties/client/index.d.ts +10 -0
- package/dist/generated/properties/client/types.gen.d.ts +120 -0
- package/dist/generated/properties/client/utils.gen.d.ts +37 -0
- package/dist/generated/properties/client.gen.d.ts +12 -0
- package/dist/generated/properties/core/auth.gen.d.ts +25 -0
- package/dist/generated/properties/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/properties/core/params.gen.d.ts +43 -0
- package/dist/generated/properties/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/properties/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/properties/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/properties/core/types.gen.d.ts +83 -0
- package/dist/generated/properties/core/utils.gen.d.ts +19 -0
- package/dist/generated/properties/index.d.ts +2 -0
- package/dist/generated/properties/index.js +6 -0
- package/dist/generated/properties/sdk.gen.d.ts +158 -0
- package/dist/generated/properties/types.gen.d.ts +1311 -0
- package/dist/generated/scheduled-action/client/client.gen.d.ts +2 -0
- package/dist/generated/scheduled-action/client/index.d.ts +10 -0
- package/dist/generated/scheduled-action/client/types.gen.d.ts +120 -0
- package/dist/generated/scheduled-action/client/utils.gen.d.ts +37 -0
- package/dist/generated/scheduled-action/client.gen.d.ts +12 -0
- package/dist/generated/scheduled-action/core/auth.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/params.gen.d.ts +43 -0
- package/dist/generated/scheduled-action/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/scheduled-action/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/scheduled-action/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/scheduled-action/core/types.gen.d.ts +83 -0
- package/dist/generated/scheduled-action/core/utils.gen.d.ts +19 -0
- package/dist/generated/scheduled-action/index.d.ts +2 -0
- package/dist/generated/scheduled-action/index.js +6 -0
- package/dist/generated/scheduled-action/sdk.gen.d.ts +156 -0
- package/dist/generated/scheduled-action/types.gen.d.ts +3099 -0
- package/dist/generated/search/client/client.gen.d.ts +2 -0
- package/dist/generated/search/client/index.d.ts +10 -0
- package/dist/generated/search/client/types.gen.d.ts +120 -0
- package/dist/generated/search/client/utils.gen.d.ts +37 -0
- package/dist/generated/search/client.gen.d.ts +12 -0
- package/dist/generated/search/core/auth.gen.d.ts +25 -0
- package/dist/generated/search/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/search/core/params.gen.d.ts +43 -0
- package/dist/generated/search/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/search/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/search/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/search/core/types.gen.d.ts +83 -0
- package/dist/generated/search/core/utils.gen.d.ts +19 -0
- package/dist/generated/search/index.d.ts +2 -0
- package/dist/generated/search/index.js +6 -0
- package/dist/generated/search/sdk.gen.d.ts +44 -0
- package/dist/generated/search/types.gen.d.ts +2532 -0
- package/dist/generated/static-files/client/client.gen.d.ts +2 -0
- package/dist/generated/static-files/client/index.d.ts +10 -0
- package/dist/generated/static-files/client/types.gen.d.ts +120 -0
- package/dist/generated/static-files/client/utils.gen.d.ts +37 -0
- package/dist/generated/static-files/client.gen.d.ts +12 -0
- package/dist/generated/static-files/core/auth.gen.d.ts +25 -0
- package/dist/generated/static-files/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/static-files/core/params.gen.d.ts +43 -0
- package/dist/generated/static-files/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/static-files/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/static-files/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/static-files/core/types.gen.d.ts +83 -0
- package/dist/generated/static-files/core/utils.gen.d.ts +19 -0
- package/dist/generated/static-files/index.d.ts +2 -0
- package/dist/generated/static-files/index.js +842 -0
- package/dist/generated/static-files/sdk.gen.d.ts +43 -0
- package/dist/generated/static-files/types.gen.d.ts +220 -0
- package/dist/generated/storage/client/client.gen.d.ts +2 -0
- package/dist/generated/storage/client/index.d.ts +10 -0
- package/dist/generated/storage/client/types.gen.d.ts +120 -0
- package/dist/generated/storage/client/utils.gen.d.ts +37 -0
- package/dist/generated/storage/client.gen.d.ts +12 -0
- package/dist/generated/storage/core/auth.gen.d.ts +25 -0
- package/dist/generated/storage/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/storage/core/params.gen.d.ts +43 -0
- package/dist/generated/storage/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/storage/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/storage/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/storage/core/types.gen.d.ts +83 -0
- package/dist/generated/storage/core/utils.gen.d.ts +19 -0
- package/dist/generated/storage/index.d.ts +2 -0
- package/dist/generated/storage/index.js +6 -0
- package/dist/generated/storage/sdk.gen.d.ts +2285 -0
- package/dist/generated/storage/types.gen.d.ts +34546 -0
- package/dist/generated/unfurl/client/client.gen.d.ts +2 -0
- package/dist/generated/unfurl/client/index.d.ts +10 -0
- package/dist/generated/unfurl/client/types.gen.d.ts +120 -0
- package/dist/generated/unfurl/client/utils.gen.d.ts +37 -0
- package/dist/generated/unfurl/client.gen.d.ts +12 -0
- package/dist/generated/unfurl/core/auth.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/params.gen.d.ts +43 -0
- package/dist/generated/unfurl/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/unfurl/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/unfurl/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/unfurl/core/types.gen.d.ts +83 -0
- package/dist/generated/unfurl/core/utils.gen.d.ts +19 -0
- package/dist/generated/unfurl/index.d.ts +2 -0
- package/dist/generated/unfurl/index.js +6 -0
- package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
- package/dist/generated/unfurl/types.gen.d.ts +145 -0
- package/dist/src/calls/browser.d.ts +14 -0
- package/dist/src/calls/browser.js +102 -0
- package/dist/src/calls/common.d.ts +18 -0
- package/dist/src/calls/node.d.ts +24 -0
- package/dist/src/calls/node.js +145 -0
- package/dist/src/calls/telemetry.d.ts +5 -0
- package/dist/src/config.d.ts +71 -0
- package/dist/src/entities/account-managers/grant.d.ts +62 -0
- package/dist/src/entities/account-managers/namespace.d.ts +29 -0
- package/dist/src/entities/activity/entity.d.ts +7 -0
- package/dist/src/entities/activity/namespace.d.ts +58 -0
- package/dist/src/entities/activity/namespace.test.d.ts +1 -0
- package/dist/src/entities/agent-sessions/activity.d.ts +48 -0
- package/dist/src/entities/agent-sessions/agent-session.d.ts +518 -0
- package/dist/src/entities/agent-sessions/code-execution.d.ts +60 -0
- package/dist/src/entities/agent-sessions/conversation.d.ts +91 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +142 -0
- package/dist/src/entities/agent-sessions/origin.d.ts +94 -0
- package/dist/src/entities/agent-sessions/queued-action.d.ts +60 -0
- package/dist/src/entities/agent-sessions/review.d.ts +114 -0
- package/dist/src/entities/agent-sessions/tool-approval.d.ts +25 -0
- package/dist/src/entities/agent-sessions/view.d.ts +11 -0
- package/dist/src/entities/agents/agent.d.ts +142 -0
- package/dist/src/entities/agents/namespace.d.ts +66 -0
- package/dist/src/entities/ai/namespace.d.ts +36 -0
- package/dist/src/entities/api-keys/api-key.d.ts +22 -0
- package/dist/src/entities/api-keys/namespace.d.ts +37 -0
- package/dist/src/entities/bots/bot.d.ts +143 -0
- package/dist/src/entities/bots/namespace.d.ts +50 -0
- package/dist/src/entities/bots/token.d.ts +39 -0
- package/dist/src/entities/calendar/booking-link.d.ts +55 -0
- package/dist/src/entities/calendar/booking-namespace.d.ts +143 -0
- package/dist/src/entities/calendar/booking-namespace.test.d.ts +1 -0
- package/dist/src/entities/calendar/booking.d.ts +97 -0
- package/dist/src/entities/calendar/calendar.d.ts +49 -0
- package/dist/src/entities/calendar/create-confirmed.test.d.ts +1 -0
- package/dist/src/entities/calendar/event.d.ts +283 -0
- package/dist/src/entities/calendar/event.test.d.ts +1 -0
- package/dist/src/entities/calendar/namespace.d.ts +334 -0
- package/dist/src/entities/calendar/namespace.test.d.ts +1 -0
- package/dist/src/entities/calendar/replacement.d.ts +31 -0
- package/dist/src/entities/calls/call-record.d.ts +231 -0
- package/dist/src/entities/calls/connection.d.ts +59 -0
- package/dist/src/entities/calls/errors.d.ts +15 -0
- package/dist/src/entities/calls/message.d.ts +55 -0
- package/dist/src/entities/calls/namespace.d.ts +41 -0
- package/dist/src/entities/calls/participant.d.ts +22 -0
- package/dist/src/entities/canvases/canvas.d.ts +329 -0
- package/dist/src/entities/channels/access-request.d.ts +42 -0
- package/dist/src/entities/channels/activity.d.ts +40 -0
- package/dist/src/entities/channels/channel.d.ts +302 -0
- package/dist/src/entities/channels/labels.d.ts +73 -0
- package/dist/src/entities/channels/message.d.ts +153 -0
- package/dist/src/entities/channels/message.test.d.ts +1 -0
- package/dist/src/entities/channels/namespace.d.ts +82 -0
- package/dist/src/entities/channels/namespace.test.d.ts +1 -0
- package/dist/src/entities/channels/picture.d.ts +11 -0
- package/dist/src/entities/channels/post.d.ts +37 -0
- package/dist/src/entities/channels/post.test.d.ts +1 -0
- package/dist/src/entities/channels/share.d.ts +9 -0
- package/dist/src/entities/channels/share.test.d.ts +1 -0
- package/dist/src/entities/channels/thread.d.ts +64 -0
- package/dist/src/entities/chats/chat.d.ts +121 -0
- package/dist/src/entities/chats/generation.d.ts +55 -0
- package/dist/src/entities/chats/namespace.d.ts +35 -0
- package/dist/src/entities/connected-apps/connected-app.d.ts +121 -0
- package/dist/src/entities/connected-apps/connector.d.ts +59 -0
- package/dist/src/entities/connected-apps/namespace.d.ts +92 -0
- package/dist/src/entities/crm/company.d.ts +154 -0
- package/dist/src/entities/crm/contact.d.ts +168 -0
- package/dist/src/entities/crm/namespace.d.ts +163 -0
- package/dist/src/entities/crm/pipeline-entry.d.ts +109 -0
- package/dist/src/entities/crm/pipeline.d.ts +426 -0
- package/dist/src/entities/crm/pipelines.d.ts +79 -0
- package/dist/src/entities/crm-email-privacy/email-privacy.d.ts +238 -0
- package/dist/src/entities/crm-email-privacy/email-rule-preview.d.ts +55 -0
- package/dist/src/entities/crm-email-privacy/email-rule-revision.d.ts +27 -0
- package/dist/src/entities/crm-email-privacy/email-rules.d.ts +32 -0
- package/dist/src/entities/databases/column.d.ts +122 -0
- package/dist/src/entities/databases/database.d.ts +431 -0
- package/dist/src/entities/databases/namespace.d.ts +109 -0
- package/dist/src/entities/databases/query.d.ts +86 -0
- package/dist/src/entities/databases/row.d.ts +29 -0
- package/dist/src/entities/databases/saved-query.d.ts +151 -0
- package/dist/src/entities/databases/table.d.ts +124 -0
- package/dist/src/entities/databases/view.d.ts +72 -0
- package/dist/src/entities/databases/webhook.d.ts +39 -0
- package/dist/src/entities/documents/ai-edit.d.ts +54 -0
- package/dist/src/entities/documents/anchor.d.ts +39 -0
- package/dist/src/entities/documents/comment.d.ts +68 -0
- package/dist/src/entities/documents/create.test.d.ts +1 -0
- package/dist/src/entities/documents/document.d.ts +675 -0
- package/dist/src/entities/documents/markdown.d.ts +25 -0
- package/dist/src/entities/documents/namespace.d.ts +291 -0
- package/dist/src/entities/documents/office-files.d.ts +47 -0
- package/dist/src/entities/documents/skills.test.d.ts +1 -0
- package/dist/src/entities/documents/system-skill.d.ts +36 -0
- package/dist/src/entities/documents/text-comment.d.ts +41 -0
- package/dist/src/entities/documents/text-comment.test.d.ts +1 -0
- package/dist/src/entities/documents/version.d.ts +26 -0
- package/dist/src/entities/email/attachment.d.ts +39 -0
- package/dist/src/entities/email/body-rox-compat.d.ts +22 -0
- package/dist/src/entities/email/draft.d.ts +164 -0
- package/dist/src/entities/email/filter.d.ts +44 -0
- package/dist/src/entities/email/label.d.ts +37 -0
- package/dist/src/entities/email/link.d.ts +35 -0
- package/dist/src/entities/email/message.d.ts +223 -0
- package/dist/src/entities/email/namespace.d.ts +235 -0
- package/dist/src/entities/email/namespace.test.d.ts +1 -0
- package/dist/src/entities/email/thread.d.ts +268 -0
- package/dist/src/entities/entity-mentions/mention.d.ts +21 -0
- package/dist/src/entities/entity-mentions/namespace.d.ts +20 -0
- package/dist/src/entities/entity.d.ts +167 -0
- package/dist/src/entities/external-chat/chat.d.ts +173 -0
- package/dist/src/entities/external-chat/message.d.ts +54 -0
- package/dist/src/entities/external-chat/namespace.d.ts +22 -0
- package/dist/src/entities/external-chat/participant.d.ts +28 -0
- package/dist/src/entities/external-chat/send.d.ts +40 -0
- package/dist/src/entities/external-chat/upload.d.ts +25 -0
- package/dist/src/entities/favorites/namespace.d.ts +52 -0
- package/dist/src/entities/foreign/foreign-entity.d.ts +36 -0
- package/dist/src/entities/foreign/namespace.d.ts +54 -0
- package/dist/src/entities/forms/form.d.ts +319 -0
- package/dist/src/entities/forms/namespace.d.ts +30 -0
- package/dist/src/entities/forms/question.d.ts +65 -0
- package/dist/src/entities/forms/response.d.ts +52 -0
- package/dist/src/entities/forms/section.d.ts +31 -0
- package/dist/src/entities/github-pull-requests/namespace.d.ts +20 -0
- package/dist/src/entities/github-pull-requests/pull-request.d.ts +64 -0
- package/dist/src/entities/harnesses/harness.d.ts +76 -0
- package/dist/src/entities/harnesses/namespace.d.ts +83 -0
- package/dist/src/entities/harnesses/pairing.d.ts +50 -0
- package/dist/src/entities/images/image.d.ts +88 -0
- package/dist/src/entities/images/namespace.d.ts +55 -0
- package/dist/src/entities/images/namespace.test.d.ts +1 -0
- package/dist/src/entities/imports/entry.d.ts +65 -0
- package/dist/src/entities/imports/namespace.d.ts +103 -0
- package/dist/src/entities/imports/namespace.test.d.ts +1 -0
- package/dist/src/entities/initiatives/initiative.d.ts +185 -0
- package/dist/src/entities/initiatives/initiative.test.d.ts +1 -0
- package/dist/src/entities/initiatives/namespace.d.ts +90 -0
- package/dist/src/entities/me/namespace.d.ts +68 -0
- package/dist/src/entities/meetings/meeting.d.ts +81 -0
- package/dist/src/entities/meetings/namespace.d.ts +38 -0
- package/dist/src/entities/memory/namespace.d.ts +49 -0
- package/dist/src/entities/memory/namespace.test.d.ts +1 -0
- package/dist/src/entities/messages/discussion.d.ts +84 -0
- package/dist/src/entities/messages/thread.d.ts +115 -0
- package/dist/src/entities/notifications/namespace.d.ts +66 -0
- package/dist/src/entities/notifications/notification.d.ts +78 -0
- package/dist/src/entities/notifications/notification.test.d.ts +1 -0
- package/dist/src/entities/passwords/item.d.ts +118 -0
- package/dist/src/entities/passwords/namespace.d.ts +45 -0
- package/dist/src/entities/pins/namespace.d.ts +42 -0
- package/dist/src/entities/projects/namespace.d.ts +45 -0
- package/dist/src/entities/projects/project.d.ts +108 -0
- package/dist/src/entities/properties/namespace.d.ts +105 -0
- package/dist/src/entities/properties/namespace.test.d.ts +1 -0
- package/dist/src/entities/properties/property-definition.d.ts +70 -0
- package/dist/src/entities/properties/property-option.d.ts +44 -0
- package/dist/src/entities/reference.d.ts +82 -0
- package/dist/src/entities/referrals/namespace.d.ts +40 -0
- package/dist/src/entities/routines/namespace.d.ts +239 -0
- package/dist/src/entities/routines/routine.d.ts +341 -0
- package/dist/src/entities/routines/suggestion.d.ts +38 -0
- package/dist/src/entities/saved-views/namespace.d.ts +58 -0
- package/dist/src/entities/saved-views/saved-view.d.ts +78 -0
- package/dist/src/entities/search/exclusions.d.ts +6 -0
- package/dist/src/entities/search/namespace.d.ts +71 -0
- package/dist/src/entities/search/options.d.ts +30 -0
- package/dist/src/entities/search/types.d.ts +90 -0
- package/dist/src/entities/sharing/access.d.ts +120 -0
- package/dist/src/entities/sharing/permissions.d.ts +13 -0
- package/dist/src/entities/spreadsheets/spreadsheet.d.ts +201 -0
- package/dist/src/entities/suggestions/namespace.d.ts +118 -0
- package/dist/src/entities/suggestions/suggestion.d.ts +172 -0
- package/dist/src/entities/suggestions/suggestion.test.d.ts +1 -0
- package/dist/src/entities/tasks/namespace.d.ts +77 -0
- package/dist/src/entities/tasks/task.d.ts +99 -0
- package/dist/src/entities/teams/invite.d.ts +33 -0
- package/dist/src/entities/teams/namespace.d.ts +23 -0
- package/dist/src/entities/teams/team.d.ts +129 -0
- package/dist/src/entities/ui/app-link.d.ts +24 -0
- package/dist/src/entities/ui/namespace.d.ts +75 -0
- package/dist/src/entities/unfurls/namespace.d.ts +24 -0
- package/dist/src/entities/users/namespace.d.ts +41 -0
- package/dist/src/entities/users/profile-picture.d.ts +29 -0
- package/dist/src/entities/users/profile-picture.test.d.ts +1 -0
- package/dist/src/entities/users/user.d.ts +102 -0
- package/dist/src/entities/web/namespace.d.ts +67 -0
- package/dist/src/entities/web/namespace.test.d.ts +1 -0
- package/dist/src/entities/webhooks/namespace.d.ts +38 -0
- package/dist/src/entities/webhooks/webhook.d.ts +130 -0
- package/dist/src/entities/whatsapp/account.d.ts +24 -0
- package/dist/src/entities/whatsapp/chat.d.ts +62 -0
- package/dist/src/entities/whatsapp/namespace.d.ts +29 -0
- package/dist/src/entities/workspace/items.d.ts +14 -0
- package/dist/src/entities/workspace/namespace.d.ts +96 -0
- package/dist/src/entities/workspace/query.d.ts +39 -0
- package/dist/src/entities/workspace/query.test.d.ts +1 -0
- package/dist/src/entities/workspace/types.d.ts +99 -0
- package/dist/src/events/hydrate/agentSession.d.ts +192 -0
- package/dist/src/events/hydrate/call.d.ts +101 -0
- package/dist/src/events/hydrate/channel.d.ts +55 -0
- package/dist/src/events/hydrate/document.d.ts +59 -0
- package/dist/src/events/hydrate/message.d.ts +70 -0
- package/dist/src/events/hydrate/user.d.ts +14 -0
- package/dist/src/events/receiver.d.ts +91 -0
- package/dist/src/events/types.d.ts +44 -0
- package/dist/src/events/verify.d.ts +13 -0
- package/dist/src/local-portmap.d.ts +8 -0
- package/dist/src/mentions.d.ts +42 -0
- package/dist/src/raw.d.ts +12 -0
- package/dist/src/rox.d.ts +268 -0
- package/dist/src/rox.js +23231 -0
- package/dist/src/utils/activity.d.ts +34 -0
- package/dist/src/utils/activity.test.d.ts +1 -0
- package/dist/src/utils/client.d.ts +62 -0
- package/dist/src/utils/concurrency.d.ts +5 -0
- package/dist/src/utils/index.d.ts +5 -0
- package/dist/src/utils/lazy.d.ts +37 -0
- package/dist/src/utils/options.d.ts +7 -0
- package/dist/src/utils/pagination.d.ts +28 -0
- package/dist/src/utils/unwrap.d.ts +48 -0
- package/dist/src/utils/verbs.d.ts +3 -0
- package/package.json +82 -4
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import type { RoxClient } from '../../utils/client';
|
|
2
|
+
import type { Database } from './database';
|
|
3
|
+
import type { DatabaseTable } from './table';
|
|
4
|
+
/** Display modes that draw a chart, and so need {@link SavedQueryChart} columns. */
|
|
5
|
+
export declare const SAVED_QUERY_CHART_MODES: readonly ["bar", "line", "area", "scatter", "pie"];
|
|
6
|
+
/** A display mode that draws a chart. */
|
|
7
|
+
export type SavedQueryChartMode = (typeof SAVED_QUERY_CHART_MODES)[number];
|
|
8
|
+
/**
|
|
9
|
+
* How an answer is shown: `scalar` for one number, inline in text; `table`
|
|
10
|
+
* for rows; a chart mode to plot them.
|
|
11
|
+
*/
|
|
12
|
+
export type SavedQueryDisplayMode = 'scalar' | 'table' | SavedQueryChartMode;
|
|
13
|
+
/** Most `y` columns one chart plots. */
|
|
14
|
+
export declare const SAVED_QUERY_MAX_SERIES = 5;
|
|
15
|
+
/** Smallest and largest height, in pixels, a block's results viewport takes. */
|
|
16
|
+
export declare const SAVED_QUERY_HEIGHT_RANGE: {
|
|
17
|
+
readonly min: 96;
|
|
18
|
+
readonly max: 1600;
|
|
19
|
+
};
|
|
20
|
+
/** Which result columns a chart plots, named exactly as the `SELECT` returns them. */
|
|
21
|
+
export type SavedQueryChart = {
|
|
22
|
+
/** The label column: the x axis, or the pie's slices. */
|
|
23
|
+
x: string;
|
|
24
|
+
/** One to five numeric result columns to plot, none equal to `x`. */
|
|
25
|
+
y: string[];
|
|
26
|
+
/** Chart heading. */
|
|
27
|
+
title?: string;
|
|
28
|
+
/** A column whose values split the one `y` series into a series per value. */
|
|
29
|
+
color?: string;
|
|
30
|
+
/** Stack bar or area series instead of setting them side by side. */
|
|
31
|
+
stack?: boolean;
|
|
32
|
+
};
|
|
33
|
+
/** How an answer is shown: a chart mode always carries its chart. */
|
|
34
|
+
export type SavedQueryDisplay = {
|
|
35
|
+
mode: 'scalar' | 'table';
|
|
36
|
+
} | {
|
|
37
|
+
mode: SavedQueryChartMode;
|
|
38
|
+
chart: SavedQueryChart;
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* Options for `rox.databases.saveQuery`, {@link Database.saveQuery} and
|
|
42
|
+
* {@link DatabaseTable.saveQuery}.
|
|
43
|
+
*/
|
|
44
|
+
export type SaveQueryOptions = {
|
|
45
|
+
/** One `SELECT`, exactly as it ran with `query`. */
|
|
46
|
+
sql: string;
|
|
47
|
+
/** Short heading shown with the answer, e.g. "Invites per party". */
|
|
48
|
+
title: string;
|
|
49
|
+
/** The question in the user's words; by default, the title. */
|
|
50
|
+
prompt?: string;
|
|
51
|
+
/** How the answer is shown. */
|
|
52
|
+
display: SavedQueryDisplay;
|
|
53
|
+
/** Preferred height of the results viewport, in pixels, from 96 to 1600. */
|
|
54
|
+
height?: number;
|
|
55
|
+
};
|
|
56
|
+
/** What {@link SavedQuery.withView} changes; everything else stays. */
|
|
57
|
+
export type SavedQueryView = {
|
|
58
|
+
/** The new display mode. A chart mode needs a chart, given here or already set. */
|
|
59
|
+
displayMode?: SavedQueryDisplayMode;
|
|
60
|
+
/** The new chart columns. */
|
|
61
|
+
chart?: SavedQueryChart;
|
|
62
|
+
/** The new heading. */
|
|
63
|
+
title?: string;
|
|
64
|
+
/** The new viewport height, in pixels, from 96 to 1600. */
|
|
65
|
+
height?: number;
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* A saved question: an immutable `SELECT` stored on the server, with how its
|
|
69
|
+
* answer is shown. Its block ({@link toBlock}) renders the answer live,
|
|
70
|
+
* re-running the question for whoever views it with their permissions, so it
|
|
71
|
+
* stays current as the data changes. The SQL never leaves the server inside
|
|
72
|
+
* the block; the block names the question by id.
|
|
73
|
+
*
|
|
74
|
+
* Changing the SQL means saving a new question. Changing how the answer
|
|
75
|
+
* looks does not: {@link withView} returns the same question shown another
|
|
76
|
+
* way.
|
|
77
|
+
*
|
|
78
|
+
* @mcp-exclude Built from a listing record; no id-only reference an MCP call can pass.
|
|
79
|
+
*/
|
|
80
|
+
export declare class SavedQuery {
|
|
81
|
+
private readonly client;
|
|
82
|
+
/** Identifier of the saved question. */
|
|
83
|
+
readonly id: string;
|
|
84
|
+
/** The database whose tables win name resolution, if one was given. */
|
|
85
|
+
readonly database: Database | undefined;
|
|
86
|
+
/** The table the question is about, when it was saved from one. */
|
|
87
|
+
readonly table: DatabaseTable | undefined;
|
|
88
|
+
private readonly presentation;
|
|
89
|
+
private constructor();
|
|
90
|
+
/**
|
|
91
|
+
* @internal Save a question. The server checks that the SQL is one
|
|
92
|
+
* `SELECT` that compiles against the caller's databases, and that every
|
|
93
|
+
* chart column is one it returns.
|
|
94
|
+
*/
|
|
95
|
+
static save(client: RoxClient, scope: {
|
|
96
|
+
database: Database;
|
|
97
|
+
table?: DatabaseTable;
|
|
98
|
+
} | {
|
|
99
|
+
database?: undefined;
|
|
100
|
+
table?: undefined;
|
|
101
|
+
}, options: SaveQueryOptions): Promise<SavedQuery>;
|
|
102
|
+
/** The heading shown with the answer. */
|
|
103
|
+
get title(): string;
|
|
104
|
+
/** The question in the user's words. */
|
|
105
|
+
get prompt(): string;
|
|
106
|
+
/** How the answer is shown. */
|
|
107
|
+
get displayMode(): SavedQueryDisplayMode;
|
|
108
|
+
/** Which result columns the chart plots, if it has one. */
|
|
109
|
+
get chart(): SavedQueryChart | undefined;
|
|
110
|
+
/** Preferred height of the results viewport, in pixels, if set. */
|
|
111
|
+
get height(): number | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* The saved `SELECT`, read from the server.
|
|
114
|
+
*
|
|
115
|
+
* @readonly
|
|
116
|
+
*/
|
|
117
|
+
sql(): Promise<string>;
|
|
118
|
+
/**
|
|
119
|
+
* The same question shown another way: a new display mode, chart, title or
|
|
120
|
+
* height, as a document's block can be restyled in place. The question
|
|
121
|
+
* itself never changes; save a new one to ask something else.
|
|
122
|
+
*
|
|
123
|
+
* A chart mode needs chart columns, given here or already set. A `scalar`
|
|
124
|
+
* answer sits inline in text and every other mode is a block, so a
|
|
125
|
+
* question cannot switch between `scalar` and another mode; save it again
|
|
126
|
+
* with the mode it should have.
|
|
127
|
+
*
|
|
128
|
+
* @readonly
|
|
129
|
+
*/
|
|
130
|
+
withView(view: SavedQueryView): SavedQuery;
|
|
131
|
+
/**
|
|
132
|
+
* The block that shows the live answer, to put verbatim in a document's
|
|
133
|
+
* Markdown or quote verbatim in edit instructions. Never write or edit a
|
|
134
|
+
* block by hand: it names the question by id, and the SQL stays on the
|
|
135
|
+
* server.
|
|
136
|
+
*
|
|
137
|
+
* @readonly
|
|
138
|
+
*/
|
|
139
|
+
toBlock(): string;
|
|
140
|
+
toJSON(): {
|
|
141
|
+
id: string;
|
|
142
|
+
databaseId: string | undefined;
|
|
143
|
+
tableId: string | undefined;
|
|
144
|
+
title: string;
|
|
145
|
+
prompt: string;
|
|
146
|
+
displayMode: SavedQueryDisplayMode;
|
|
147
|
+
chart: SavedQueryChart | undefined;
|
|
148
|
+
height: number | undefined;
|
|
149
|
+
block: string;
|
|
150
|
+
};
|
|
151
|
+
}
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import type { TableDetail, TableVersion } from '../../../generated/storage/types.gen';
|
|
2
|
+
import { DatabaseColumn } from './column';
|
|
3
|
+
import type { AddColumnOptions, Database } from './database';
|
|
4
|
+
import { DatabaseRow } from './row';
|
|
5
|
+
import type { SavedQuery, SaveQueryOptions } from './saved-query';
|
|
6
|
+
import { DatabaseView } from './view';
|
|
7
|
+
import type { DatabaseWebhook } from './webhook';
|
|
8
|
+
/**
|
|
9
|
+
* One table (tab) of a {@link Database}.
|
|
10
|
+
*
|
|
11
|
+
* A table is not an entity of its own — it is owned and shared as part of its
|
|
12
|
+
* database, and has no endpoint to read it directly. The handle resolves
|
|
13
|
+
* through {@link Database.schema}, so reads after a write see the new state.
|
|
14
|
+
*/
|
|
15
|
+
export declare class DatabaseTable {
|
|
16
|
+
/** The database this table belongs to. */
|
|
17
|
+
readonly database: Database;
|
|
18
|
+
/** Identifier of the table. */
|
|
19
|
+
readonly id: string;
|
|
20
|
+
private constructor();
|
|
21
|
+
/** A handle to a table by id, within a database. Details load on first access. */
|
|
22
|
+
static byId(database: Database, id: string): DatabaseTable;
|
|
23
|
+
/**
|
|
24
|
+
* The table's record as the API returns it: the table, its columns, and
|
|
25
|
+
* its views.
|
|
26
|
+
*
|
|
27
|
+
* @readonly
|
|
28
|
+
*/
|
|
29
|
+
detail(): Promise<TableDetail>;
|
|
30
|
+
/**
|
|
31
|
+
* The table's display name.
|
|
32
|
+
*
|
|
33
|
+
* @readonly
|
|
34
|
+
*/
|
|
35
|
+
name(): Promise<string>;
|
|
36
|
+
/**
|
|
37
|
+
* Rename only if the last-read display name is still current.
|
|
38
|
+
*
|
|
39
|
+
* @write
|
|
40
|
+
* @idempotent
|
|
41
|
+
*/
|
|
42
|
+
rename(name: string): Promise<DatabaseTable>;
|
|
43
|
+
/**
|
|
44
|
+
* The table's current version, bumped by every committed change to its
|
|
45
|
+
* schema or rows. Schema edits such as {@link reorderColumns} send it as
|
|
46
|
+
* the base version they were made against, so a table that moved since
|
|
47
|
+
* refuses the edit with a 409.
|
|
48
|
+
*
|
|
49
|
+
* @readonly
|
|
50
|
+
*/
|
|
51
|
+
version(): Promise<TableVersion>;
|
|
52
|
+
/**
|
|
53
|
+
* The table's fractional index within the database's tab order.
|
|
54
|
+
*
|
|
55
|
+
* @readonly
|
|
56
|
+
*/
|
|
57
|
+
position(): Promise<string>;
|
|
58
|
+
/**
|
|
59
|
+
* The table's columns, in display order.
|
|
60
|
+
*
|
|
61
|
+
* @readonly
|
|
62
|
+
*/
|
|
63
|
+
columns(): Promise<DatabaseColumn[]>;
|
|
64
|
+
/**
|
|
65
|
+
* Add a column to this table. See {@link Database.addColumn}.
|
|
66
|
+
*
|
|
67
|
+
* @write
|
|
68
|
+
*/
|
|
69
|
+
addColumn(options: AddColumnOptions): Promise<DatabaseColumn>;
|
|
70
|
+
/**
|
|
71
|
+
* Persist a new column order. See {@link Database.reorderColumns}.
|
|
72
|
+
*
|
|
73
|
+
* @write
|
|
74
|
+
* @idempotent
|
|
75
|
+
*/
|
|
76
|
+
reorderColumns(columns: DatabaseColumn[]): Promise<DatabaseTable>;
|
|
77
|
+
/**
|
|
78
|
+
* A handle to one of the table's rows, by the id an insert answered.
|
|
79
|
+
*
|
|
80
|
+
* @readonly
|
|
81
|
+
*/
|
|
82
|
+
row(id: string): DatabaseRow;
|
|
83
|
+
/**
|
|
84
|
+
* The table's views, in their order.
|
|
85
|
+
*
|
|
86
|
+
* @readonly
|
|
87
|
+
*/
|
|
88
|
+
views(): Promise<DatabaseView[]>;
|
|
89
|
+
/**
|
|
90
|
+
* Create a webhook that inserts rows here. See {@link Database.createWebhook}.
|
|
91
|
+
*
|
|
92
|
+
* @write
|
|
93
|
+
*/
|
|
94
|
+
createWebhook(): Promise<{
|
|
95
|
+
webhook: DatabaseWebhook;
|
|
96
|
+
token: string;
|
|
97
|
+
}>;
|
|
98
|
+
/**
|
|
99
|
+
* Save a `SELECT` about this table as a live question. See {@link Database.saveQuery}.
|
|
100
|
+
*
|
|
101
|
+
* @write
|
|
102
|
+
*/
|
|
103
|
+
saveQuery(options: SaveQueryOptions): Promise<SavedQuery>;
|
|
104
|
+
/**
|
|
105
|
+
* Delete this table. See {@link Database.deleteTable}.
|
|
106
|
+
*
|
|
107
|
+
* @destructive
|
|
108
|
+
* @idempotent
|
|
109
|
+
*/
|
|
110
|
+
delete(): Promise<void>;
|
|
111
|
+
/**
|
|
112
|
+
* This table's URL in the Rox web app: the database, opened on this
|
|
113
|
+
* table. Hand it to users as the link to a table you built or changed.
|
|
114
|
+
*
|
|
115
|
+
* @readonly
|
|
116
|
+
*/
|
|
117
|
+
webUrl(): string;
|
|
118
|
+
/** Identity and {@link webUrl}, so serialized handles carry their link. */
|
|
119
|
+
toJSON(): {
|
|
120
|
+
id: string;
|
|
121
|
+
databaseId: string;
|
|
122
|
+
url: string;
|
|
123
|
+
};
|
|
124
|
+
}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import type { CardPosition, DatabaseView as DatabaseViewRecord, ViewLayout, ViewQuery } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { DatabaseTable } from './table';
|
|
3
|
+
/**
|
|
4
|
+
* One view of a {@link DatabaseTable}: which of its rows to show, in what
|
|
5
|
+
* order, drawn as a table or a board.
|
|
6
|
+
*
|
|
7
|
+
* A view is not an entity of its own — it is owned and shared as part of its
|
|
8
|
+
* database. The handle resolves through the database's schema, so a fresh
|
|
9
|
+
* read after a write sees the new value. Views are created, changed, and
|
|
10
|
+
* reordered with ops; see {@link Database.applyOps}.
|
|
11
|
+
*/
|
|
12
|
+
export declare class DatabaseView {
|
|
13
|
+
/** The table this view shows. */
|
|
14
|
+
readonly table: DatabaseTable;
|
|
15
|
+
/** Identifier of the view. */
|
|
16
|
+
readonly id: string;
|
|
17
|
+
private constructor();
|
|
18
|
+
/** A handle to a view by id, within a table. Details load on first access. */
|
|
19
|
+
static byId(table: DatabaseTable, id: string): DatabaseView;
|
|
20
|
+
/**
|
|
21
|
+
* The view's record as the API returns it.
|
|
22
|
+
*
|
|
23
|
+
* @readonly
|
|
24
|
+
*/
|
|
25
|
+
detail(): Promise<DatabaseViewRecord>;
|
|
26
|
+
/**
|
|
27
|
+
* The view's name, unique among its table's views ignoring case.
|
|
28
|
+
*
|
|
29
|
+
* @readonly
|
|
30
|
+
*/
|
|
31
|
+
name(): Promise<string>;
|
|
32
|
+
/**
|
|
33
|
+
* The view's fractional index within its table's views.
|
|
34
|
+
*
|
|
35
|
+
* @readonly
|
|
36
|
+
*/
|
|
37
|
+
position(): Promise<string>;
|
|
38
|
+
/**
|
|
39
|
+
* How the view draws its rows: a table, or a board grouped by a column.
|
|
40
|
+
*
|
|
41
|
+
* @readonly
|
|
42
|
+
*/
|
|
43
|
+
layout(): Promise<ViewLayout>;
|
|
44
|
+
/**
|
|
45
|
+
* Which rows the view shows, and in what order.
|
|
46
|
+
*
|
|
47
|
+
* @readonly
|
|
48
|
+
*/
|
|
49
|
+
query(): Promise<ViewQuery>;
|
|
50
|
+
/**
|
|
51
|
+
* Where a board's cards sit: each placed card's lane and its key there.
|
|
52
|
+
* Cards without a place show after the placed ones of their lane, oldest
|
|
53
|
+
* first.
|
|
54
|
+
*
|
|
55
|
+
* @readonly
|
|
56
|
+
*/
|
|
57
|
+
positions(): Promise<CardPosition[]>;
|
|
58
|
+
/**
|
|
59
|
+
* This view's URL in the Rox web app: the database, opened on this
|
|
60
|
+
* view's table and this view. Hand it to users as the link to a view you
|
|
61
|
+
* built.
|
|
62
|
+
*
|
|
63
|
+
* @readonly
|
|
64
|
+
*/
|
|
65
|
+
webUrl(): string;
|
|
66
|
+
/** Identity and {@link webUrl}, so serialized handles carry their link. */
|
|
67
|
+
toJSON(): {
|
|
68
|
+
id: string;
|
|
69
|
+
tableId: string;
|
|
70
|
+
url: string;
|
|
71
|
+
};
|
|
72
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { DatabaseWebhookResponse } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { User } from '../users/user';
|
|
3
|
+
import type { DatabaseTable } from './table';
|
|
4
|
+
/**
|
|
5
|
+
* A webhook of a {@link DatabaseTable}: a secret URL that anyone holding it
|
|
6
|
+
* can POST JSON to, each object becoming a row, written with the access of
|
|
7
|
+
* the user who created it. Its token is shown only when it is created; see
|
|
8
|
+
* {@link Database.createWebhook}.
|
|
9
|
+
*
|
|
10
|
+
* @mcp-exclude Built from a listing record; no id-only reference an MCP call can pass.
|
|
11
|
+
*/
|
|
12
|
+
export declare class DatabaseWebhook {
|
|
13
|
+
/** The table its calls insert rows into. */
|
|
14
|
+
readonly table: DatabaseTable;
|
|
15
|
+
/** Identifier of the webhook. */
|
|
16
|
+
readonly id: string;
|
|
17
|
+
/** Who created it; its calls write with their access. */
|
|
18
|
+
readonly createdBy: User;
|
|
19
|
+
private readonly record;
|
|
20
|
+
private constructor();
|
|
21
|
+
/** A handle from the record the API answered. */
|
|
22
|
+
static fromRecord(table: DatabaseTable, createdBy: User, record: DatabaseWebhookResponse): DatabaseWebhook;
|
|
23
|
+
/** The token's first characters, to tell webhooks apart without the secret. */
|
|
24
|
+
get tokenPrefix(): string;
|
|
25
|
+
/** When it was created. */
|
|
26
|
+
get createdAt(): string;
|
|
27
|
+
/**
|
|
28
|
+
* Delete the webhook; its URL stops working.
|
|
29
|
+
*
|
|
30
|
+
* @destructive
|
|
31
|
+
* @idempotent
|
|
32
|
+
*/
|
|
33
|
+
delete(): Promise<void>;
|
|
34
|
+
toJSON(): {
|
|
35
|
+
id: string;
|
|
36
|
+
tableId: string;
|
|
37
|
+
tokenPrefix: string;
|
|
38
|
+
};
|
|
39
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import type { DocumentAiEditRefused } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import { RoxApiError } from '../../utils/unwrap';
|
|
4
|
+
import type { Document } from './document';
|
|
5
|
+
/**
|
|
6
|
+
* An edit was sent but its outcome is unknown: the service reported a failure
|
|
7
|
+
* after the edit started (HTTP 502), timed out (504), or the connection broke
|
|
8
|
+
* with no response (status 0). It may have partly applied. Read the document
|
|
9
|
+
* with `content()` before retrying; never replay the edit blindly.
|
|
10
|
+
*/
|
|
11
|
+
export declare class EditOutcomeUnknownError extends RoxApiError {
|
|
12
|
+
constructor(data: unknown, status?: number);
|
|
13
|
+
}
|
|
14
|
+
/** Options for `Document.edit`. */
|
|
15
|
+
export interface DocumentEditOptions {
|
|
16
|
+
/**
|
|
17
|
+
* One fast model instead of the full pipeline: quicker and cheaper, for
|
|
18
|
+
* small, local edits such as a sentence or a list.
|
|
19
|
+
*/
|
|
20
|
+
fast?: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Cancels the edit end to end and rejects with `AbortError`. What reached
|
|
23
|
+
* the document before the abort stays and nothing is applied after it; there
|
|
24
|
+
* is no rollback, so an aborted edit can be left part done, down to a
|
|
25
|
+
* sentence half retyped. Read `content()` to see what landed.
|
|
26
|
+
*/
|
|
27
|
+
signal?: AbortSignal;
|
|
28
|
+
}
|
|
29
|
+
/** What an instructions edit left; read the document to see what changed. */
|
|
30
|
+
export interface DocumentEditResult {
|
|
31
|
+
/** The document's version after the edit (base64 Loro version vector). */
|
|
32
|
+
revision: string;
|
|
33
|
+
/** Link to the document in the Rox web app. */
|
|
34
|
+
webUrl: string;
|
|
35
|
+
/**
|
|
36
|
+
* Set when the editor applied part of the edit and stopped: what it needs to
|
|
37
|
+
* know to finish. The applied part stays; send only the rest.
|
|
38
|
+
*/
|
|
39
|
+
clarification?: string;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* The editor can't do the edit as instructed (HTTP 422): the instructions are
|
|
43
|
+
* ambiguous, name text that isn't there, or pass an invalid block. Nothing
|
|
44
|
+
* changed. `reason` says what it needs; rewrite the instructions.
|
|
45
|
+
*/
|
|
46
|
+
export declare class DocumentEditRefusedError extends RoxApiError {
|
|
47
|
+
/** Why the editor refused, in its words. */
|
|
48
|
+
readonly reason: string;
|
|
49
|
+
constructor(refusal: DocumentAiEditRefused);
|
|
50
|
+
}
|
|
51
|
+
/** Run an instructions edit; `Document.edit` calls this. */
|
|
52
|
+
export declare function editWithInstructions(client: RoxClient, document: Document, instructions: string, options: DocumentEditOptions): Promise<DocumentEditResult>;
|
|
53
|
+
/** Whether an error body is the editor's refusal. */
|
|
54
|
+
export declare function isRefusal(error: unknown): error is DocumentAiEditRefused;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { Anchor as AnchorRecord, EditPdfPlaceableCommentAnchorRequest } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import { RoxEntity } from '../entity';
|
|
4
|
+
import type { Document } from './document';
|
|
5
|
+
/** A PDF annotation scoped to its document. */
|
|
6
|
+
export declare class DocumentAnchor extends RoxEntity<AnchorRecord> {
|
|
7
|
+
/** Owning document. */
|
|
8
|
+
readonly document: Document;
|
|
9
|
+
/** Serialize identity with its owning resource. */
|
|
10
|
+
toJSON(): {
|
|
11
|
+
documentId: string;
|
|
12
|
+
id: string;
|
|
13
|
+
detail?: import("../../../generated/storage").PdfAnchor | undefined;
|
|
14
|
+
};
|
|
15
|
+
private constructor();
|
|
16
|
+
/** Construct a document scoped annotation handle. */
|
|
17
|
+
static byId(client: RoxClient, document: Document, id: string): DocumentAnchor;
|
|
18
|
+
/** Seed an annotation from a document annotation listing. */
|
|
19
|
+
static from(client: RoxClient, document: Document, record: AnchorRecord): DocumentAnchor;
|
|
20
|
+
protected fetch(): Promise<AnchorRecord>;
|
|
21
|
+
/** Annotation kind. */
|
|
22
|
+
readonly kind: () => Promise<"highlight" | "placeable">;
|
|
23
|
+
/** Page containing the annotation. */
|
|
24
|
+
readonly page: () => Promise<number>;
|
|
25
|
+
/**
|
|
26
|
+
* Edit a placeable comment's position and display settings.
|
|
27
|
+
*
|
|
28
|
+
* @write
|
|
29
|
+
* @idempotent
|
|
30
|
+
*/
|
|
31
|
+
edit(options: Omit<EditPdfPlaceableCommentAnchorRequest, 'uuid'>): Promise<void>;
|
|
32
|
+
/**
|
|
33
|
+
* Delete a standalone highlight annotation.
|
|
34
|
+
*
|
|
35
|
+
* @destructive
|
|
36
|
+
* @idempotent
|
|
37
|
+
*/
|
|
38
|
+
delete(): Promise<void>;
|
|
39
|
+
}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import type { Message as MessageRecord } from '../../../generated/storage/types.gen';
|
|
2
|
+
import { type RichMessage } from '../../mentions';
|
|
3
|
+
import type { RoxClient } from '../../utils/client';
|
|
4
|
+
import { RoxEntity } from '../entity';
|
|
5
|
+
import { User } from '../users/user';
|
|
6
|
+
import { Document } from './document';
|
|
7
|
+
/**
|
|
8
|
+
* A comment on a document: a document-parent message, addressed by its
|
|
9
|
+
* document and message UUID. Its record and mutations are the ones channel
|
|
10
|
+
* messages use.
|
|
11
|
+
*/
|
|
12
|
+
export declare class Comment extends RoxEntity<MessageRecord> {
|
|
13
|
+
/** The document this comment belongs to. */
|
|
14
|
+
readonly documentId: string;
|
|
15
|
+
private constructor();
|
|
16
|
+
private get path();
|
|
17
|
+
protected fetch(): Promise<MessageRecord>;
|
|
18
|
+
/** A handle to a comment by id. Fields load on first access. */
|
|
19
|
+
static byId(client: RoxClient, documentId: string, id: string): Comment;
|
|
20
|
+
/** Build a comment from a message record (pre-seeded, no fetch). */
|
|
21
|
+
static from(client: RoxClient, documentId: string, record: MessageRecord): Comment;
|
|
22
|
+
/** The comment's text. */
|
|
23
|
+
readonly text: () => Promise<string>;
|
|
24
|
+
/** When the comment was created. */
|
|
25
|
+
readonly createdAt: () => Promise<string>;
|
|
26
|
+
/** When the comment was last updated. */
|
|
27
|
+
readonly updatedAt: () => Promise<string>;
|
|
28
|
+
/**
|
|
29
|
+
* The id of the thread this comment belongs to: its root, or itself for a root.
|
|
30
|
+
*
|
|
31
|
+
* @readonly
|
|
32
|
+
*/
|
|
33
|
+
threadId(): Promise<string>;
|
|
34
|
+
/**
|
|
35
|
+
* The document this comment is on.
|
|
36
|
+
*
|
|
37
|
+
* @readonly
|
|
38
|
+
*/
|
|
39
|
+
document(): Document;
|
|
40
|
+
/**
|
|
41
|
+
* The user who wrote this comment.
|
|
42
|
+
*
|
|
43
|
+
* @readonly
|
|
44
|
+
*/
|
|
45
|
+
author(): Promise<User>;
|
|
46
|
+
/**
|
|
47
|
+
* Reply in this comment's thread.
|
|
48
|
+
*
|
|
49
|
+
* @write
|
|
50
|
+
*/
|
|
51
|
+
reply(body: string | RichMessage): Promise<Comment>;
|
|
52
|
+
/**
|
|
53
|
+
* Replace the comment's text.
|
|
54
|
+
*
|
|
55
|
+
* @param body - Plain text, or a rich body composed with {@link msg}.
|
|
56
|
+
*
|
|
57
|
+
* @write
|
|
58
|
+
* @idempotent
|
|
59
|
+
*/
|
|
60
|
+
edit(body: string | RichMessage): Promise<this>;
|
|
61
|
+
/**
|
|
62
|
+
* Delete this comment.
|
|
63
|
+
*
|
|
64
|
+
* @destructive
|
|
65
|
+
* @idempotent
|
|
66
|
+
*/
|
|
67
|
+
delete(): Promise<void>;
|
|
68
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|