@open-pencil/cloud 0.17.0-beta.4 → 0.17.0-beta.6
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/README.md +2 -1
- package/dist/bin/server.mjs +1 -1
- package/dist/bin/server.mjs.map +1 -1
- package/dist/bin/services.mjs +1 -1
- package/dist/bin/services.mjs.map +1 -1
- package/dist/client.d.ts +783 -47
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +1651 -382
- package/dist/client.js.map +1 -1
- package/dist/contract.d.ts +2 -2
- package/dist/contract.js +2 -2
- package/dist/contract2.js +701 -45
- package/dist/contract2.js.map +1 -1
- package/dist/email.d.ts +2138 -34
- package/dist/email.d.ts.map +1 -1
- package/dist/email.js +4343 -306
- package/dist/email.js.map +1 -1
- package/dist/errors.d.ts +2 -0
- package/dist/errors.js +61 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +1338 -44
- package/dist/index.d.ts.map +1 -1
- package/dist/index2.d.ts +45 -0
- package/dist/index2.d.ts.map +1 -0
- package/dist/listen.mjs +958 -340
- package/dist/listen.mjs.map +1 -1
- package/dist/runtime-cloudflare.d.ts +93 -0
- package/dist/runtime-cloudflare.d.ts.map +1 -0
- package/dist/runtime-cloudflare.js +18032 -0
- package/dist/runtime-cloudflare.js.map +1 -0
- package/dist/runtime-node.d.mts +12615 -5249
- package/dist/runtime-node.d.mts.map +1 -1
- package/dist/server.d.ts +17367 -8567
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +13587 -7333
- package/dist/server.js.map +1 -1
- package/dist/server.mjs +11601 -5401
- package/dist/server.mjs.map +1 -1
- package/dist/server2.mjs +84 -62
- package/dist/server2.mjs.map +1 -1
- package/package.json +31 -5
- package/src/admin/api/routes.ts +263 -190
- package/src/admin/audit/service.ts +11 -3
- package/src/admin/bootstrap.ts +86 -0
- package/src/admin/documents/service.ts +195 -10
- package/src/admin/email/service.ts +2 -1
- package/src/admin/enrollment/email.ts +17 -3
- package/src/admin/enrollment/service.ts +71 -10
- package/src/admin/errors.ts +5 -0
- package/src/admin/index.ts +1 -0
- package/src/admin/reports/service.ts +15 -3
- package/src/admin/schema.ts +6 -5
- package/src/admin/users/service.ts +173 -16
- package/src/client/api.ts +52 -473
- package/src/client/auth/client.ts +22 -3
- package/src/client/comments.ts +205 -0
- package/src/client/community.ts +40 -0
- package/src/client/device-authorization.ts +4 -20
- package/src/client/discovery.ts +39 -11
- package/src/client/documents.ts +160 -0
- package/src/client/files/archive.ts +60 -0
- package/src/client/files/checksum.ts +7 -0
- package/src/client/files/download.ts +122 -0
- package/src/client/files/images.ts +89 -0
- package/src/client/files/index.ts +15 -0
- package/src/client/files/objects.ts +173 -0
- package/src/client/files/save.ts +79 -0
- package/src/client/index.ts +4 -0
- package/src/client/portal/account.ts +73 -3
- package/src/client/portal/administration.ts +52 -5
- package/src/client/portal/request.ts +6 -2
- package/src/client/response.ts +21 -0
- package/src/client/schema.ts +8 -0
- package/src/client/services.ts +23 -18
- package/src/client/sharing.ts +262 -0
- package/src/client/tour.ts +44 -0
- package/src/client/versions.ts +110 -0
- package/src/contract/account.ts +111 -11
- package/src/contract/admin/index.ts +48 -3
- package/src/contract/billing.ts +235 -0
- package/src/contract/collaboration.ts +5 -0
- package/src/contract/comments.ts +223 -0
- package/src/contract/community.ts +60 -0
- package/src/contract/discovery.ts +94 -5
- package/src/contract/entitlements.ts +10 -0
- package/src/contract/index.ts +64 -5
- package/src/contract/links.ts +62 -4
- package/src/contract/locale.ts +27 -0
- package/src/contract/portal.ts +12 -1
- package/src/contract/relay.ts +3 -1
- package/src/contract/routes.ts +10 -0
- package/src/contract/services.ts +62 -20
- package/src/contract/workspaces.ts +5 -0
- package/src/email/i18n.ts +174 -0
- package/src/email/index.ts +13 -2
- package/src/email/locales/ar.json +169 -0
- package/src/email/locales/de.json +169 -0
- package/src/email/locales/es.json +169 -0
- package/src/email/locales/fr.json +169 -0
- package/src/email/locales/it.json +169 -0
- package/src/email/locales/ja.json +169 -0
- package/src/email/locales/pl.json +169 -0
- package/src/email/locales/pt-br.json +169 -0
- package/src/email/locales/ru.json +169 -0
- package/src/email/locales/zh-cn.json +169 -0
- package/src/email/messages.ts +235 -0
- package/src/email/render.ts +160 -276
- package/src/email/samples.ts +142 -0
- package/src/email/schema.ts +98 -8
- package/src/email/templates/BrandEmail.vue +56 -0
- package/src/email/templates/CommentNotification.vue +39 -0
- package/src/email/templates/DocumentBlocked.vue +45 -0
- package/src/email/templates/DocumentInvitation.vue +24 -0
- package/src/email/templates/DocumentReport.vue +32 -0
- package/src/email/templates/DocumentReportDecided.vue +36 -0
- package/src/email/templates/DocumentReportReceived.vue +18 -0
- package/src/email/templates/DocumentRestored.vue +24 -0
- package/src/email/templates/EmailChangeRequested.vue +24 -0
- package/src/email/templates/EmailRoot.vue +19 -0
- package/src/email/templates/EmailText.vue +9 -0
- package/src/email/templates/EmailVerification.vue +38 -0
- package/src/email/templates/EnrollmentInvitation.vue +53 -0
- package/src/email/templates/EnrollmentNotification.vue +24 -0
- package/src/email/templates/EnrollmentUpdate.vue +52 -0
- package/src/email/templates/NewSignIn.vue +37 -0
- package/src/email/templates/PasswordChanged.vue +22 -0
- package/src/email/templates/PasswordReset.vue +23 -0
- package/src/email/templates/StorageLimitReached.vue +28 -0
- package/src/email/templates/TwoStepChanged.vue +47 -0
- package/src/email/templates/WaitlistConfirmation.vue +29 -0
- package/src/email/templates/WorkspaceInvitation.vue +28 -0
- package/src/email/templates/brand.ts +15 -61
- package/src/email/templates/localization.ts +17 -0
- package/src/errors/index.ts +6 -0
- package/src/{server/errors → errors}/posthog.ts +28 -4
- package/src/global.d.ts +7 -0
- package/src/runtime/cloudflare/email.ts +2 -0
- package/src/runtime/cloudflare/relay/index.ts +28 -7
- package/src/runtime/cloudflare/tsconfig.json +2 -1
- package/src/runtime/cloudflare/worker.ts +14 -1
- package/src/runtime/cloudflare/xml.ts +12 -0
- package/src/runtime/node/admin.ts +51 -47
- package/src/runtime/node/cleanup.ts +5 -1
- package/src/runtime/node/email/runtime.ts +1 -0
- package/src/runtime/node/email/transport.ts +14 -10
- package/src/runtime/node/main.ts +1 -1
- package/src/runtime/node/server.ts +20 -4
- package/src/runtime/node/services/main.ts +1 -1
- package/src/runtime/posthog/errors.ts +5 -2
- package/src/runtime/s3/objects.ts +17 -0
- package/src/runtime/site/community.ts +101 -0
- package/src/runtime/site/server.ts +17 -1
- package/src/server/account/actions.ts +3 -1
- package/src/server/account/deletion.ts +40 -4
- package/src/server/account/routes.ts +305 -253
- package/src/server/account/tokens.ts +57 -0
- package/src/server/api/router.ts +44 -6
- package/src/server/app/checks.ts +89 -0
- package/src/server/app/cors.ts +44 -0
- package/src/server/app/editors.ts +20 -0
- package/src/server/app/index.ts +128 -0
- package/src/server/app/indexing.ts +40 -0
- package/src/server/app/limiters.ts +53 -0
- package/src/server/app/routes.ts +123 -0
- package/src/server/app/services.ts +219 -0
- package/src/server/auth/access-control.ts +13 -8
- package/src/server/auth/access-tokens.ts +62 -0
- package/src/server/auth/account.ts +13 -12
- package/src/server/auth/activity.ts +7 -2
- package/src/server/auth/adapter.ts +36 -3
- package/src/server/auth/email.ts +33 -18
- package/src/server/auth/endpoints.ts +4 -0
- package/src/server/auth/enrollment.ts +116 -0
- package/src/server/auth/factory.ts +165 -189
- package/src/server/auth/index.ts +1 -1
- package/src/server/auth/logger.ts +23 -0
- package/src/server/auth/methods.ts +162 -0
- package/src/server/auth/mfa-assurance.ts +190 -2
- package/src/server/auth/passwords.ts +43 -0
- package/src/server/auth/rate-limit.ts +31 -0
- package/src/server/auth/runtime.ts +19 -5
- package/src/server/auth/session.ts +2 -0
- package/src/server/auth/social-providers.ts +70 -24
- package/src/server/billing/index.ts +8 -0
- package/src/server/billing/notify.ts +55 -0
- package/src/server/billing/routes.ts +27 -0
- package/src/server/billing/seats.ts +17 -0
- package/src/server/billing/tokens.ts +37 -0
- package/src/server/cleanup/configured.ts +16 -3
- package/src/server/cleanup/documents.ts +5 -2
- package/src/server/cleanup/revisions.ts +6 -3
- package/src/server/cleanup/uploads.ts +2 -1
- package/src/server/cleanup/worker.ts +10 -1
- package/src/server/collaboration/relay/connection.ts +7 -2
- package/src/server/collaboration/relay/hub.ts +80 -166
- package/src/server/collaboration/relay/room.ts +154 -0
- package/src/server/collaboration/routes.ts +8 -5
- package/src/server/collaboration/service.ts +21 -2
- package/src/server/comments/index.ts +9 -0
- package/src/server/comments/notify.ts +277 -0
- package/src/server/comments/routes.ts +352 -0
- package/src/server/comments/rows.ts +249 -0
- package/src/server/comments/service.ts +570 -0
- package/src/server/community/index.ts +2 -0
- package/src/server/community/routes.ts +93 -0
- package/src/server/community/service.ts +134 -0
- package/src/server/config/deployment.ts +35 -10
- package/src/server/config/index.ts +2 -2
- package/src/server/config/public.ts +25 -6
- package/src/server/config/schema.ts +53 -293
- package/src/server/config/toml/schema.ts +330 -0
- package/src/server/db/index.ts +3 -1
- package/src/server/db/migrate.ts +33 -1
- package/src/server/db/migrations/009_access_tokens.ts +47 -0
- package/src/server/db/migrations/010_storage_limit_notices.ts +50 -0
- package/src/server/db/migrations/011_account_ids.ts +30 -0
- package/src/server/db/migrations/012_email_locales.ts +34 -0
- package/src/server/db/migrations/013_document_block_emails.ts +40 -0
- package/src/server/db/migrations/014_report_replies.ts +28 -0
- package/src/server/db/migrations/015_comments.ts +57 -0
- package/src/server/db/migrations/016_comment_notifications.ts +76 -0
- package/src/server/db/migrations/017_invitation_emails.ts +19 -0
- package/src/server/db/migrations/018_enrollment_source.ts +17 -0
- package/src/server/db/migrations/schema.ts +26 -1
- package/src/server/db/tables.ts +122 -3
- package/src/server/db/users.ts +22 -0
- package/src/server/documents/access.ts +17 -0
- package/src/server/documents/images.ts +6 -1
- package/src/server/documents/index.ts +1 -1
- package/src/server/documents/limits.ts +7 -1
- package/src/server/documents/routes.ts +12 -12
- package/src/server/documents/service.ts +31 -407
- package/src/server/documents/summary.ts +15 -0
- package/src/server/documents/uploads.ts +450 -0
- package/src/server/documents/versions/routes.ts +7 -8
- package/src/server/documents/versions/service.ts +86 -26
- package/src/server/email/invitations.ts +1 -0
- package/src/server/email/service.ts +39 -6
- package/src/server/email/types.ts +13 -0
- package/src/server/errors/index.ts +49 -12
- package/src/server/index.ts +27 -6
- package/src/server/internal/routes.ts +8 -2
- package/src/server/internal/service.ts +10 -0
- package/src/server/invitations/budget.ts +3 -1
- package/src/server/invitations/index.ts +1 -0
- package/src/server/invitations/links.ts +6 -0
- package/src/server/invitations/types.ts +5 -1
- package/src/server/objects/types.ts +5 -0
- package/src/server/pictures/service.ts +3 -1
- package/src/server/policy/configured.ts +9 -3
- package/src/server/policy/database.ts +13 -2
- package/src/server/policy/policy.ts +39 -12
- package/src/server/policy/service.ts +71 -52
- package/src/server/policy/storage.ts +33 -0
- package/src/server/policy/workspace.ts +5 -2
- package/src/server/quota/index.ts +6 -0
- package/src/server/quota/notices.ts +121 -0
- package/src/server/quota/storage.ts +5 -0
- package/src/server/rate-limit/middleware.ts +4 -0
- package/src/server/reports/index.ts +1 -0
- package/src/server/reports/replies.ts +55 -0
- package/src/server/reports/routes.ts +5 -3
- package/src/server/reports/service.ts +27 -3
- package/src/server/services/routes.ts +2 -2
- package/src/server/sharing/capabilities/service.ts +3 -4
- package/src/server/sharing/document-routes.ts +3 -3
- package/src/server/sharing/invitations/service.ts +17 -8
- package/src/server/sharing/routes.ts +15 -15
- package/src/server/validation.ts +35 -24
- package/src/server/workspaces/members.ts +57 -31
- package/src/server/workspaces/repository.ts +23 -12
- package/src/server/workspaces/routes.ts +8 -8
- package/src/services/app.ts +31 -22
- package/src/services/config.ts +48 -8
- package/src/services/metering.ts +15 -27
- package/src/services/usage.ts +6 -14
- package/src/email/templates/document-invitation.ts +0 -35
- package/src/email/templates/enrollment.ts +0 -27
- package/src/email/templates/layout.ts +0 -18
- package/src/server/app.ts +0 -453
package/dist/index.d.ts
CHANGED
|
@@ -5,9 +5,10 @@ import { BlankEnv, BlankInput, ToSchema } from "hono/types";
|
|
|
5
5
|
//#region src/contract/account.d.ts
|
|
6
6
|
/**
|
|
7
7
|
* Where an account stands: it may use the server, waits for an administrator, was refused or had
|
|
8
|
-
* its access taken back,
|
|
8
|
+
* its access taken back, has to prove its second step in this session, as after signing in through
|
|
9
|
+
* a linked account such as Google, or has to accept the server's current terms first.
|
|
9
10
|
*/
|
|
10
|
-
declare const cloudAccountStateSchema: v.PicklistSchema<["active", "pending", "rejected", "revoked", "terms"], undefined>;
|
|
11
|
+
declare const cloudAccountStateSchema: v.PicklistSchema<["active", "pending", "rejected", "revoked", "two-step", "terms"], undefined>;
|
|
11
12
|
declare const cloudIdentitySchema: v.ObjectSchema<{
|
|
12
13
|
readonly userId: v.StringSchema<undefined>;
|
|
13
14
|
readonly email: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.EmailAction<string, undefined>]>;
|
|
@@ -25,34 +26,57 @@ declare const cloudAccountStatusResponseSchema: v.ObjectSchema<{
|
|
|
25
26
|
readonly image: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, undefined>;
|
|
26
27
|
readonly deploymentRole: v.OptionalSchema<v.PicklistSchema<["user", "admin"], undefined>, undefined>;
|
|
27
28
|
}, undefined>;
|
|
28
|
-
readonly state: v.PicklistSchema<["active", "pending", "rejected", "revoked", "terms"], undefined>;
|
|
29
|
+
readonly state: v.PicklistSchema<["active", "pending", "rejected", "revoked", "two-step", "terms"], undefined>;
|
|
29
30
|
}, undefined>;
|
|
30
31
|
/** Accepting the server's terms: the version the person read, which must be the current one. */
|
|
31
32
|
declare const cloudTermsAcceptanceSchema: v.ObjectSchema<{
|
|
32
33
|
readonly version: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
33
34
|
}, undefined>;
|
|
34
|
-
|
|
35
|
+
/**
|
|
36
|
+
* The providers a person can sign in with besides a password, which this editor has buttons for,
|
|
37
|
+
* in the order it shows them. Every list of providers in Cloud derives from this one.
|
|
38
|
+
*/
|
|
39
|
+
declare const CLOUD_SOCIAL_PROVIDERS: readonly ["google", "apple", "github"];
|
|
40
|
+
declare const cloudSocialProviderSchema: v.PicklistSchema<readonly ["google", "apple", "github"], undefined>;
|
|
41
|
+
type CloudSocialProvider = v.InferOutput<typeof cloudSocialProviderSchema>;
|
|
42
|
+
/** Each provider's name, as its owner writes it in every language. */
|
|
43
|
+
declare const CLOUD_SOCIAL_PROVIDER_NAMES: Record<CloudSocialProvider, string>;
|
|
44
|
+
declare const cloudAuthenticationProviderSchema: v.PicklistSchema<["credential", "google", "apple", "github"], undefined>;
|
|
35
45
|
declare const cloudAuthenticationMethodSchema: v.ObjectSchema<{
|
|
36
46
|
readonly id: v.StringSchema<undefined>;
|
|
37
|
-
readonly provider: v.PicklistSchema<["credential", "google", "apple"], undefined>;
|
|
47
|
+
readonly provider: v.PicklistSchema<["credential", "google", "apple", "github"], undefined>;
|
|
38
48
|
readonly createdAt: v.StringSchema<undefined>;
|
|
39
49
|
readonly canUnlink: v.BooleanSchema<undefined>;
|
|
40
50
|
}, undefined>;
|
|
51
|
+
/** Whether this editor knows `provider`, so a newer server's other providers can be left out. */
|
|
52
|
+
declare function isKnownSocialProvider(provider: string): provider is CloudSocialProvider;
|
|
53
|
+
/** Whether `provider` is a way to sign in this editor knows: a password or a known provider. */
|
|
54
|
+
declare function isKnownAuthenticationProvider(provider: string): provider is CloudAuthenticationProvider;
|
|
55
|
+
/**
|
|
56
|
+
* A newer server may list a provider this editor has no words or button for: those entries are
|
|
57
|
+
* left out rather than failing the whole response, and anything else malformed still fails.
|
|
58
|
+
*/
|
|
41
59
|
declare const cloudAuthenticationMethodsResponseSchema: v.ObjectSchema<{
|
|
42
|
-
readonly methods: v.ArraySchema<v.
|
|
60
|
+
readonly methods: v.SchemaWithPipe<readonly [v.ArraySchema<v.LooseObjectSchema<{
|
|
61
|
+
readonly provider: v.StringSchema<undefined>;
|
|
62
|
+
}, undefined>, undefined>, v.FilterItemsAction<({
|
|
63
|
+
provider: string;
|
|
64
|
+
} & {
|
|
65
|
+
[key: string]: unknown;
|
|
66
|
+
})[]>, v.ArraySchema<v.ObjectSchema<{
|
|
43
67
|
readonly id: v.StringSchema<undefined>;
|
|
44
|
-
readonly provider: v.PicklistSchema<["credential", "google", "apple"], undefined>;
|
|
68
|
+
readonly provider: v.PicklistSchema<["credential", "google", "apple", "github"], undefined>;
|
|
45
69
|
readonly createdAt: v.StringSchema<undefined>;
|
|
46
70
|
readonly canUnlink: v.BooleanSchema<undefined>;
|
|
47
|
-
}, undefined>, undefined>;
|
|
48
|
-
readonly availableSocialProviders: v.ArraySchema<v.PicklistSchema<["google", "apple"], undefined>, undefined>;
|
|
71
|
+
}, undefined>, undefined>]>;
|
|
72
|
+
readonly availableSocialProviders: v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.FilterItemsAction<string[]>, v.ArraySchema<v.PicklistSchema<readonly ["google", "apple", "github"], undefined>, undefined>]>;
|
|
49
73
|
}, undefined>;
|
|
50
74
|
declare const cloudPasswordChangeSchema: v.ObjectSchema<{
|
|
51
75
|
readonly currentPassword: v.StringSchema<undefined>;
|
|
52
76
|
readonly newPassword: v.StringSchema<undefined>;
|
|
53
77
|
}, undefined>;
|
|
54
78
|
declare const cloudSocialLinkSchema: v.ObjectSchema<{
|
|
55
|
-
readonly provider: v.PicklistSchema<["google", "apple"], undefined>;
|
|
79
|
+
readonly provider: v.PicklistSchema<readonly ["google", "apple", "github"], undefined>;
|
|
56
80
|
readonly callbackURL: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
57
81
|
}, undefined>;
|
|
58
82
|
declare const cloudSocialLinkResponseSchema: v.ObjectSchema<{
|
|
@@ -61,10 +85,10 @@ declare const cloudSocialLinkResponseSchema: v.ObjectSchema<{
|
|
|
61
85
|
declare const cloudUnlinkAuthenticationMethodSchema: v.ObjectSchema<{
|
|
62
86
|
readonly methodId: v.StringSchema<undefined>;
|
|
63
87
|
}, undefined>;
|
|
64
|
-
declare const accountSecurityErrorCodeSchema: v.PicklistSchema<["current_password_invalid", "password_too_short", "password_too_long", "last_authentication_method", "session_not_fresh", "authentication_method_failed", "email_unchanged", "email_change_unavailable", "current_session", "picture_invalid", "account_sole_admin", "last_admin_required", "terms_changed"], undefined>;
|
|
88
|
+
declare const accountSecurityErrorCodeSchema: v.PicklistSchema<["current_password_invalid", "password_too_short", "password_too_long", "last_authentication_method", "session_not_fresh", "authentication_method_failed", "code_invalid", "email_unchanged", "email_change_unavailable", "current_session", "picture_invalid", "account_sole_admin", "last_admin_required", "terms_changed"], undefined>;
|
|
65
89
|
declare const accountSecurityErrorResponseSchema: v.ObjectSchema<{
|
|
66
90
|
readonly error: v.ObjectSchema<{
|
|
67
|
-
readonly code: v.PicklistSchema<["current_password_invalid", "password_too_short", "password_too_long", "last_authentication_method", "session_not_fresh", "authentication_method_failed", "email_unchanged", "email_change_unavailable", "current_session", "picture_invalid", "account_sole_admin", "last_admin_required", "terms_changed"], undefined>;
|
|
91
|
+
readonly code: v.PicklistSchema<["current_password_invalid", "password_too_short", "password_too_long", "last_authentication_method", "session_not_fresh", "authentication_method_failed", "code_invalid", "email_unchanged", "email_change_unavailable", "current_session", "picture_invalid", "account_sole_admin", "last_admin_required", "terms_changed"], undefined>;
|
|
68
92
|
}, undefined>;
|
|
69
93
|
}, undefined>;
|
|
70
94
|
declare const cloudMFAStatusSchema: v.ObjectSchema<{
|
|
@@ -118,6 +142,61 @@ declare const cloudPasskeysResponseSchema: v.ObjectSchema<{
|
|
|
118
142
|
declare const cloudPasskeyDeleteSchema: v.ObjectSchema<{
|
|
119
143
|
readonly id: v.StringSchema<undefined>;
|
|
120
144
|
}, undefined>;
|
|
145
|
+
/**
|
|
146
|
+
* Personal access tokens: an account's own credentials for scripts and CI, sent as
|
|
147
|
+
* `Authorization: Bearer <token>`. A token acts as its account on the document API only; it never
|
|
148
|
+
* changes how the account is reached, makes other tokens, or reaches administration.
|
|
149
|
+
*/
|
|
150
|
+
declare const CLOUD_ACCESS_TOKEN_PREFIX = "opc_";
|
|
151
|
+
declare const CLOUD_ACCESS_TOKEN_NAME_MAX_LENGTH = 64;
|
|
152
|
+
declare const CLOUD_ACCESS_TOKEN_MAX_DAYS = 365;
|
|
153
|
+
declare const cloudAccessTokenSchema: v.ObjectSchema<{
|
|
154
|
+
readonly id: v.StringSchema<undefined>;
|
|
155
|
+
readonly name: v.StringSchema<undefined>;
|
|
156
|
+
/** The token's first characters, prefix included, to tell tokens apart; never the whole token. */
|
|
157
|
+
readonly start: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
158
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
159
|
+
readonly expiresAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
160
|
+
readonly lastUsedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
161
|
+
}, undefined>;
|
|
162
|
+
declare const cloudAccessTokensResponseSchema: v.ObjectSchema<{
|
|
163
|
+
readonly tokens: v.ArraySchema<v.ObjectSchema<{
|
|
164
|
+
readonly id: v.StringSchema<undefined>;
|
|
165
|
+
readonly name: v.StringSchema<undefined>;
|
|
166
|
+
/** The token's first characters, prefix included, to tell tokens apart; never the whole token. */
|
|
167
|
+
readonly start: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
168
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
169
|
+
readonly expiresAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
170
|
+
readonly lastUsedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
171
|
+
}, undefined>, undefined>;
|
|
172
|
+
}, undefined>;
|
|
173
|
+
declare const cloudAccessTokenCreateSchema: v.ObjectSchema<{
|
|
174
|
+
readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 64, undefined>]>;
|
|
175
|
+
readonly expiresInDays: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>, v.MaxValueAction<number, 365, undefined>]>;
|
|
176
|
+
}, undefined>;
|
|
177
|
+
/** A new token, the only time the whole of it is shown. */
|
|
178
|
+
declare const cloudAccessTokenCreatedResponseSchema: v.ObjectSchema<{
|
|
179
|
+
readonly token: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.StartsWithAction<string, "opc_", undefined>]>;
|
|
180
|
+
readonly accessToken: v.ObjectSchema<{
|
|
181
|
+
readonly id: v.StringSchema<undefined>;
|
|
182
|
+
readonly name: v.StringSchema<undefined>;
|
|
183
|
+
/** The token's first characters, prefix included, to tell tokens apart; never the whole token. */
|
|
184
|
+
readonly start: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
185
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
186
|
+
readonly expiresAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
187
|
+
readonly lastUsedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
188
|
+
}, undefined>;
|
|
189
|
+
}, undefined>;
|
|
190
|
+
declare const cloudAccessTokenRevokeSchema: v.ObjectSchema<{
|
|
191
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
192
|
+
}, undefined>;
|
|
193
|
+
declare function parseCloudAccessTokenCreate(input: unknown): {
|
|
194
|
+
name: string;
|
|
195
|
+
expiresInDays: number;
|
|
196
|
+
};
|
|
197
|
+
declare function parseCloudAccessTokenRevoke(input: unknown): {
|
|
198
|
+
id: string;
|
|
199
|
+
};
|
|
121
200
|
declare function parseCloudTermsAcceptance(input: unknown): {
|
|
122
201
|
version: string;
|
|
123
202
|
};
|
|
@@ -135,7 +214,7 @@ declare function parseCloudPasswordChange(input: unknown): {
|
|
|
135
214
|
newPassword: string;
|
|
136
215
|
};
|
|
137
216
|
declare function parseCloudSocialLink(input: unknown): {
|
|
138
|
-
provider: "google" | "apple";
|
|
217
|
+
provider: "google" | "apple" | "github";
|
|
139
218
|
callbackURL: string;
|
|
140
219
|
};
|
|
141
220
|
declare function parseCloudUnlinkAuthenticationMethod(input: unknown): {
|
|
@@ -194,13 +273,12 @@ declare const cloudEmailChangeSchema: v.ObjectSchema<{
|
|
|
194
273
|
readonly newEmail: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.ToLowerCaseAction, v.EmailAction<string, undefined>]>;
|
|
195
274
|
readonly callbackURL: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
196
275
|
}, undefined>;
|
|
197
|
-
|
|
198
|
-
declare const cloudSignInMethodSchema: v.PicklistSchema<["password", "google", "apple", "passkey", "two-step", "email-link", "desktop", "other"], undefined>;
|
|
276
|
+
declare const cloudSignInMethodSchema: v.PicklistSchema<readonly ["password", "google", "apple", "github", "passkey", "two-step", "email-link", "desktop", "other"], undefined>;
|
|
199
277
|
declare const cloudAccountSessionSchema: v.ObjectSchema<{
|
|
200
278
|
readonly id: v.StringSchema<undefined>;
|
|
201
279
|
/** The session this request was made with. */
|
|
202
280
|
readonly current: v.BooleanSchema<undefined>;
|
|
203
|
-
readonly method: v.NullableSchema<v.
|
|
281
|
+
readonly method: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, "two-step" | "google" | "apple" | "github" | "password" | "passkey" | "email-link" | "desktop" | "other">]>, undefined>;
|
|
204
282
|
readonly ipAddress: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
205
283
|
/** The browser and system the server read from the client's user agent, such as `Chrome 141`. */
|
|
206
284
|
readonly browser: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
@@ -214,7 +292,7 @@ declare const cloudAccountSessionsResponseSchema: v.ObjectSchema<{
|
|
|
214
292
|
readonly id: v.StringSchema<undefined>;
|
|
215
293
|
/** The session this request was made with. */
|
|
216
294
|
readonly current: v.BooleanSchema<undefined>;
|
|
217
|
-
readonly method: v.NullableSchema<v.
|
|
295
|
+
readonly method: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, "two-step" | "google" | "apple" | "github" | "password" | "passkey" | "email-link" | "desktop" | "other">]>, undefined>;
|
|
218
296
|
readonly ipAddress: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
219
297
|
/** The browser and system the server read from the client's user agent, such as `Chrome 141`. */
|
|
220
298
|
readonly browser: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
@@ -229,7 +307,7 @@ declare const cloudSessionRevokeSchema: v.ObjectSchema<{
|
|
|
229
307
|
}, undefined>;
|
|
230
308
|
declare const cloudSignInSchema: v.ObjectSchema<{
|
|
231
309
|
readonly id: v.StringSchema<undefined>;
|
|
232
|
-
readonly method: v.
|
|
310
|
+
readonly method: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, "two-step" | "google" | "apple" | "github" | "password" | "passkey" | "email-link" | "desktop" | "other">]>;
|
|
233
311
|
readonly ipAddress: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
234
312
|
/** The browser and system the server read from the client's user agent, such as `Chrome 141`. */
|
|
235
313
|
readonly browser: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
@@ -239,7 +317,7 @@ declare const cloudSignInSchema: v.ObjectSchema<{
|
|
|
239
317
|
declare const cloudSignInsResponseSchema: v.ObjectSchema<{
|
|
240
318
|
readonly signIns: v.ArraySchema<v.ObjectSchema<{
|
|
241
319
|
readonly id: v.StringSchema<undefined>;
|
|
242
|
-
readonly method: v.
|
|
320
|
+
readonly method: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, "two-step" | "google" | "apple" | "github" | "password" | "passkey" | "email-link" | "desktop" | "other">]>;
|
|
243
321
|
readonly ipAddress: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
244
322
|
/** The browser and system the server read from the client's user agent, such as `Chrome 141`. */
|
|
245
323
|
readonly browser: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
@@ -334,11 +412,31 @@ type CloudAuthenticationMethod = v.InferOutput<typeof cloudAuthenticationMethodS
|
|
|
334
412
|
type CloudAuthenticationMethods = v.InferOutput<typeof cloudAuthenticationMethodsResponseSchema>;
|
|
335
413
|
type CloudAccountStatus = v.InferOutput<typeof cloudAccountStatusResponseSchema>;
|
|
336
414
|
type CloudProfile = v.InferOutput<typeof cloudProfileSchema>;
|
|
415
|
+
type CloudAccessToken = v.InferOutput<typeof cloudAccessTokenSchema>;
|
|
416
|
+
type CloudAccessTokenCreate = v.InferOutput<typeof cloudAccessTokenCreateSchema>;
|
|
337
417
|
type CloudSignInMethod = v.InferOutput<typeof cloudSignInMethodSchema>;
|
|
338
418
|
type CloudAccountSession = v.InferOutput<typeof cloudAccountSessionSchema>;
|
|
339
419
|
type CloudSignIn = v.InferOutput<typeof cloudSignInSchema>;
|
|
340
420
|
type CloudAccountDeletion = v.InferOutput<typeof cloudAccountDeletionSchema>;
|
|
341
421
|
//#endregion
|
|
422
|
+
//#region src/contract/locale.d.ts
|
|
423
|
+
/**
|
|
424
|
+
* A language as the app names it, which the server writes email in when it has that language, or
|
|
425
|
+
* the nearest it has, and otherwise in English.
|
|
426
|
+
*/
|
|
427
|
+
declare const cloudLanguageTagSchema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 35, undefined>, v.CheckAction<string, "Not a language tag">]>;
|
|
428
|
+
/** The language an account's email is written in, as the app last said it uses. */
|
|
429
|
+
declare const cloudLocaleUpdateSchema: v.ObjectSchema<{
|
|
430
|
+
readonly locale: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 35, undefined>, v.CheckAction<string, "Not a language tag">]>;
|
|
431
|
+
}, undefined>;
|
|
432
|
+
declare function parseCloudLocaleUpdate(input: unknown): {
|
|
433
|
+
locale: string;
|
|
434
|
+
};
|
|
435
|
+
//#endregion
|
|
436
|
+
//#region src/contract/routes.d.ts
|
|
437
|
+
/** A route's input, and the JSON it answers with a 200, as a contract's typed Hono schema names it. */
|
|
438
|
+
type JSONRoute<Method extends string, Path extends string, Input extends BlankInput, Output> = ToSchema<Method, Path, Input, TypedResponse<Output, 200, 'json'>>;
|
|
439
|
+
//#endregion
|
|
342
440
|
//#region src/contract/services.d.ts
|
|
343
441
|
/**
|
|
344
442
|
* The contract between editors, Cloud, and the services Cloud advertises: AI models today, and
|
|
@@ -369,10 +467,6 @@ declare const cloudServicesDiscoverySchema: v.ObjectSchema<{
|
|
|
369
467
|
readonly contractVersion: v.LiteralSchema<"1", undefined>;
|
|
370
468
|
}, undefined>;
|
|
371
469
|
type CloudServicesDiscovery = v.InferOutput<typeof cloudServicesDiscoverySchema>;
|
|
372
|
-
declare const cloudBillingDiscoverySchema: v.ObjectSchema<{
|
|
373
|
-
readonly portalURL: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
374
|
-
}, undefined>;
|
|
375
|
-
type CloudBillingDiscovery = v.InferOutput<typeof cloudBillingDiscoverySchema>;
|
|
376
470
|
declare const createServicesTokenSchema: v.ObjectSchema<{
|
|
377
471
|
readonly workspaceId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
378
472
|
}, undefined>;
|
|
@@ -391,10 +485,9 @@ declare const servicesTokenClaimsSchema: v.ObjectSchema<{
|
|
|
391
485
|
readonly workspaceId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
392
486
|
/**
|
|
393
487
|
* The account whose credits the request spends: the workspace's owner, whose allowance every
|
|
394
|
-
* workspace they own shares.
|
|
395
|
-
* a relay takes as the workspace's own allowance, as such a Cloud meant.
|
|
488
|
+
* workspace they own shares.
|
|
396
489
|
*/
|
|
397
|
-
readonly accountId: v.
|
|
490
|
+
readonly accountId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
398
491
|
/** Credits the owner's plan grants each month; `null` when Cloud sets no allowance. */
|
|
399
492
|
readonly monthlyCreditAllowance: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>;
|
|
400
493
|
readonly iat: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>]>;
|
|
@@ -420,7 +513,20 @@ declare const searchPricingSchema: v.ObjectSchema<{
|
|
|
420
513
|
readonly creditsPerRequest: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
421
514
|
}, undefined>;
|
|
422
515
|
type SearchPricing = v.InferOutput<typeof searchPricingSchema>;
|
|
423
|
-
|
|
516
|
+
/**
|
|
517
|
+
* The model the service recommends for each of the editor's roles: Design runs the chat, Review
|
|
518
|
+
* critiques designs, Fast does quick tasks such as naming conversations, and Vision reads images.
|
|
519
|
+
* An editor signed in to the service with no model of its own yet sets itself up with them, so
|
|
520
|
+
* nobody has to choose one. Vision `null` recommends none, and the editor leaves it unassigned.
|
|
521
|
+
*/
|
|
522
|
+
declare const roleModelsSchema: v.ObjectSchema<{
|
|
523
|
+
readonly design: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
524
|
+
readonly review: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
525
|
+
readonly fast: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
526
|
+
readonly vision: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>, undefined>;
|
|
527
|
+
}, undefined>;
|
|
528
|
+
type RoleModels = v.InferOutput<typeof roleModelsSchema>;
|
|
529
|
+
declare const serviceCatalogSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
424
530
|
readonly models: v.ArraySchema<v.ObjectSchema<{
|
|
425
531
|
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
426
532
|
readonly label: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
@@ -435,10 +541,44 @@ declare const serviceCatalogSchema: v.ObjectSchema<{
|
|
|
435
541
|
}, undefined>;
|
|
436
542
|
}, undefined>, undefined>;
|
|
437
543
|
readonly defaultModelID: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
544
|
+
/**
|
|
545
|
+
* Absent from a service that predates it, or whose default model can't run the chat. Editors
|
|
546
|
+
* then use `defaultModelID` for every role, except Vision when that model reads no images,
|
|
547
|
+
* and set nothing up when it calls no tools.
|
|
548
|
+
*/
|
|
549
|
+
readonly roleModels: v.OptionalSchema<v.ObjectSchema<{
|
|
550
|
+
readonly design: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
551
|
+
readonly review: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
552
|
+
readonly fast: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
553
|
+
readonly vision: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>, undefined>;
|
|
554
|
+
}, undefined>, undefined>;
|
|
438
555
|
readonly search: v.OptionalSchema<v.ObjectSchema<{
|
|
439
556
|
readonly creditsPerRequest: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
440
557
|
}, undefined>, undefined>;
|
|
441
|
-
}, undefined
|
|
558
|
+
}, undefined>, v.CheckAction<{
|
|
559
|
+
models: {
|
|
560
|
+
id: string;
|
|
561
|
+
label: string;
|
|
562
|
+
creditsPerMillionInputTokens: number;
|
|
563
|
+
creditsPerMillionOutputTokens: number;
|
|
564
|
+
contextTokens: number;
|
|
565
|
+
capabilities: {
|
|
566
|
+
reasoning: boolean;
|
|
567
|
+
vision: boolean;
|
|
568
|
+
tools: boolean;
|
|
569
|
+
};
|
|
570
|
+
}[];
|
|
571
|
+
defaultModelID: string;
|
|
572
|
+
roleModels?: {
|
|
573
|
+
design: string;
|
|
574
|
+
review: string;
|
|
575
|
+
fast: string;
|
|
576
|
+
vision: string | null;
|
|
577
|
+
} | undefined;
|
|
578
|
+
search?: {
|
|
579
|
+
creditsPerRequest: number;
|
|
580
|
+
} | undefined;
|
|
581
|
+
}, "A recommended model is not in the catalog or cannot do its role">]>;
|
|
442
582
|
type ServiceCatalog = v.InferOutput<typeof serviceCatalogSchema>;
|
|
443
583
|
declare const creditBucketSchema: v.ObjectSchema<{
|
|
444
584
|
readonly kind: v.PicklistSchema<["allowance", "purchased", "grant"], undefined>;
|
|
@@ -538,8 +678,6 @@ declare const SERVICE_ERROR_STATUS: {
|
|
|
538
678
|
readonly capability_unavailable: 404;
|
|
539
679
|
readonly rate_limited: 429;
|
|
540
680
|
};
|
|
541
|
-
/** A route's input, and the JSON it answers with a 200. */
|
|
542
|
-
type JSONRoute<Method extends string, Path extends string, Input extends BlankInput, Output> = ToSchema<Method, Path, Input, TypedResponse<Output, 200, 'json'>>;
|
|
543
681
|
/**
|
|
544
682
|
* Every route a service answers besides chat completions, which OpenAI-compatible clients call
|
|
545
683
|
* themselves. Editors build a typed client from it with Hono's `hc`; a service's own app must
|
|
@@ -551,12 +689,262 @@ type CloudServicesSchema = JSONRoute<'get', typeof CLOUD_SERVICES_API_PATHS.cata
|
|
|
551
689
|
json: SearchRequestInput;
|
|
552
690
|
}, SearchResponse>;
|
|
553
691
|
type CloudServicesAPI = Hono<BlankEnv, CloudServicesSchema>;
|
|
692
|
+
/**
|
|
693
|
+
* Whether a bearer token may travel to `url`: over HTTPS, or in the clear only to a loopback
|
|
694
|
+
* address, for development. Only literal addresses count, since a name such as `localhost` is
|
|
695
|
+
* whatever the resolver answers. Services and billing tokens act as the account until they expire.
|
|
696
|
+
*/
|
|
697
|
+
declare function sendsTokenSafely(url: string | URL): boolean;
|
|
698
|
+
//#endregion
|
|
699
|
+
//#region src/contract/billing.d.ts
|
|
700
|
+
/**
|
|
701
|
+
* The contract between Cloud, its editors, and the billing service a deployment advertises: what
|
|
702
|
+
* plans and credit packs it sells, and where an account buys them or manages what it has. Cloud
|
|
703
|
+
* only advertises the service and signs short-lived tokens for an account; the service talks to
|
|
704
|
+
* the payment provider, and sets the account's entitlements and credits as it is paid.
|
|
705
|
+
*/
|
|
706
|
+
declare const CLOUD_BILLING_CONTRACT_VERSION: "1";
|
|
707
|
+
/**
|
|
708
|
+
* The `aud` of the tokens Cloud signs for its billing service, with the services' signing key,
|
|
709
|
+
* whose public keys it publishes at `CLOUD_SERVICES_JWKS_PATH`.
|
|
710
|
+
*/
|
|
711
|
+
declare const CLOUD_BILLING_TOKEN_AUDIENCE: "openpencil-billing";
|
|
712
|
+
/**
|
|
713
|
+
* The page of a Cloud server where the signed-in person sees their plan, buys a plan or credits,
|
|
714
|
+
* and manages what they pay for; editors link to it whenever the server advertises billing.
|
|
715
|
+
*/
|
|
716
|
+
declare const CLOUD_ACCOUNT_PLAN_PATH: "/account/plan";
|
|
717
|
+
/**
|
|
718
|
+
* The plan page with billing's own pages opening at once: where billing sends someone whose
|
|
719
|
+
* session there ended, so Cloud signs them in to billing again.
|
|
720
|
+
*/
|
|
721
|
+
declare const CLOUD_ACCOUNT_BILLING_PATH: "/account/plan?open=billing";
|
|
722
|
+
/**
|
|
723
|
+
* The billing service's own pages, below the discovered `endpoint`: where Cloud's plan page sends
|
|
724
|
+
* the signed-in person, posting a billing token as the form field `token` to `session`, and the
|
|
725
|
+
* public pricing page. The service answers that post with `303 See Other`, never `307` or `308`,
|
|
726
|
+
* which a browser follows by posting the same body, the token, again to wherever they point.
|
|
727
|
+
*/
|
|
728
|
+
declare const CLOUD_BILLING_PAGE_PATHS: {
|
|
729
|
+
readonly session: "/session";
|
|
730
|
+
readonly pricing: "/pricing";
|
|
731
|
+
};
|
|
732
|
+
/**
|
|
733
|
+
* Where the billing service answers, below the discovered `endpoint`. Cloud posts to `seats`,
|
|
734
|
+
* with a billing token for the account as its bearer, whenever the people who can edit in that
|
|
735
|
+
* account's workspaces change; the service reads the count from Cloud's internal API.
|
|
736
|
+
*/
|
|
737
|
+
declare const CLOUD_BILLING_API_PATHS: {
|
|
738
|
+
readonly base: "/v1";
|
|
739
|
+
readonly catalog: "/v1/catalog";
|
|
740
|
+
readonly seats: "/v1/seats";
|
|
741
|
+
readonly account: "/v1/account";
|
|
742
|
+
readonly checkout: "/v1/checkout";
|
|
743
|
+
readonly portal: "/v1/portal";
|
|
744
|
+
};
|
|
745
|
+
/**
|
|
746
|
+
* What an account without a plan has: the deployment's free plan, which a pricing page compares
|
|
747
|
+
* the plans with.
|
|
748
|
+
*/
|
|
749
|
+
declare const billingFreePlanSchema: v.ObjectSchema<{
|
|
750
|
+
/** The storage an account may use, or `null` for no limit. */
|
|
751
|
+
readonly storageBytes: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>;
|
|
752
|
+
/** Whether the free plan includes services, such as AI and search. */
|
|
753
|
+
readonly services: v.BooleanSchema<undefined>;
|
|
754
|
+
/** Credits granted each month with services, or `null` for no monthly limit. */
|
|
755
|
+
readonly monthlyCredits: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>;
|
|
756
|
+
}, undefined>;
|
|
757
|
+
type BillingFreePlan = v.InferOutput<typeof billingFreePlanSchema>;
|
|
758
|
+
declare const cloudBillingDiscoverySchema: v.ObjectSchema<{
|
|
759
|
+
readonly endpoint: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
760
|
+
readonly contractVersion: v.LiteralSchema<"1", undefined>;
|
|
761
|
+
readonly freePlan: v.OptionalSchema<v.ObjectSchema<{
|
|
762
|
+
/** The storage an account may use, or `null` for no limit. */
|
|
763
|
+
readonly storageBytes: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>;
|
|
764
|
+
/** Whether the free plan includes services, such as AI and search. */
|
|
765
|
+
readonly services: v.BooleanSchema<undefined>;
|
|
766
|
+
/** Credits granted each month with services, or `null` for no monthly limit. */
|
|
767
|
+
readonly monthlyCredits: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>;
|
|
768
|
+
}, undefined>, undefined>;
|
|
769
|
+
}, undefined>;
|
|
770
|
+
type CloudBillingDiscovery = v.InferOutput<typeof cloudBillingDiscoverySchema>;
|
|
771
|
+
declare const billingTokenSchema: v.ObjectSchema<{
|
|
772
|
+
readonly token: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
773
|
+
readonly expiresAt: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>;
|
|
774
|
+
}, undefined>;
|
|
775
|
+
type BillingToken = v.InferOutput<typeof billingTokenSchema>;
|
|
776
|
+
/**
|
|
777
|
+
* What the billing service may rely on once a token's signature, issuer, audience, and expiry
|
|
778
|
+
* check. The account is the signed-in user, who buys and manages only their own plan.
|
|
779
|
+
*/
|
|
780
|
+
declare const billingTokenClaimsSchema: v.ObjectSchema<{
|
|
781
|
+
readonly iss: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
782
|
+
readonly aud: v.LiteralSchema<"openpencil-billing", undefined>;
|
|
783
|
+
/** The account: the Cloud user whose plan and credits these are. */
|
|
784
|
+
readonly sub: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
785
|
+
/** Where the payment provider sends receipts and invoices. */
|
|
786
|
+
readonly email: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.EmailAction<string, undefined>]>;
|
|
787
|
+
readonly iat: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>]>;
|
|
788
|
+
readonly exp: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>]>;
|
|
789
|
+
}, undefined>;
|
|
790
|
+
type BillingTokenClaims = v.InferOutput<typeof billingTokenClaimsSchema>;
|
|
791
|
+
/**
|
|
792
|
+
* A plan priced by the seat: everyone who can edit in the account's workspaces takes one, and the
|
|
793
|
+
* account pays for at least `minimum`. Every seat costs the price of the tier its count reaches,
|
|
794
|
+
* and adds its storage and credits to what the account shares.
|
|
795
|
+
*/
|
|
796
|
+
declare const billingSeatPricingSchema: v.ObjectSchema<{
|
|
797
|
+
readonly minimum: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
798
|
+
/** From the fewest seats up: the first from 1, each later one from more seats. */
|
|
799
|
+
readonly tiers: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
|
|
800
|
+
readonly fromSeats: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
801
|
+
readonly unitPriceCents: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
802
|
+
}, undefined>, undefined>, v.MinLengthAction<{
|
|
803
|
+
fromSeats: number;
|
|
804
|
+
unitPriceCents: number;
|
|
805
|
+
}[], 1, undefined>, v.CheckAction<{
|
|
806
|
+
fromSeats: number;
|
|
807
|
+
unitPriceCents: number;
|
|
808
|
+
}[], "The first seat tier starts at one seat">, v.CheckAction<{
|
|
809
|
+
fromSeats: number;
|
|
810
|
+
unitPriceCents: number;
|
|
811
|
+
}[], "Seat tiers start at more seats each">]>;
|
|
812
|
+
readonly storageBytesPerSeat: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
813
|
+
readonly monthlyCreditsPerSeat: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
814
|
+
}, undefined>;
|
|
815
|
+
type BillingSeatPricing = v.InferOutput<typeof billingSeatPricingSchema>;
|
|
816
|
+
/**
|
|
817
|
+
* A plan an account subscribes to, billed every month in US dollars before tax. A plan priced by
|
|
818
|
+
* the seat states its price, storage, and credits at its minimum, so an editor that reads no
|
|
819
|
+
* `seats` still shows what it starts at.
|
|
820
|
+
*/
|
|
821
|
+
declare const billingPlanSchema: v.ObjectSchema<{
|
|
822
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
823
|
+
readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
824
|
+
readonly monthlyPriceCents: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
825
|
+
readonly storageBytes: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
826
|
+
readonly monthlyCredits: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
827
|
+
readonly seats: v.OptionalSchema<v.ObjectSchema<{
|
|
828
|
+
readonly minimum: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
829
|
+
/** From the fewest seats up: the first from 1, each later one from more seats. */
|
|
830
|
+
readonly tiers: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
|
|
831
|
+
readonly fromSeats: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
832
|
+
readonly unitPriceCents: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
833
|
+
}, undefined>, undefined>, v.MinLengthAction<{
|
|
834
|
+
fromSeats: number;
|
|
835
|
+
unitPriceCents: number;
|
|
836
|
+
}[], 1, undefined>, v.CheckAction<{
|
|
837
|
+
fromSeats: number;
|
|
838
|
+
unitPriceCents: number;
|
|
839
|
+
}[], "The first seat tier starts at one seat">, v.CheckAction<{
|
|
840
|
+
fromSeats: number;
|
|
841
|
+
unitPriceCents: number;
|
|
842
|
+
}[], "Seat tiers start at more seats each">]>;
|
|
843
|
+
readonly storageBytesPerSeat: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
844
|
+
readonly monthlyCreditsPerSeat: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
845
|
+
}, undefined>, undefined>;
|
|
846
|
+
}, undefined>;
|
|
847
|
+
type BillingPlan = v.InferOutput<typeof billingPlanSchema>;
|
|
848
|
+
/** Credits an account on a plan buys once, in US dollars before tax. */
|
|
849
|
+
declare const creditPackSchema: v.ObjectSchema<{
|
|
850
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
851
|
+
readonly credits: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
852
|
+
readonly priceCents: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
853
|
+
/** How long the credits last from purchase. */
|
|
854
|
+
readonly validDays: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
855
|
+
}, undefined>;
|
|
856
|
+
type CreditPack = v.InferOutput<typeof creditPackSchema>;
|
|
857
|
+
/** What the service sells; an account without a plan has its deployment's free entitlements. */
|
|
858
|
+
declare const billingCatalogSchema: v.ObjectSchema<{
|
|
859
|
+
readonly plans: v.ArraySchema<v.ObjectSchema<{
|
|
860
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
861
|
+
readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
862
|
+
readonly monthlyPriceCents: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
863
|
+
readonly storageBytes: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
864
|
+
readonly monthlyCredits: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
865
|
+
readonly seats: v.OptionalSchema<v.ObjectSchema<{
|
|
866
|
+
readonly minimum: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
867
|
+
/** From the fewest seats up: the first from 1, each later one from more seats. */
|
|
868
|
+
readonly tiers: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
|
|
869
|
+
readonly fromSeats: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
870
|
+
readonly unitPriceCents: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
871
|
+
}, undefined>, undefined>, v.MinLengthAction<{
|
|
872
|
+
fromSeats: number;
|
|
873
|
+
unitPriceCents: number;
|
|
874
|
+
}[], 1, undefined>, v.CheckAction<{
|
|
875
|
+
fromSeats: number;
|
|
876
|
+
unitPriceCents: number;
|
|
877
|
+
}[], "The first seat tier starts at one seat">, v.CheckAction<{
|
|
878
|
+
fromSeats: number;
|
|
879
|
+
unitPriceCents: number;
|
|
880
|
+
}[], "Seat tiers start at more seats each">]>;
|
|
881
|
+
readonly storageBytesPerSeat: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
882
|
+
readonly monthlyCreditsPerSeat: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
883
|
+
}, undefined>, undefined>;
|
|
884
|
+
}, undefined>, undefined>;
|
|
885
|
+
readonly creditPacks: v.ArraySchema<v.ObjectSchema<{
|
|
886
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
887
|
+
readonly credits: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
888
|
+
readonly priceCents: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
889
|
+
/** How long the credits last from purchase. */
|
|
890
|
+
readonly validDays: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
891
|
+
}, undefined>, undefined>;
|
|
892
|
+
}, undefined>;
|
|
893
|
+
type BillingCatalog = v.InferOutput<typeof billingCatalogSchema>;
|
|
894
|
+
/**
|
|
895
|
+
* The account's subscription as the payment provider holds it, or `null` without one. A
|
|
896
|
+
* `past_due` plan keeps its entitlements while payment is retried.
|
|
897
|
+
*/
|
|
898
|
+
declare const billingAccountSchema: v.ObjectSchema<{
|
|
899
|
+
readonly subscription: v.NullableSchema<v.ObjectSchema<{
|
|
900
|
+
readonly planId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
901
|
+
readonly status: v.PicklistSchema<["active", "past_due"], undefined>;
|
|
902
|
+
/** When the current period ends: the next charge, or the end of a cancelled plan. */
|
|
903
|
+
readonly currentPeriodEnd: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>;
|
|
904
|
+
/** Whether the plan ends at `currentPeriodEnd` instead of renewing. */
|
|
905
|
+
readonly cancelsAtPeriodEnd: v.BooleanSchema<undefined>;
|
|
906
|
+
}, undefined>, undefined>;
|
|
907
|
+
}, undefined>;
|
|
908
|
+
type BillingAccount = v.InferOutput<typeof billingAccountSchema>;
|
|
909
|
+
/** What to buy: a plan to subscribe to, or a credit pack. */
|
|
910
|
+
declare const checkoutRequestSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
911
|
+
readonly planId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
912
|
+
}, undefined>, v.ObjectSchema<{
|
|
913
|
+
readonly creditPackId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
914
|
+
}, undefined>], undefined>;
|
|
915
|
+
type CheckoutRequest = v.InferOutput<typeof checkoutRequestSchema>;
|
|
916
|
+
/** Where to send the person: the payment provider's checkout or account portal. */
|
|
917
|
+
declare const billingRedirectSchema: v.ObjectSchema<{
|
|
918
|
+
readonly url: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>, v.RegexAction<string, "Billing sends people to an HTTPS page">]>;
|
|
919
|
+
}, undefined>;
|
|
920
|
+
type BillingRedirect = v.InferOutput<typeof billingRedirectSchema>;
|
|
921
|
+
declare const billingErrorCodeSchema: v.PicklistSchema<["invalid_request", "unauthorized", "not_allowed", "provider_unavailable"], undefined>;
|
|
922
|
+
type BillingErrorCode = v.InferOutput<typeof billingErrorCodeSchema>;
|
|
923
|
+
/** The HTTP status billing answers each error with. */
|
|
924
|
+
declare const BILLING_ERROR_STATUS: {
|
|
925
|
+
readonly invalid_request: 400;
|
|
926
|
+
readonly unauthorized: 401;
|
|
927
|
+
readonly not_allowed: 409;
|
|
928
|
+
readonly provider_unavailable: 502;
|
|
929
|
+
};
|
|
930
|
+
declare const billingErrorSchema: v.ObjectSchema<{
|
|
931
|
+
readonly error: v.ObjectSchema<{
|
|
932
|
+
readonly code: v.PicklistSchema<["invalid_request", "unauthorized", "not_allowed", "provider_unavailable"], undefined>;
|
|
933
|
+
readonly message: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
934
|
+
}, undefined>;
|
|
935
|
+
}, undefined>;
|
|
936
|
+
type BillingError = v.InferOutput<typeof billingErrorSchema>;
|
|
937
|
+
/** The billing service's routes, for a typed Hono client (`hc<CloudBillingAPI>`). */
|
|
938
|
+
type CloudBillingSchema = JSONRoute<'get', typeof CLOUD_BILLING_API_PATHS.catalog, BlankInput, BillingCatalog> & JSONRoute<'get', typeof CLOUD_BILLING_API_PATHS.account, BlankInput, BillingAccount> & JSONRoute<'post', typeof CLOUD_BILLING_API_PATHS.checkout, {
|
|
939
|
+
json: CheckoutRequest;
|
|
940
|
+
}, BillingRedirect> & JSONRoute<'post', typeof CLOUD_BILLING_API_PATHS.portal, BlankInput, BillingRedirect>;
|
|
941
|
+
type CloudBillingAPI = Hono<BlankEnv, CloudBillingSchema>;
|
|
554
942
|
//#endregion
|
|
555
943
|
//#region src/contract/admin/index.d.ts
|
|
556
|
-
declare const adminErrorCodeSchema: v.PicklistSchema<["bad_request", "unauthorized", "forbidden", "not_found", "rate_limited", "invalid_enrollment_transition", "last_admin_required", "self_admin_action_forbidden", "email_regeneration_unavailable", "mfa_required", "document_not_restorable", "workspace_gone"], undefined>;
|
|
944
|
+
declare const adminErrorCodeSchema: v.PicklistSchema<["bad_request", "unauthorized", "forbidden", "not_found", "rate_limited", "invalid_enrollment_transition", "last_admin_required", "self_admin_action_forbidden", "last_authentication_method", "account_approved", "email_regeneration_unavailable", "mfa_required", "two_step_unconfirmed", "document_not_restorable", "workspace_gone"], undefined>;
|
|
557
945
|
declare const adminErrorResponseSchema: v.ObjectSchema<{
|
|
558
946
|
readonly error: v.ObjectSchema<{
|
|
559
|
-
readonly code: v.PicklistSchema<["bad_request", "unauthorized", "forbidden", "not_found", "rate_limited", "invalid_enrollment_transition", "last_admin_required", "self_admin_action_forbidden", "email_regeneration_unavailable", "mfa_required", "document_not_restorable", "workspace_gone"], undefined>;
|
|
947
|
+
readonly code: v.PicklistSchema<["bad_request", "unauthorized", "forbidden", "not_found", "rate_limited", "invalid_enrollment_transition", "last_admin_required", "self_admin_action_forbidden", "last_authentication_method", "account_approved", "email_regeneration_unavailable", "mfa_required", "two_step_unconfirmed", "document_not_restorable", "workspace_gone"], undefined>;
|
|
560
948
|
}, undefined>;
|
|
561
949
|
}, undefined>;
|
|
562
950
|
declare const enrollmentStatusSchema: v.PicklistSchema<["pending", "approved", "rejected", "revoked"], undefined>;
|
|
@@ -611,6 +999,10 @@ declare const enrollmentReviewResponseSchema: v.ObjectSchema<{
|
|
|
611
999
|
readonly requestRevision: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
612
1000
|
}, undefined>;
|
|
613
1001
|
}, undefined>;
|
|
1002
|
+
/** How many waiting requests were approved with the official deployment's invitation letter. */
|
|
1003
|
+
declare const enrollmentInviteResponseSchema: v.ObjectSchema<{
|
|
1004
|
+
readonly invited: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1005
|
+
}, undefined>;
|
|
614
1006
|
declare const cloudAdminSessionResponseSchema: v.ObjectSchema<{
|
|
615
1007
|
readonly user: v.ObjectSchema<{
|
|
616
1008
|
readonly userId: v.StringSchema<undefined>;
|
|
@@ -630,6 +1022,13 @@ declare const cloudAdminUserSchema: v.ObjectSchema<{
|
|
|
630
1022
|
/** When one of the account's sessions was last used, or null when none is left. */
|
|
631
1023
|
readonly lastActiveAt: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>;
|
|
632
1024
|
readonly workspaceCount: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1025
|
+
/** How the account signs in: `credential` for a password, or a provider such as `google`. */
|
|
1026
|
+
readonly methods: v.ArraySchema<v.StringSchema<undefined>, undefined>;
|
|
1027
|
+
/**
|
|
1028
|
+
* On a server that approves people, where this account's request to join stands: an account
|
|
1029
|
+
* exists from its first sign-in, before anyone approved it. Absent where everyone may join.
|
|
1030
|
+
*/
|
|
1031
|
+
readonly request: v.OptionalSchema<v.NullableSchema<v.PicklistSchema<["pending", "approved", "rejected", "revoked"], undefined>, undefined>, undefined>;
|
|
633
1032
|
readonly id: v.StringSchema<undefined>;
|
|
634
1033
|
readonly name: v.StringSchema<undefined>;
|
|
635
1034
|
readonly email: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.EmailAction<string, undefined>]>;
|
|
@@ -637,6 +1036,8 @@ declare const cloudAdminUserSchema: v.ObjectSchema<{
|
|
|
637
1036
|
}, undefined>;
|
|
638
1037
|
/** Which accounts a list of people shows. */
|
|
639
1038
|
declare const cloudAdminUserFilterSchema: v.PicklistSchema<["all", "administrators", "suspended", "without-two-step"], undefined>;
|
|
1039
|
+
/** Narrows a list of people, under any filter, to those who sign in a given way. */
|
|
1040
|
+
declare const cloudAdminUserMethodSchema: v.PicklistSchema<["password", "google", "apple", "github"], undefined>;
|
|
640
1041
|
declare const cloudAdminUsersResponseSchema: v.ObjectSchema<{
|
|
641
1042
|
readonly total: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
642
1043
|
readonly counts: v.ObjectSchema<Record<"all" | "administrators" | "suspended" | "without-two-step", v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>>, undefined>;
|
|
@@ -650,6 +1051,13 @@ declare const cloudAdminUsersResponseSchema: v.ObjectSchema<{
|
|
|
650
1051
|
/** When one of the account's sessions was last used, or null when none is left. */
|
|
651
1052
|
readonly lastActiveAt: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>;
|
|
652
1053
|
readonly workspaceCount: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1054
|
+
/** How the account signs in: `credential` for a password, or a provider such as `google`. */
|
|
1055
|
+
readonly methods: v.ArraySchema<v.StringSchema<undefined>, undefined>;
|
|
1056
|
+
/**
|
|
1057
|
+
* On a server that approves people, where this account's request to join stands: an account
|
|
1058
|
+
* exists from its first sign-in, before anyone approved it. Absent where everyone may join.
|
|
1059
|
+
*/
|
|
1060
|
+
readonly request: v.OptionalSchema<v.NullableSchema<v.PicklistSchema<["pending", "approved", "rejected", "revoked"], undefined>, undefined>, undefined>;
|
|
653
1061
|
readonly id: v.StringSchema<undefined>;
|
|
654
1062
|
readonly name: v.StringSchema<undefined>;
|
|
655
1063
|
readonly email: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.EmailAction<string, undefined>]>;
|
|
@@ -668,21 +1076,31 @@ declare const cloudAdminUserDetailSchema: v.ObjectSchema<{
|
|
|
668
1076
|
/** When one of the account's sessions was last used, or null when none is left. */
|
|
669
1077
|
readonly lastActiveAt: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>;
|
|
670
1078
|
readonly workspaceCount: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1079
|
+
/** How the account signs in: `credential` for a password, or a provider such as `google`. */
|
|
1080
|
+
readonly methods: v.ArraySchema<v.StringSchema<undefined>, undefined>;
|
|
1081
|
+
/**
|
|
1082
|
+
* On a server that approves people, where this account's request to join stands: an account
|
|
1083
|
+
* exists from its first sign-in, before anyone approved it. Absent where everyone may join.
|
|
1084
|
+
*/
|
|
1085
|
+
readonly request: v.OptionalSchema<v.NullableSchema<v.PicklistSchema<["pending", "approved", "rejected", "revoked"], undefined>, undefined>, undefined>;
|
|
671
1086
|
readonly id: v.StringSchema<undefined>;
|
|
672
1087
|
readonly name: v.StringSchema<undefined>;
|
|
673
1088
|
readonly email: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.EmailAction<string, undefined>]>;
|
|
674
1089
|
readonly image: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
675
1090
|
}, undefined>;
|
|
1091
|
+
/** `canRemove`: the account keeps a way in that still works without it. */
|
|
676
1092
|
readonly methods: v.ArraySchema<v.ObjectSchema<{
|
|
1093
|
+
readonly id: v.StringSchema<undefined>;
|
|
677
1094
|
readonly provider: v.StringSchema<undefined>;
|
|
678
1095
|
readonly createdAt: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>;
|
|
1096
|
+
readonly canRemove: v.BooleanSchema<undefined>;
|
|
679
1097
|
}, undefined>, undefined>;
|
|
680
1098
|
readonly authenticator: v.BooleanSchema<undefined>;
|
|
681
1099
|
readonly passkeyCount: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
682
1100
|
readonly sessions: v.ArraySchema<v.ObjectSchema<{
|
|
683
1101
|
readonly id: v.StringSchema<undefined>;
|
|
684
1102
|
readonly current: v.BooleanSchema<undefined>;
|
|
685
|
-
readonly method: v.NullableSchema<v.
|
|
1103
|
+
readonly method: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, "two-step" | "google" | "apple" | "github" | "password" | "passkey" | "email-link" | "desktop" | "other">]>, undefined>;
|
|
686
1104
|
readonly ipAddress: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
687
1105
|
readonly browser: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
688
1106
|
readonly system: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
@@ -692,7 +1110,7 @@ declare const cloudAdminUserDetailSchema: v.ObjectSchema<{
|
|
|
692
1110
|
}, undefined>, undefined>;
|
|
693
1111
|
readonly signIns: v.ArraySchema<v.ObjectSchema<{
|
|
694
1112
|
readonly id: v.StringSchema<undefined>;
|
|
695
|
-
readonly method: v.
|
|
1113
|
+
readonly method: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, "two-step" | "google" | "apple" | "github" | "password" | "passkey" | "email-link" | "desktop" | "other">]>;
|
|
696
1114
|
readonly ipAddress: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
697
1115
|
readonly browser: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
698
1116
|
readonly system: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
@@ -785,6 +1203,8 @@ declare const adminAuditResponseSchema: v.ObjectSchema<{
|
|
|
785
1203
|
declare const cloudAdminDocumentSchema: v.ObjectSchema<{
|
|
786
1204
|
readonly id: v.StringSchema<undefined>;
|
|
787
1205
|
readonly name: v.StringSchema<undefined>;
|
|
1206
|
+
/** A design or a board. Servers from before send none, and had only designs. */
|
|
1207
|
+
readonly kind: v.OptionalSchema<v.PicklistSchema<["design", "board"], undefined>, "design">;
|
|
788
1208
|
readonly workspace: v.ObjectSchema<{
|
|
789
1209
|
readonly id: v.StringSchema<undefined>;
|
|
790
1210
|
readonly name: v.StringSchema<undefined>;
|
|
@@ -807,6 +1227,24 @@ declare const cloudAdminDocumentSchema: v.ObjectSchema<{
|
|
|
807
1227
|
*/
|
|
808
1228
|
readonly purgedAt: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>, null>;
|
|
809
1229
|
readonly destroyedAt: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>, null>;
|
|
1230
|
+
/**
|
|
1231
|
+
* The saved revision whose thumbnail previews it; null before its first save. Servers from
|
|
1232
|
+
* before previews send none.
|
|
1233
|
+
*/
|
|
1234
|
+
readonly revisionId: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, null>;
|
|
1235
|
+
/**
|
|
1236
|
+
* Who beyond its workspace can open it: anyone, in the community gallery, and whoever holds one
|
|
1237
|
+
* of its live share links, `editLinks` of which let them edit. Servers from before send none.
|
|
1238
|
+
*/
|
|
1239
|
+
readonly exposure: v.OptionalSchema<v.ObjectSchema<{
|
|
1240
|
+
readonly community: v.BooleanSchema<undefined>;
|
|
1241
|
+
readonly links: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1242
|
+
readonly editLinks: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1243
|
+
}, undefined>, {
|
|
1244
|
+
readonly community: false;
|
|
1245
|
+
readonly links: 0;
|
|
1246
|
+
readonly editLinks: 0;
|
|
1247
|
+
}>;
|
|
810
1248
|
}, undefined>;
|
|
811
1249
|
/** Which documents a list shows: live ones, or those deleted forever an administrator can restore. */
|
|
812
1250
|
declare const cloudAdminDocumentFilterSchema: v.PicklistSchema<["all", "reported", "disabled", "purged"], undefined>;
|
|
@@ -816,6 +1254,8 @@ declare const cloudAdminDocumentsResponseSchema: v.ObjectSchema<{
|
|
|
816
1254
|
readonly documents: v.ArraySchema<v.ObjectSchema<{
|
|
817
1255
|
readonly id: v.StringSchema<undefined>;
|
|
818
1256
|
readonly name: v.StringSchema<undefined>;
|
|
1257
|
+
/** A design or a board. Servers from before send none, and had only designs. */
|
|
1258
|
+
readonly kind: v.OptionalSchema<v.PicklistSchema<["design", "board"], undefined>, "design">;
|
|
819
1259
|
readonly workspace: v.ObjectSchema<{
|
|
820
1260
|
readonly id: v.StringSchema<undefined>;
|
|
821
1261
|
readonly name: v.StringSchema<undefined>;
|
|
@@ -838,6 +1278,24 @@ declare const cloudAdminDocumentsResponseSchema: v.ObjectSchema<{
|
|
|
838
1278
|
*/
|
|
839
1279
|
readonly purgedAt: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>, null>;
|
|
840
1280
|
readonly destroyedAt: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>, null>;
|
|
1281
|
+
/**
|
|
1282
|
+
* The saved revision whose thumbnail previews it; null before its first save. Servers from
|
|
1283
|
+
* before previews send none.
|
|
1284
|
+
*/
|
|
1285
|
+
readonly revisionId: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, null>;
|
|
1286
|
+
/**
|
|
1287
|
+
* Who beyond its workspace can open it: anyone, in the community gallery, and whoever holds one
|
|
1288
|
+
* of its live share links, `editLinks` of which let them edit. Servers from before send none.
|
|
1289
|
+
*/
|
|
1290
|
+
readonly exposure: v.OptionalSchema<v.ObjectSchema<{
|
|
1291
|
+
readonly community: v.BooleanSchema<undefined>;
|
|
1292
|
+
readonly links: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1293
|
+
readonly editLinks: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1294
|
+
}, undefined>, {
|
|
1295
|
+
readonly community: false;
|
|
1296
|
+
readonly links: 0;
|
|
1297
|
+
readonly editLinks: 0;
|
|
1298
|
+
}>;
|
|
841
1299
|
}, undefined>, undefined>;
|
|
842
1300
|
}, undefined>;
|
|
843
1301
|
declare const cloudAdminReportStatusSchema: v.PicklistSchema<["open", "dismissed", "actioned"], undefined>;
|
|
@@ -857,6 +1315,8 @@ declare const cloudAdminReportSchema: v.ObjectSchema<{
|
|
|
857
1315
|
readonly document: v.ObjectSchema<{
|
|
858
1316
|
readonly id: v.StringSchema<undefined>;
|
|
859
1317
|
readonly name: v.StringSchema<undefined>;
|
|
1318
|
+
/** A design or a board. Servers from before send none, and had only designs. */
|
|
1319
|
+
readonly kind: v.OptionalSchema<v.PicklistSchema<["design", "board"], undefined>, "design">;
|
|
860
1320
|
readonly workspace: v.ObjectSchema<{
|
|
861
1321
|
readonly id: v.StringSchema<undefined>;
|
|
862
1322
|
readonly name: v.StringSchema<undefined>;
|
|
@@ -879,6 +1339,24 @@ declare const cloudAdminReportSchema: v.ObjectSchema<{
|
|
|
879
1339
|
*/
|
|
880
1340
|
readonly purgedAt: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>, null>;
|
|
881
1341
|
readonly destroyedAt: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>, null>;
|
|
1342
|
+
/**
|
|
1343
|
+
* The saved revision whose thumbnail previews it; null before its first save. Servers from
|
|
1344
|
+
* before previews send none.
|
|
1345
|
+
*/
|
|
1346
|
+
readonly revisionId: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, null>;
|
|
1347
|
+
/**
|
|
1348
|
+
* Who beyond its workspace can open it: anyone, in the community gallery, and whoever holds one
|
|
1349
|
+
* of its live share links, `editLinks` of which let them edit. Servers from before send none.
|
|
1350
|
+
*/
|
|
1351
|
+
readonly exposure: v.OptionalSchema<v.ObjectSchema<{
|
|
1352
|
+
readonly community: v.BooleanSchema<undefined>;
|
|
1353
|
+
readonly links: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1354
|
+
readonly editLinks: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1355
|
+
}, undefined>, {
|
|
1356
|
+
readonly community: false;
|
|
1357
|
+
readonly links: 0;
|
|
1358
|
+
readonly editLinks: 0;
|
|
1359
|
+
}>;
|
|
882
1360
|
}, undefined>;
|
|
883
1361
|
/** The link it was opened from, and whether that link still works. */
|
|
884
1362
|
readonly share: v.NullableSchema<v.ObjectSchema<{
|
|
@@ -907,6 +1385,8 @@ declare const cloudAdminReportsResponseSchema: v.ObjectSchema<{
|
|
|
907
1385
|
readonly document: v.ObjectSchema<{
|
|
908
1386
|
readonly id: v.StringSchema<undefined>;
|
|
909
1387
|
readonly name: v.StringSchema<undefined>;
|
|
1388
|
+
/** A design or a board. Servers from before send none, and had only designs. */
|
|
1389
|
+
readonly kind: v.OptionalSchema<v.PicklistSchema<["design", "board"], undefined>, "design">;
|
|
910
1390
|
readonly workspace: v.ObjectSchema<{
|
|
911
1391
|
readonly id: v.StringSchema<undefined>;
|
|
912
1392
|
readonly name: v.StringSchema<undefined>;
|
|
@@ -929,6 +1409,24 @@ declare const cloudAdminReportsResponseSchema: v.ObjectSchema<{
|
|
|
929
1409
|
*/
|
|
930
1410
|
readonly purgedAt: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>, null>;
|
|
931
1411
|
readonly destroyedAt: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>, undefined>, null>;
|
|
1412
|
+
/**
|
|
1413
|
+
* The saved revision whose thumbnail previews it; null before its first save. Servers from
|
|
1414
|
+
* before previews send none.
|
|
1415
|
+
*/
|
|
1416
|
+
readonly revisionId: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, null>;
|
|
1417
|
+
/**
|
|
1418
|
+
* Who beyond its workspace can open it: anyone, in the community gallery, and whoever holds one
|
|
1419
|
+
* of its live share links, `editLinks` of which let them edit. Servers from before send none.
|
|
1420
|
+
*/
|
|
1421
|
+
readonly exposure: v.OptionalSchema<v.ObjectSchema<{
|
|
1422
|
+
readonly community: v.BooleanSchema<undefined>;
|
|
1423
|
+
readonly links: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1424
|
+
readonly editLinks: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1425
|
+
}, undefined>, {
|
|
1426
|
+
readonly community: false;
|
|
1427
|
+
readonly links: 0;
|
|
1428
|
+
readonly editLinks: 0;
|
|
1429
|
+
}>;
|
|
932
1430
|
}, undefined>;
|
|
933
1431
|
/** The link it was opened from, and whether that link still works. */
|
|
934
1432
|
readonly share: v.NullableSchema<v.ObjectSchema<{
|
|
@@ -955,6 +1453,7 @@ type Enrollment = v.InferOutput<typeof enrollmentSchema>;
|
|
|
955
1453
|
type CloudAdminSessionResponse = v.InferOutput<typeof cloudAdminSessionResponseSchema>;
|
|
956
1454
|
type CloudAdminUser = v.InferOutput<typeof cloudAdminUserSchema>;
|
|
957
1455
|
type CloudAdminUserFilter = v.InferOutput<typeof cloudAdminUserFilterSchema>;
|
|
1456
|
+
type CloudAdminUserMethod = v.InferOutput<typeof cloudAdminUserMethodSchema>;
|
|
958
1457
|
type CloudAdminEmailFilter = v.InferOutput<typeof cloudAdminEmailFilterSchema>;
|
|
959
1458
|
type CloudAdminAuditFilter = v.InferOutput<typeof cloudAdminAuditFilterSchema>;
|
|
960
1459
|
type EnrollmentStatus = v.InferOutput<typeof enrollmentStatusSchema>;
|
|
@@ -1010,6 +1509,11 @@ declare const collaborationTicketSchema: v.ObjectSchema<{
|
|
|
1010
1509
|
readonly name: v.StringSchema<undefined>;
|
|
1011
1510
|
}, undefined>], undefined>;
|
|
1012
1511
|
readonly permission: v.PicklistSchema<["view", "edit"], undefined>;
|
|
1512
|
+
/**
|
|
1513
|
+
* Why a peer whose access would let them edit may only view: `storage-limit` when the document's
|
|
1514
|
+
* owner holds their whole storage allowance, until they free space or their plan grows.
|
|
1515
|
+
*/
|
|
1516
|
+
readonly readOnly: v.OptionalSchema<v.PicklistSchema<["storage-limit"], undefined>, undefined>;
|
|
1013
1517
|
readonly roomEpoch: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1014
1518
|
readonly expiresAt: v.StringSchema<undefined>;
|
|
1015
1519
|
readonly serverEnforcedWrites: v.BooleanSchema<undefined>;
|
|
@@ -1044,6 +1548,8 @@ declare const COLLAB_ACTIONS: {
|
|
|
1044
1548
|
readonly upload: "upload";
|
|
1045
1549
|
/** From the server only: the document's version history changed, so open lists load it again. */
|
|
1046
1550
|
readonly versions: "versions";
|
|
1551
|
+
/** From the server only: a comment thread changed; the payload is its ID as UTF-8. */
|
|
1552
|
+
readonly comments: "comments";
|
|
1047
1553
|
};
|
|
1048
1554
|
/**
|
|
1049
1555
|
* The most a room message may decode to, compressed or not. A peer's update past it is dropped
|
|
@@ -1187,6 +1693,55 @@ declare const workspaceEntitlementsSchema: v.ObjectSchema<{
|
|
|
1187
1693
|
}, undefined>;
|
|
1188
1694
|
}, undefined>;
|
|
1189
1695
|
type WorkspaceEntitlements = v.InferOutput<typeof workspaceEntitlementsSchema>;
|
|
1696
|
+
/**
|
|
1697
|
+
* An account's own plan and the storage its workspaces hold together. A workspace reports the
|
|
1698
|
+
* same for its owner, so the two read alike.
|
|
1699
|
+
*/
|
|
1700
|
+
declare const accountEntitlementsSchema: v.ObjectSchema<{
|
|
1701
|
+
readonly features: v.ObjectSchema<{
|
|
1702
|
+
readonly links: v.BooleanSchema<undefined>;
|
|
1703
|
+
readonly guestView: v.BooleanSchema<undefined>;
|
|
1704
|
+
readonly guestEdit: v.BooleanSchema<undefined>;
|
|
1705
|
+
readonly guestPresence: v.BooleanSchema<undefined>;
|
|
1706
|
+
readonly collaboration: v.BooleanSchema<undefined>;
|
|
1707
|
+
readonly revisionHistory: v.BooleanSchema<undefined>;
|
|
1708
|
+
readonly cloudServices: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
|
|
1709
|
+
}, undefined>;
|
|
1710
|
+
readonly limits: v.ObjectSchema<{
|
|
1711
|
+
readonly maximumFileBytes: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
1712
|
+
readonly maximumStorageBytes: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>, undefined>;
|
|
1713
|
+
readonly maximumParticipants: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>, undefined>;
|
|
1714
|
+
readonly monthlyCreditAllowance: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, null>;
|
|
1715
|
+
}, undefined>;
|
|
1716
|
+
readonly usage: v.ObjectSchema<{
|
|
1717
|
+
readonly committedStorageBytes: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1718
|
+
readonly reservedStorageBytes: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1719
|
+
}, undefined>;
|
|
1720
|
+
}, undefined>;
|
|
1721
|
+
type AccountEntitlements = WorkspaceEntitlements;
|
|
1722
|
+
declare const accountEntitlementsResponseSchema: v.ObjectSchema<{
|
|
1723
|
+
readonly entitlements: v.ObjectSchema<{
|
|
1724
|
+
readonly features: v.ObjectSchema<{
|
|
1725
|
+
readonly links: v.BooleanSchema<undefined>;
|
|
1726
|
+
readonly guestView: v.BooleanSchema<undefined>;
|
|
1727
|
+
readonly guestEdit: v.BooleanSchema<undefined>;
|
|
1728
|
+
readonly guestPresence: v.BooleanSchema<undefined>;
|
|
1729
|
+
readonly collaboration: v.BooleanSchema<undefined>;
|
|
1730
|
+
readonly revisionHistory: v.BooleanSchema<undefined>;
|
|
1731
|
+
readonly cloudServices: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
|
|
1732
|
+
}, undefined>;
|
|
1733
|
+
readonly limits: v.ObjectSchema<{
|
|
1734
|
+
readonly maximumFileBytes: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
1735
|
+
readonly maximumStorageBytes: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>, undefined>;
|
|
1736
|
+
readonly maximumParticipants: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>, undefined>;
|
|
1737
|
+
readonly monthlyCreditAllowance: v.OptionalSchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, null>;
|
|
1738
|
+
}, undefined>;
|
|
1739
|
+
readonly usage: v.ObjectSchema<{
|
|
1740
|
+
readonly committedStorageBytes: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1741
|
+
readonly reservedStorageBytes: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
|
|
1742
|
+
}, undefined>;
|
|
1743
|
+
}, undefined>;
|
|
1744
|
+
}, undefined>;
|
|
1190
1745
|
//#endregion
|
|
1191
1746
|
//#region src/contract/discovery.d.ts
|
|
1192
1747
|
declare const CLOUD_PROTOCOL_VERSION: "1";
|
|
@@ -1203,7 +1758,7 @@ declare const cloudAuthenticationSchema: v.ObjectSchema<{
|
|
|
1203
1758
|
readonly siteKey: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>]>;
|
|
1204
1759
|
}, undefined>, undefined>;
|
|
1205
1760
|
}, undefined>, undefined>;
|
|
1206
|
-
readonly socialProviders: v.ArraySchema<v.
|
|
1761
|
+
readonly socialProviders: v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.TransformAction<string[], ("google" | "apple" | "github")[]>]>;
|
|
1207
1762
|
readonly enterpriseSSO: v.BooleanSchema<undefined>;
|
|
1208
1763
|
readonly enrollmentMode: v.OptionalSchema<v.PicklistSchema<["open", "approval", "closed"], undefined>, "open">;
|
|
1209
1764
|
readonly mfa: v.OptionalSchema<v.ObjectSchema<{
|
|
@@ -1220,15 +1775,35 @@ declare const cloudCapabilitiesSchema: v.ObjectSchema<{
|
|
|
1220
1775
|
readonly collaboration: v.BooleanSchema<undefined>;
|
|
1221
1776
|
}, undefined>;
|
|
1222
1777
|
type CloudCapabilities = v.InferOutput<typeof cloudCapabilitiesSchema>;
|
|
1223
|
-
/**
|
|
1224
|
-
|
|
1778
|
+
/**
|
|
1779
|
+
* An editor version, as SemVer: a release such as `0.18.0`, or a pre-release such as
|
|
1780
|
+
* `0.18.0-beta.2` or a nightly's `0.18.0-nightly.20261116`.
|
|
1781
|
+
*
|
|
1782
|
+
* Editors before 0.18.0 accept only `major.minor.patch` here and fail discovery on anything else,
|
|
1783
|
+
* so a server names a pre-release minimum only once its minimum is already 0.18.0 or later.
|
|
1784
|
+
*/
|
|
1785
|
+
declare const cloudEditorVersionSchema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Expected a SemVer version">]>;
|
|
1786
|
+
/**
|
|
1787
|
+
* The header desktop editors send with each request, naming their version, so a server can refuse
|
|
1788
|
+
* an editor older than its `minimumEditorVersion`. Browser editors leave it out: the server serves
|
|
1789
|
+
* them, and an older server's CORS rules would refuse a header they don't list.
|
|
1790
|
+
*/
|
|
1791
|
+
declare const CLOUD_EDITOR_VERSION_HEADER: "X-OpenPencil-Editor-Version";
|
|
1792
|
+
/**
|
|
1793
|
+
* Whether `version` is `minimum` or later, in SemVer order: a pre-release comes before its
|
|
1794
|
+
* release, so `0.18.0-beta.2` is not at least `0.18.0`; a release's nightlies come after its
|
|
1795
|
+
* betas and order by date. To admit a release's pre-releases, name the earliest one, such as
|
|
1796
|
+
* `0.18.0-beta.1`, or `0.18.0-nightly.20261116` for nightlies from that day on. A
|
|
1797
|
+
* version that isn't SemVer, on either side, is not at least anything.
|
|
1798
|
+
*/
|
|
1799
|
+
declare function isEditorVersionAtLeast(version: string, minimum: string): boolean;
|
|
1225
1800
|
/**
|
|
1226
1801
|
* Whether editors offer this server to everyone, and from which editor version on. Only the
|
|
1227
1802
|
* official server's listing is read: it turns the Cloud entry points on without an editor release,
|
|
1228
1803
|
* and an editor older than the minimum keeps them hidden.
|
|
1229
1804
|
*/
|
|
1230
1805
|
declare const cloudListingSchema: v.ObjectSchema<{
|
|
1231
|
-
readonly minimumEditorVersion: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.
|
|
1806
|
+
readonly minimumEditorVersion: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Expected a SemVer version">]>;
|
|
1232
1807
|
}, undefined>;
|
|
1233
1808
|
type CloudListing = v.InferOutput<typeof cloudListingSchema>;
|
|
1234
1809
|
/**
|
|
@@ -1245,6 +1820,26 @@ declare const cloudLegalDiscoverySchema: v.ObjectSchema<{
|
|
|
1245
1820
|
readonly minimumAge: v.OptionalSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>]>, undefined>;
|
|
1246
1821
|
}, undefined>;
|
|
1247
1822
|
type CloudLegalDiscovery = v.InferOutput<typeof cloudLegalDiscoverySchema>;
|
|
1823
|
+
/**
|
|
1824
|
+
* How a self-hosted server names itself on its public pages: the operator's name and logo in the
|
|
1825
|
+
* bar, and where its people get help. The official server is OpenPencil's own and names none.
|
|
1826
|
+
*/
|
|
1827
|
+
declare const cloudBrandingSchema: v.ObjectSchema<{
|
|
1828
|
+
readonly name: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
1829
|
+
readonly logoURL: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>, v.CheckAction<string, undefined>]>, undefined>;
|
|
1830
|
+
readonly helpURL: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>, v.CheckAction<string, undefined>]>, undefined>;
|
|
1831
|
+
}, undefined>;
|
|
1832
|
+
type CloudBranding = v.InferOutput<typeof cloudBrandingSchema>;
|
|
1833
|
+
/**
|
|
1834
|
+
* The server's community gallery: the workspace whose documents anyone may open read-only.
|
|
1835
|
+
* Saving to it publishes, so editors never choose it for anyone and say so when it is chosen.
|
|
1836
|
+
* `tourDocumentId` is the gallery document editors open as their tour.
|
|
1837
|
+
*/
|
|
1838
|
+
declare const cloudCommunityDiscoverySchema: v.ObjectSchema<{
|
|
1839
|
+
readonly workspaceId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
1840
|
+
readonly tourDocumentId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>, undefined>;
|
|
1841
|
+
}, undefined>;
|
|
1842
|
+
type CloudCommunityDiscovery = v.InferOutput<typeof cloudCommunityDiscoverySchema>;
|
|
1248
1843
|
declare const cloudDiscoverySchema: v.ObjectSchema<{
|
|
1249
1844
|
readonly protocolVersion: v.LiteralSchema<"1", undefined>;
|
|
1250
1845
|
readonly deployment: v.PicklistSchema<["official", "self-hosted"], undefined>;
|
|
@@ -1262,7 +1857,7 @@ declare const cloudDiscoverySchema: v.ObjectSchema<{
|
|
|
1262
1857
|
readonly siteKey: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>]>;
|
|
1263
1858
|
}, undefined>, undefined>;
|
|
1264
1859
|
}, undefined>, undefined>;
|
|
1265
|
-
readonly socialProviders: v.ArraySchema<v.
|
|
1860
|
+
readonly socialProviders: v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.TransformAction<string[], ("google" | "apple" | "github")[]>]>;
|
|
1266
1861
|
readonly enterpriseSSO: v.BooleanSchema<undefined>;
|
|
1267
1862
|
readonly enrollmentMode: v.OptionalSchema<v.PicklistSchema<["open", "approval", "closed"], undefined>, "open">;
|
|
1268
1863
|
readonly mfa: v.OptionalSchema<v.ObjectSchema<{
|
|
@@ -1278,8 +1873,13 @@ declare const cloudDiscoverySchema: v.ObjectSchema<{
|
|
|
1278
1873
|
readonly collaboration: v.BooleanSchema<undefined>;
|
|
1279
1874
|
}, undefined>;
|
|
1280
1875
|
readonly listing: v.OptionalSchema<v.ObjectSchema<{
|
|
1281
|
-
readonly minimumEditorVersion: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.
|
|
1876
|
+
readonly minimumEditorVersion: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Expected a SemVer version">]>;
|
|
1282
1877
|
}, undefined>, undefined>;
|
|
1878
|
+
/**
|
|
1879
|
+
* The oldest editor version the server works with. Older editors ask to be updated instead of
|
|
1880
|
+
* connecting, and the server refuses their requests.
|
|
1881
|
+
*/
|
|
1882
|
+
readonly minimumEditorVersion: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Expected a SemVer version">]>, undefined>;
|
|
1283
1883
|
/** The services editors reach with Cloud-signed tokens; absent when the deployment has none. */
|
|
1284
1884
|
readonly services: v.OptionalSchema<v.ObjectSchema<{
|
|
1285
1885
|
readonly endpoint: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
@@ -1287,7 +1887,18 @@ declare const cloudDiscoverySchema: v.ObjectSchema<{
|
|
|
1287
1887
|
}, undefined>, undefined>;
|
|
1288
1888
|
/** Where people manage their plan and buy credits; absent when the deployment does not bill. */
|
|
1289
1889
|
readonly billing: v.OptionalSchema<v.ObjectSchema<{
|
|
1290
|
-
readonly
|
|
1890
|
+
readonly endpoint: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
1891
|
+
readonly contractVersion: v.LiteralSchema<"1", undefined>;
|
|
1892
|
+
readonly freePlan: v.OptionalSchema<v.ObjectSchema<{
|
|
1893
|
+
readonly storageBytes: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>;
|
|
1894
|
+
readonly services: v.BooleanSchema<undefined>;
|
|
1895
|
+
readonly monthlyCredits: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>;
|
|
1896
|
+
}, undefined>, undefined>;
|
|
1897
|
+
}, undefined>, undefined>;
|
|
1898
|
+
/** The community gallery; absent when the deployment has none. */
|
|
1899
|
+
readonly community: v.OptionalSchema<v.ObjectSchema<{
|
|
1900
|
+
readonly workspaceId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
1901
|
+
readonly tourDocumentId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>, undefined>;
|
|
1291
1902
|
}, undefined>, undefined>;
|
|
1292
1903
|
readonly legal: v.OptionalSchema<v.ObjectSchema<{
|
|
1293
1904
|
readonly termsURL: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>, undefined>;
|
|
@@ -1297,6 +1908,11 @@ declare const cloudDiscoverySchema: v.ObjectSchema<{
|
|
|
1297
1908
|
readonly abuseEmail: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.EmailAction<string, undefined>]>, undefined>;
|
|
1298
1909
|
readonly minimumAge: v.OptionalSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>]>, undefined>;
|
|
1299
1910
|
}, undefined>, undefined>;
|
|
1911
|
+
readonly branding: v.OptionalSchema<v.ObjectSchema<{
|
|
1912
|
+
readonly name: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
1913
|
+
readonly logoURL: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>, v.CheckAction<string, undefined>]>, undefined>;
|
|
1914
|
+
readonly helpURL: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>, v.CheckAction<string, undefined>]>, undefined>;
|
|
1915
|
+
}, undefined>, undefined>;
|
|
1300
1916
|
}, undefined>;
|
|
1301
1917
|
type CloudDiscovery = v.InferOutput<typeof cloudDiscoverySchema>;
|
|
1302
1918
|
/** The server's own address, where its editor and pages are, from its auth API's. */
|
|
@@ -1806,6 +2422,11 @@ declare const workspaceSummarySchema: v.ObjectSchema<{
|
|
|
1806
2422
|
readonly name: v.StringSchema<undefined>;
|
|
1807
2423
|
readonly slug: v.StringSchema<undefined>;
|
|
1808
2424
|
readonly role: v.PicklistSchema<["viewer", "editor", "admin"], undefined>;
|
|
2425
|
+
/**
|
|
2426
|
+
* Whether the signed-in account owns the workspace, and so pays for its plan and AI credits.
|
|
2427
|
+
* Absent from servers released before it.
|
|
2428
|
+
*/
|
|
2429
|
+
readonly owner: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
|
|
1809
2430
|
readonly createdAt: v.StringSchema<undefined>;
|
|
1810
2431
|
readonly updatedAt: v.StringSchema<undefined>;
|
|
1811
2432
|
}, undefined>;
|
|
@@ -1821,6 +2442,11 @@ declare const workspaceListSchema: v.ObjectSchema<{
|
|
|
1821
2442
|
readonly name: v.StringSchema<undefined>;
|
|
1822
2443
|
readonly slug: v.StringSchema<undefined>;
|
|
1823
2444
|
readonly role: v.PicklistSchema<["viewer", "editor", "admin"], undefined>;
|
|
2445
|
+
/**
|
|
2446
|
+
* Whether the signed-in account owns the workspace, and so pays for its plan and AI credits.
|
|
2447
|
+
* Absent from servers released before it.
|
|
2448
|
+
*/
|
|
2449
|
+
readonly owner: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
|
|
1824
2450
|
readonly createdAt: v.StringSchema<undefined>;
|
|
1825
2451
|
readonly updatedAt: v.StringSchema<undefined>;
|
|
1826
2452
|
}, undefined>, undefined>;
|
|
@@ -1912,8 +2538,13 @@ declare function parseUpdateWorkspaceMember(input: unknown): UpdateWorkspaceMemb
|
|
|
1912
2538
|
//#region src/contract/links.d.ts
|
|
1913
2539
|
/** The two kinds of Cloud link that carry a secret: invitations and documents shared by link. */
|
|
1914
2540
|
type CloudLinkKind = 'invitations' | 'share';
|
|
1915
|
-
/**
|
|
1916
|
-
|
|
2541
|
+
/**
|
|
2542
|
+
* Every kind of Cloud link: those that carry a secret, a document's address for members, and a
|
|
2543
|
+
* document of the server's community gallery, which anyone may open.
|
|
2544
|
+
*/
|
|
2545
|
+
type CloudLinkPathKind = CloudLinkKind | 'documents' | 'community';
|
|
2546
|
+
/** The server's community gallery: every document in it, each with a page of its own. */
|
|
2547
|
+
declare const CLOUD_COMMUNITY_PATH = "/community";
|
|
1917
2548
|
/** An invitation to a document or a workspace, `/invitations/:id#token`. */
|
|
1918
2549
|
declare function cloudInvitationURL(serverURL: string, invitationId: string, token: string): string;
|
|
1919
2550
|
/** A document shared by link, `/share/:id#secret`. */
|
|
@@ -1924,6 +2555,14 @@ declare function cloudShareURL(serverURL: string, shareId: string, secret: strin
|
|
|
1924
2555
|
*/
|
|
1925
2556
|
declare function cloudDocumentURL(serverURL: string, documentId: string, versionId?: string | null): string;
|
|
1926
2557
|
declare function cloudDocumentPath(documentId: string): string;
|
|
2558
|
+
/**
|
|
2559
|
+
* A document of the server's community gallery opened in the editor, `/community/:id/open`, or
|
|
2560
|
+
* one of its named versions with `?version=…`, which anyone opens read-only without signing in.
|
|
2561
|
+
*/
|
|
2562
|
+
declare function cloudCommunityURL(serverURL: string, documentId: string, versionId?: string | null): string;
|
|
2563
|
+
declare function cloudCommunityPath(documentId: string): string;
|
|
2564
|
+
/** A community document's page on the server: its preview, versions, and ways to open it. */
|
|
2565
|
+
declare function cloudCommunityPagePath(documentId: string): string;
|
|
1927
2566
|
/**
|
|
1928
2567
|
* The kind and ID of a Cloud link's path, or null for any other path. The ID is decoded; a broken
|
|
1929
2568
|
* escape such as `%E0` is no link.
|
|
@@ -1938,6 +2577,13 @@ declare function parseCloudLinkPath(pathname: string): {
|
|
|
1938
2577
|
* `desktop/src/launch/links.rs` validates it before the editor sees it.
|
|
1939
2578
|
*/
|
|
1940
2579
|
declare function cloudDesktopLinkURL(kind: CloudLinkKind, id: string, serverURL: string, secret: string): string;
|
|
2580
|
+
/**
|
|
2581
|
+
* The desktop app's form of a community document's link, `openpencil://cloud?url=<link>`: the
|
|
2582
|
+
* editor's address for it, with the named version it asks for, if any. It carries no secret.
|
|
2583
|
+
*/
|
|
2584
|
+
declare function cloudCommunityDesktopLinkURL(documentId: string, serverURL: string, versionId?: string | null): string;
|
|
2585
|
+
/** A comment thread on a document, `/documents/:id?comment=…`, which opens it. */
|
|
2586
|
+
declare function cloudCommentURL(serverURL: string, documentId: string, threadId: string): string;
|
|
1941
2587
|
//#endregion
|
|
1942
2588
|
//#region src/contract/portal.d.ts
|
|
1943
2589
|
/**
|
|
@@ -1947,6 +2593,11 @@ declare function cloudDesktopLinkURL(kind: CloudLinkKind, id: string, serverURL:
|
|
|
1947
2593
|
* paths, and the editor's `index.html` at the root and at any other page the API does not answer.
|
|
1948
2594
|
*/
|
|
1949
2595
|
declare const CLOUD_PORTAL_PAGE_ROOTS: readonly ["/welcome", "/auth", "/account", "/admin"];
|
|
2596
|
+
/**
|
|
2597
|
+
* The community gallery's pages, which the portal serves too: the gallery at `/community` and a
|
|
2598
|
+
* document's page at `/community/:id`. The editor opens a document at `/community/:id/open`.
|
|
2599
|
+
*/
|
|
2600
|
+
declare const CLOUD_PORTAL_COMMUNITY_PAGES: readonly ["/community", "/community/:documentId"];
|
|
1950
2601
|
declare function isCloudPortalPage(path: string): boolean;
|
|
1951
2602
|
//#endregion
|
|
1952
2603
|
//#region src/contract/versions.d.ts
|
|
@@ -2130,6 +2781,649 @@ declare function parseSaveDocumentVersion(input: unknown): SaveDocumentVersionIn
|
|
|
2130
2781
|
declare function parseUpdateDocumentVersion(input: unknown): UpdateDocumentVersionInput;
|
|
2131
2782
|
declare function parseDuplicateDocumentVersion(input: unknown): DuplicateDocumentVersionInput;
|
|
2132
2783
|
//#endregion
|
|
2784
|
+
//#region src/contract/comments.d.ts
|
|
2785
|
+
/** The most a comment may say, in characters. */
|
|
2786
|
+
declare const COMMENT_BODY_MAX_LENGTH = 10000;
|
|
2787
|
+
/** The most threads one document may hold, resolved ones included. */
|
|
2788
|
+
declare const MAX_COMMENT_THREADS_PER_DOCUMENT = 5000;
|
|
2789
|
+
/** The most comments one thread may hold, its first one included. */
|
|
2790
|
+
declare const MAX_COMMENTS_PER_THREAD = 500;
|
|
2791
|
+
/** The most a page, layer or author name in a comment may hold, in characters. */
|
|
2792
|
+
declare const COMMENT_NAME_MAX_LENGTH = 255;
|
|
2793
|
+
/**
|
|
2794
|
+
* Who wrote a comment: an account, whose name is null once it is deleted, or a name a file gave
|
|
2795
|
+
* when the comment came in with it, which no account vouches for.
|
|
2796
|
+
*/
|
|
2797
|
+
declare const commentAuthorSchema: v.VariantSchema<"kind", [v.ObjectSchema<{
|
|
2798
|
+
readonly kind: v.LiteralSchema<"user", undefined>;
|
|
2799
|
+
readonly id: v.StringSchema<undefined>;
|
|
2800
|
+
readonly name: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2801
|
+
}, undefined>, v.ObjectSchema<{
|
|
2802
|
+
readonly kind: v.LiteralSchema<"imported", undefined>;
|
|
2803
|
+
readonly name: v.StringSchema<undefined>;
|
|
2804
|
+
}, undefined>], undefined>;
|
|
2805
|
+
type CommentAuthor = v.InferOutput<typeof commentAuthorSchema>;
|
|
2806
|
+
declare const cloudCommentSchema: v.ObjectSchema<{
|
|
2807
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
2808
|
+
readonly author: v.VariantSchema<"kind", [v.ObjectSchema<{
|
|
2809
|
+
readonly kind: v.LiteralSchema<"user", undefined>;
|
|
2810
|
+
readonly id: v.StringSchema<undefined>;
|
|
2811
|
+
readonly name: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2812
|
+
}, undefined>, v.ObjectSchema<{
|
|
2813
|
+
readonly kind: v.LiteralSchema<"imported", undefined>;
|
|
2814
|
+
readonly name: v.StringSchema<undefined>;
|
|
2815
|
+
}, undefined>], undefined>;
|
|
2816
|
+
/** The agent that wrote it on its author's behalf. */
|
|
2817
|
+
readonly agent: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2818
|
+
/** Markdown, as the editor writes it. */
|
|
2819
|
+
readonly body: v.StringSchema<undefined>;
|
|
2820
|
+
/** The accounts it names, which hear about it. */
|
|
2821
|
+
readonly mentions: v.ArraySchema<v.StringSchema<undefined>, undefined>;
|
|
2822
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
2823
|
+
readonly editedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2824
|
+
}, undefined>;
|
|
2825
|
+
type CloudComment = v.InferOutput<typeof cloudCommentSchema>;
|
|
2826
|
+
declare const commentAnchorSchema: v.ObjectSchema<{
|
|
2827
|
+
pageId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>;
|
|
2828
|
+
pageName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2829
|
+
/** The top-level layer the pin follows, if any. */
|
|
2830
|
+
nodeId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>;
|
|
2831
|
+
nodeName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2832
|
+
/** The pin's offset from the layer's top-left corner. */
|
|
2833
|
+
offsetX: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2834
|
+
offsetY: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2835
|
+
/** The pin's canvas position, used once the layer is gone. */
|
|
2836
|
+
x: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
2837
|
+
y: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
2838
|
+
}, undefined>;
|
|
2839
|
+
type CommentAnchor = v.InferOutput<typeof commentAnchorSchema>;
|
|
2840
|
+
declare const cloudCommentThreadSchema: v.ObjectSchema<{
|
|
2841
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
2842
|
+
/** When anything in the thread last changed: a comment, the pin, or whether it is resolved. */
|
|
2843
|
+
readonly updatedAt: v.StringSchema<undefined>;
|
|
2844
|
+
readonly resolvedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2845
|
+
readonly resolvedBy: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2846
|
+
/** Who started it, or brought it in from a file: they may move its pin and delete it. */
|
|
2847
|
+
readonly createdBy: v.StringSchema<undefined>;
|
|
2848
|
+
/** Whether someone else wrote in it since the asker last read it; false for a guest. */
|
|
2849
|
+
readonly unread: v.BooleanSchema<undefined>;
|
|
2850
|
+
/** Oldest first; the first is what started the thread. */
|
|
2851
|
+
readonly comments: v.ArraySchema<v.ObjectSchema<{
|
|
2852
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
2853
|
+
readonly author: v.VariantSchema<"kind", [v.ObjectSchema<{
|
|
2854
|
+
readonly kind: v.LiteralSchema<"user", undefined>;
|
|
2855
|
+
readonly id: v.StringSchema<undefined>;
|
|
2856
|
+
readonly name: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2857
|
+
}, undefined>, v.ObjectSchema<{
|
|
2858
|
+
readonly kind: v.LiteralSchema<"imported", undefined>;
|
|
2859
|
+
readonly name: v.StringSchema<undefined>;
|
|
2860
|
+
}, undefined>], undefined>;
|
|
2861
|
+
/** The agent that wrote it on its author's behalf. */
|
|
2862
|
+
readonly agent: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2863
|
+
/** Markdown, as the editor writes it. */
|
|
2864
|
+
readonly body: v.StringSchema<undefined>;
|
|
2865
|
+
/** The accounts it names, which hear about it. */
|
|
2866
|
+
readonly mentions: v.ArraySchema<v.StringSchema<undefined>, undefined>;
|
|
2867
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
2868
|
+
readonly editedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2869
|
+
}, undefined>, undefined>;
|
|
2870
|
+
readonly pageId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>;
|
|
2871
|
+
readonly pageName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2872
|
+
readonly nodeId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>;
|
|
2873
|
+
readonly nodeName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2874
|
+
readonly offsetX: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2875
|
+
readonly offsetY: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2876
|
+
readonly x: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
2877
|
+
readonly y: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
2878
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
2879
|
+
}, undefined>;
|
|
2880
|
+
type CloudCommentThread = v.InferOutput<typeof cloudCommentThreadSchema>;
|
|
2881
|
+
/** What the person asking may do with the document's comments. */
|
|
2882
|
+
declare const commentAccessSchema: v.ObjectSchema<{
|
|
2883
|
+
/** Start threads, reply, and change their own comments; anyone signed in who can view. */
|
|
2884
|
+
readonly canComment: v.BooleanSchema<undefined>;
|
|
2885
|
+
/** Delete anyone's comments; editors. */
|
|
2886
|
+
readonly canModerate: v.BooleanSchema<undefined>;
|
|
2887
|
+
/** The asker's account, which their own comments name; null for a guest. */
|
|
2888
|
+
readonly accountId: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2889
|
+
}, undefined>;
|
|
2890
|
+
type CommentAccess = v.InferOutput<typeof commentAccessSchema>;
|
|
2891
|
+
declare const commentThreadsSchema: v.ObjectSchema<{
|
|
2892
|
+
readonly threads: v.ArraySchema<v.ObjectSchema<{
|
|
2893
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
2894
|
+
/** When anything in the thread last changed: a comment, the pin, or whether it is resolved. */
|
|
2895
|
+
readonly updatedAt: v.StringSchema<undefined>;
|
|
2896
|
+
readonly resolvedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2897
|
+
readonly resolvedBy: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2898
|
+
/** Who started it, or brought it in from a file: they may move its pin and delete it. */
|
|
2899
|
+
readonly createdBy: v.StringSchema<undefined>;
|
|
2900
|
+
/** Whether someone else wrote in it since the asker last read it; false for a guest. */
|
|
2901
|
+
readonly unread: v.BooleanSchema<undefined>;
|
|
2902
|
+
/** Oldest first; the first is what started the thread. */
|
|
2903
|
+
readonly comments: v.ArraySchema<v.ObjectSchema<{
|
|
2904
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
2905
|
+
readonly author: v.VariantSchema<"kind", [v.ObjectSchema<{
|
|
2906
|
+
readonly kind: v.LiteralSchema<"user", undefined>;
|
|
2907
|
+
readonly id: v.StringSchema<undefined>;
|
|
2908
|
+
readonly name: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2909
|
+
}, undefined>, v.ObjectSchema<{
|
|
2910
|
+
readonly kind: v.LiteralSchema<"imported", undefined>;
|
|
2911
|
+
readonly name: v.StringSchema<undefined>;
|
|
2912
|
+
}, undefined>], undefined>;
|
|
2913
|
+
/** The agent that wrote it on its author's behalf. */
|
|
2914
|
+
readonly agent: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2915
|
+
/** Markdown, as the editor writes it. */
|
|
2916
|
+
readonly body: v.StringSchema<undefined>;
|
|
2917
|
+
/** The accounts it names, which hear about it. */
|
|
2918
|
+
readonly mentions: v.ArraySchema<v.StringSchema<undefined>, undefined>;
|
|
2919
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
2920
|
+
readonly editedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2921
|
+
}, undefined>, undefined>;
|
|
2922
|
+
readonly pageId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>;
|
|
2923
|
+
readonly pageName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2924
|
+
readonly nodeId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>;
|
|
2925
|
+
readonly nodeName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2926
|
+
readonly offsetX: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2927
|
+
readonly offsetY: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2928
|
+
readonly x: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
2929
|
+
readonly y: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
2930
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
2931
|
+
}, undefined>, undefined>;
|
|
2932
|
+
readonly access: v.ObjectSchema<{
|
|
2933
|
+
/** Start threads, reply, and change their own comments; anyone signed in who can view. */
|
|
2934
|
+
readonly canComment: v.BooleanSchema<undefined>;
|
|
2935
|
+
/** Delete anyone's comments; editors. */
|
|
2936
|
+
readonly canModerate: v.BooleanSchema<undefined>;
|
|
2937
|
+
/** The asker's account, which their own comments name; null for a guest. */
|
|
2938
|
+
readonly accountId: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2939
|
+
}, undefined>;
|
|
2940
|
+
}, undefined>;
|
|
2941
|
+
type CommentThreads = v.InferOutput<typeof commentThreadsSchema>;
|
|
2942
|
+
declare const commentThreadResponseSchema: v.ObjectSchema<{
|
|
2943
|
+
readonly thread: v.ObjectSchema<{
|
|
2944
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
2945
|
+
/** When anything in the thread last changed: a comment, the pin, or whether it is resolved. */
|
|
2946
|
+
readonly updatedAt: v.StringSchema<undefined>;
|
|
2947
|
+
readonly resolvedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2948
|
+
readonly resolvedBy: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2949
|
+
/** Who started it, or brought it in from a file: they may move its pin and delete it. */
|
|
2950
|
+
readonly createdBy: v.StringSchema<undefined>;
|
|
2951
|
+
/** Whether someone else wrote in it since the asker last read it; false for a guest. */
|
|
2952
|
+
readonly unread: v.BooleanSchema<undefined>;
|
|
2953
|
+
/** Oldest first; the first is what started the thread. */
|
|
2954
|
+
readonly comments: v.ArraySchema<v.ObjectSchema<{
|
|
2955
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
2956
|
+
readonly author: v.VariantSchema<"kind", [v.ObjectSchema<{
|
|
2957
|
+
readonly kind: v.LiteralSchema<"user", undefined>;
|
|
2958
|
+
readonly id: v.StringSchema<undefined>;
|
|
2959
|
+
readonly name: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2960
|
+
}, undefined>, v.ObjectSchema<{
|
|
2961
|
+
readonly kind: v.LiteralSchema<"imported", undefined>;
|
|
2962
|
+
readonly name: v.StringSchema<undefined>;
|
|
2963
|
+
}, undefined>], undefined>;
|
|
2964
|
+
/** The agent that wrote it on its author's behalf. */
|
|
2965
|
+
readonly agent: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2966
|
+
/** Markdown, as the editor writes it. */
|
|
2967
|
+
readonly body: v.StringSchema<undefined>;
|
|
2968
|
+
/** The accounts it names, which hear about it. */
|
|
2969
|
+
readonly mentions: v.ArraySchema<v.StringSchema<undefined>, undefined>;
|
|
2970
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
2971
|
+
readonly editedAt: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
2972
|
+
}, undefined>, undefined>;
|
|
2973
|
+
readonly pageId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>;
|
|
2974
|
+
readonly pageName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2975
|
+
readonly nodeId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>;
|
|
2976
|
+
readonly nodeName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2977
|
+
readonly offsetX: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2978
|
+
readonly offsetY: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2979
|
+
readonly x: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
2980
|
+
readonly y: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
2981
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
2982
|
+
}, undefined>;
|
|
2983
|
+
}, undefined>;
|
|
2984
|
+
/** The most accounts one comment names. */
|
|
2985
|
+
declare const MAX_COMMENT_MENTIONS = 50;
|
|
2986
|
+
/** The longest agent name a comment keeps. */
|
|
2987
|
+
declare const MAX_COMMENT_AGENT_LENGTH = 100;
|
|
2988
|
+
declare const createCommentThreadSchema: v.ObjectSchema<{
|
|
2989
|
+
readonly body: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 10000, undefined>]>;
|
|
2990
|
+
readonly mentions: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>, v.MaxLengthAction<string[], 50, undefined>]>, readonly []>;
|
|
2991
|
+
readonly agent: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 100, undefined>]>, undefined>;
|
|
2992
|
+
readonly pageId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>;
|
|
2993
|
+
readonly pageName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2994
|
+
readonly nodeId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>;
|
|
2995
|
+
readonly nodeName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
2996
|
+
readonly offsetX: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2997
|
+
readonly offsetY: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
2998
|
+
readonly x: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
2999
|
+
readonly y: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
3000
|
+
readonly id: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>, undefined>;
|
|
3001
|
+
}, undefined>;
|
|
3002
|
+
type CreateCommentThreadInput = v.InferOutput<typeof createCommentThreadSchema>;
|
|
3003
|
+
/** Resolves or reopens a thread, or moves its pin; what is left out stays as it is. */
|
|
3004
|
+
declare const updateCommentThreadSchema: v.ObjectSchema<{
|
|
3005
|
+
readonly resolved: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
|
|
3006
|
+
readonly anchor: v.OptionalSchema<v.ObjectSchema<{
|
|
3007
|
+
pageId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>;
|
|
3008
|
+
pageName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
3009
|
+
/** The top-level layer the pin follows, if any. */
|
|
3010
|
+
nodeId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>;
|
|
3011
|
+
nodeName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
3012
|
+
/** The pin's offset from the layer's top-left corner. */
|
|
3013
|
+
offsetX: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
3014
|
+
offsetY: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
3015
|
+
/** The pin's canvas position, used once the layer is gone. */
|
|
3016
|
+
x: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
3017
|
+
y: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
3018
|
+
}, undefined>, undefined>;
|
|
3019
|
+
}, undefined>;
|
|
3020
|
+
type UpdateCommentThreadInput = v.InferOutput<typeof updateCommentThreadSchema>;
|
|
3021
|
+
declare const createCommentSchema: v.ObjectSchema<{
|
|
3022
|
+
readonly id: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>, undefined>;
|
|
3023
|
+
readonly body: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 10000, undefined>]>;
|
|
3024
|
+
readonly mentions: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>, v.MaxLengthAction<string[], 50, undefined>]>, readonly []>;
|
|
3025
|
+
readonly agent: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 100, undefined>]>, undefined>;
|
|
3026
|
+
}, undefined>;
|
|
3027
|
+
type CreateCommentInput = v.InferOutput<typeof createCommentSchema>;
|
|
3028
|
+
declare const updateCommentSchema: v.ObjectSchema<{
|
|
3029
|
+
readonly body: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 10000, undefined>]>;
|
|
3030
|
+
readonly mentions: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>, v.MaxLengthAction<string[], 50, undefined>]>, readonly []>;
|
|
3031
|
+
}, undefined>;
|
|
3032
|
+
type UpdateCommentInput = v.InferOutput<typeof updateCommentSchema>;
|
|
3033
|
+
/** Someone a comment may name: an account that can open the document. */
|
|
3034
|
+
declare const commentPersonSchema: v.ObjectSchema<{
|
|
3035
|
+
readonly id: v.StringSchema<undefined>;
|
|
3036
|
+
readonly name: v.StringSchema<undefined>;
|
|
3037
|
+
readonly image: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
3038
|
+
}, undefined>;
|
|
3039
|
+
type CommentPerson = v.InferOutput<typeof commentPersonSchema>;
|
|
3040
|
+
declare const commentPeopleSchema: v.ObjectSchema<{
|
|
3041
|
+
readonly people: v.ArraySchema<v.ObjectSchema<{
|
|
3042
|
+
readonly id: v.StringSchema<undefined>;
|
|
3043
|
+
readonly name: v.StringSchema<undefined>;
|
|
3044
|
+
readonly image: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
3045
|
+
}, undefined>, undefined>;
|
|
3046
|
+
}, undefined>;
|
|
3047
|
+
/** Which comments an account hears about by email. */
|
|
3048
|
+
declare const commentEmailSettingSchema: v.PicklistSchema<["all", "mentions", "off"], undefined>;
|
|
3049
|
+
type CommentEmailSetting = v.InferOutput<typeof commentEmailSettingSchema>;
|
|
3050
|
+
declare const notificationSettingsSchema: v.ObjectSchema<{
|
|
3051
|
+
readonly commentEmails: v.PicklistSchema<["all", "mentions", "off"], undefined>;
|
|
3052
|
+
}, undefined>;
|
|
3053
|
+
type NotificationSettings = v.InferOutput<typeof notificationSettingsSchema>;
|
|
3054
|
+
/** The most threads, and comments in all, one import brings in. */
|
|
3055
|
+
declare const MAX_IMPORTED_COMMENT_THREADS = 1000;
|
|
3056
|
+
declare const MAX_IMPORTED_COMMENTS = 10000;
|
|
3057
|
+
/**
|
|
3058
|
+
* Threads a file held when it moved to Cloud. Their authors are names the file gave, which the
|
|
3059
|
+
* server keeps as such; their times are the file's.
|
|
3060
|
+
*/
|
|
3061
|
+
declare const importCommentThreadsSchema: v.ObjectSchema<{
|
|
3062
|
+
readonly threads: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
|
|
3063
|
+
readonly createdAt: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>;
|
|
3064
|
+
readonly resolved: v.BooleanSchema<undefined>;
|
|
3065
|
+
readonly comments: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
|
|
3066
|
+
readonly authorName: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MaxLengthAction<string, 255, undefined>]>;
|
|
3067
|
+
readonly body: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 10000, undefined>]>;
|
|
3068
|
+
readonly createdAt: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.IsoTimestampAction<string, undefined>]>;
|
|
3069
|
+
}, undefined>, undefined>, v.MinLengthAction<{
|
|
3070
|
+
authorName: string;
|
|
3071
|
+
body: string;
|
|
3072
|
+
createdAt: string;
|
|
3073
|
+
}[], 1, undefined>, v.MaxLengthAction<{
|
|
3074
|
+
authorName: string;
|
|
3075
|
+
body: string;
|
|
3076
|
+
createdAt: string;
|
|
3077
|
+
}[], 10000, undefined>]>;
|
|
3078
|
+
readonly pageId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>;
|
|
3079
|
+
readonly pageName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
3080
|
+
readonly nodeId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>;
|
|
3081
|
+
readonly nodeName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
3082
|
+
readonly offsetX: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
3083
|
+
readonly offsetY: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
3084
|
+
readonly x: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
3085
|
+
readonly y: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
3086
|
+
}, undefined>, undefined>, v.MaxLengthAction<{
|
|
3087
|
+
createdAt: string;
|
|
3088
|
+
resolved: boolean;
|
|
3089
|
+
comments: {
|
|
3090
|
+
authorName: string;
|
|
3091
|
+
body: string;
|
|
3092
|
+
createdAt: string;
|
|
3093
|
+
}[];
|
|
3094
|
+
pageId: string;
|
|
3095
|
+
pageName: string | null;
|
|
3096
|
+
nodeId: string | null;
|
|
3097
|
+
nodeName: string | null;
|
|
3098
|
+
offsetX: number | null;
|
|
3099
|
+
offsetY: number | null;
|
|
3100
|
+
x: number;
|
|
3101
|
+
y: number;
|
|
3102
|
+
}[], 1000, undefined>, v.CheckAction<{
|
|
3103
|
+
createdAt: string;
|
|
3104
|
+
resolved: boolean;
|
|
3105
|
+
comments: {
|
|
3106
|
+
authorName: string;
|
|
3107
|
+
body: string;
|
|
3108
|
+
createdAt: string;
|
|
3109
|
+
}[];
|
|
3110
|
+
pageId: string;
|
|
3111
|
+
pageName: string | null;
|
|
3112
|
+
nodeId: string | null;
|
|
3113
|
+
nodeName: string | null;
|
|
3114
|
+
offsetX: number | null;
|
|
3115
|
+
offsetY: number | null;
|
|
3116
|
+
x: number;
|
|
3117
|
+
y: number;
|
|
3118
|
+
}[], "An import brings in at most 10000 comments">]>;
|
|
3119
|
+
}, undefined>;
|
|
3120
|
+
type ImportCommentThreadsInput = v.InferOutput<typeof importCommentThreadsSchema>;
|
|
3121
|
+
declare const sharedCommentsRequestSchema: v.ObjectSchema<{
|
|
3122
|
+
share: Omit<v.ObjectSchema<{
|
|
3123
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3124
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3125
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3126
|
+
}, undefined>, "~standard" | "~run" | "~types" | "entries"> & {
|
|
3127
|
+
readonly entries: Pick<{
|
|
3128
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3129
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3130
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3131
|
+
}, "secret">;
|
|
3132
|
+
readonly "~standard": v.StandardProps<{
|
|
3133
|
+
secret: string;
|
|
3134
|
+
}, {
|
|
3135
|
+
secret: string;
|
|
3136
|
+
}>;
|
|
3137
|
+
readonly "~run": (dataset: v.UnknownDataset, config: v.Config<v.BaseIssue<unknown>>) => v.OutputDataset<{
|
|
3138
|
+
secret: string;
|
|
3139
|
+
}, v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>>;
|
|
3140
|
+
readonly "~types"?: {
|
|
3141
|
+
readonly input: {
|
|
3142
|
+
secret: string;
|
|
3143
|
+
};
|
|
3144
|
+
readonly output: {
|
|
3145
|
+
secret: string;
|
|
3146
|
+
};
|
|
3147
|
+
readonly issue: v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>;
|
|
3148
|
+
} | undefined;
|
|
3149
|
+
};
|
|
3150
|
+
}, undefined>;
|
|
3151
|
+
declare const sharedCreateCommentThreadSchema: v.ObjectSchema<{
|
|
3152
|
+
readonly body: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 10000, undefined>]>;
|
|
3153
|
+
readonly mentions: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>, v.MaxLengthAction<string[], 50, undefined>]>, readonly []>;
|
|
3154
|
+
readonly agent: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 100, undefined>]>, undefined>;
|
|
3155
|
+
readonly pageId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>;
|
|
3156
|
+
readonly pageName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
3157
|
+
readonly nodeId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>;
|
|
3158
|
+
readonly nodeName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
3159
|
+
readonly offsetX: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
3160
|
+
readonly offsetY: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
3161
|
+
readonly x: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
3162
|
+
readonly y: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
3163
|
+
readonly id: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>, undefined>;
|
|
3164
|
+
readonly share: Omit<v.ObjectSchema<{
|
|
3165
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3166
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3167
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3168
|
+
}, undefined>, "~standard" | "~run" | "~types" | "entries"> & {
|
|
3169
|
+
readonly entries: Pick<{
|
|
3170
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3171
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3172
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3173
|
+
}, "secret">;
|
|
3174
|
+
readonly "~standard": v.StandardProps<{
|
|
3175
|
+
secret: string;
|
|
3176
|
+
}, {
|
|
3177
|
+
secret: string;
|
|
3178
|
+
}>;
|
|
3179
|
+
readonly "~run": (dataset: v.UnknownDataset, config: v.Config<v.BaseIssue<unknown>>) => v.OutputDataset<{
|
|
3180
|
+
secret: string;
|
|
3181
|
+
}, v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>>;
|
|
3182
|
+
readonly "~types"?: {
|
|
3183
|
+
readonly input: {
|
|
3184
|
+
secret: string;
|
|
3185
|
+
};
|
|
3186
|
+
readonly output: {
|
|
3187
|
+
secret: string;
|
|
3188
|
+
};
|
|
3189
|
+
readonly issue: v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>;
|
|
3190
|
+
} | undefined;
|
|
3191
|
+
};
|
|
3192
|
+
}, undefined>;
|
|
3193
|
+
declare const sharedUpdateCommentThreadSchema: v.ObjectSchema<{
|
|
3194
|
+
readonly resolved: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
|
|
3195
|
+
readonly anchor: v.OptionalSchema<v.ObjectSchema<{
|
|
3196
|
+
pageId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>;
|
|
3197
|
+
pageName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
3198
|
+
/** The top-level layer the pin follows, if any. */
|
|
3199
|
+
nodeId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>;
|
|
3200
|
+
nodeName: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MaxLengthAction<string, 255, undefined>]>, undefined>;
|
|
3201
|
+
/** The pin's offset from the layer's top-left corner. */
|
|
3202
|
+
offsetX: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
3203
|
+
offsetY: v.NullableSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>, undefined>;
|
|
3204
|
+
/** The pin's canvas position, used once the layer is gone. */
|
|
3205
|
+
x: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
3206
|
+
y: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>]>;
|
|
3207
|
+
}, undefined>, undefined>;
|
|
3208
|
+
readonly share: Omit<v.ObjectSchema<{
|
|
3209
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3210
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3211
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3212
|
+
}, undefined>, "~standard" | "~run" | "~types" | "entries"> & {
|
|
3213
|
+
readonly entries: Pick<{
|
|
3214
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3215
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3216
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3217
|
+
}, "secret">;
|
|
3218
|
+
readonly "~standard": v.StandardProps<{
|
|
3219
|
+
secret: string;
|
|
3220
|
+
}, {
|
|
3221
|
+
secret: string;
|
|
3222
|
+
}>;
|
|
3223
|
+
readonly "~run": (dataset: v.UnknownDataset, config: v.Config<v.BaseIssue<unknown>>) => v.OutputDataset<{
|
|
3224
|
+
secret: string;
|
|
3225
|
+
}, v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>>;
|
|
3226
|
+
readonly "~types"?: {
|
|
3227
|
+
readonly input: {
|
|
3228
|
+
secret: string;
|
|
3229
|
+
};
|
|
3230
|
+
readonly output: {
|
|
3231
|
+
secret: string;
|
|
3232
|
+
};
|
|
3233
|
+
readonly issue: v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>;
|
|
3234
|
+
} | undefined;
|
|
3235
|
+
};
|
|
3236
|
+
}, undefined>;
|
|
3237
|
+
declare const sharedCreateCommentSchema: v.ObjectSchema<{
|
|
3238
|
+
readonly id: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>, undefined>;
|
|
3239
|
+
readonly body: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 10000, undefined>]>;
|
|
3240
|
+
readonly mentions: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>, v.MaxLengthAction<string[], 50, undefined>]>, readonly []>;
|
|
3241
|
+
readonly agent: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 100, undefined>]>, undefined>;
|
|
3242
|
+
readonly share: Omit<v.ObjectSchema<{
|
|
3243
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3244
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3245
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3246
|
+
}, undefined>, "~standard" | "~run" | "~types" | "entries"> & {
|
|
3247
|
+
readonly entries: Pick<{
|
|
3248
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3249
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3250
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3251
|
+
}, "secret">;
|
|
3252
|
+
readonly "~standard": v.StandardProps<{
|
|
3253
|
+
secret: string;
|
|
3254
|
+
}, {
|
|
3255
|
+
secret: string;
|
|
3256
|
+
}>;
|
|
3257
|
+
readonly "~run": (dataset: v.UnknownDataset, config: v.Config<v.BaseIssue<unknown>>) => v.OutputDataset<{
|
|
3258
|
+
secret: string;
|
|
3259
|
+
}, v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>>;
|
|
3260
|
+
readonly "~types"?: {
|
|
3261
|
+
readonly input: {
|
|
3262
|
+
secret: string;
|
|
3263
|
+
};
|
|
3264
|
+
readonly output: {
|
|
3265
|
+
secret: string;
|
|
3266
|
+
};
|
|
3267
|
+
readonly issue: v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>;
|
|
3268
|
+
} | undefined;
|
|
3269
|
+
};
|
|
3270
|
+
}, undefined>;
|
|
3271
|
+
declare const sharedUpdateCommentSchema: v.ObjectSchema<{
|
|
3272
|
+
readonly body: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 10000, undefined>]>;
|
|
3273
|
+
readonly mentions: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 200, undefined>]>, undefined>, v.MaxLengthAction<string[], 50, undefined>]>, readonly []>;
|
|
3274
|
+
readonly share: Omit<v.ObjectSchema<{
|
|
3275
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3276
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3277
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3278
|
+
}, undefined>, "~standard" | "~run" | "~types" | "entries"> & {
|
|
3279
|
+
readonly entries: Pick<{
|
|
3280
|
+
readonly secret: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 32, undefined>, v.MaxLengthAction<string, 128, undefined>]>;
|
|
3281
|
+
readonly guestName: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.MinLengthAction<string, 1, undefined>, v.MaxLengthAction<string, 80, undefined>]>, undefined>;
|
|
3282
|
+
readonly guestId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 16, undefined>, v.MaxLengthAction<string, 128, undefined>]>, undefined>;
|
|
3283
|
+
}, "secret">;
|
|
3284
|
+
readonly "~standard": v.StandardProps<{
|
|
3285
|
+
secret: string;
|
|
3286
|
+
}, {
|
|
3287
|
+
secret: string;
|
|
3288
|
+
}>;
|
|
3289
|
+
readonly "~run": (dataset: v.UnknownDataset, config: v.Config<v.BaseIssue<unknown>>) => v.OutputDataset<{
|
|
3290
|
+
secret: string;
|
|
3291
|
+
}, v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>>;
|
|
3292
|
+
readonly "~types"?: {
|
|
3293
|
+
readonly input: {
|
|
3294
|
+
secret: string;
|
|
3295
|
+
};
|
|
3296
|
+
readonly output: {
|
|
3297
|
+
secret: string;
|
|
3298
|
+
};
|
|
3299
|
+
readonly issue: v.StringIssue | v.ObjectIssue | v.MaxLengthIssue<string, 128> | v.MinLengthIssue<string, 32>;
|
|
3300
|
+
} | undefined;
|
|
3301
|
+
};
|
|
3302
|
+
}, undefined>;
|
|
3303
|
+
type SharedCommentsRequest = v.InferOutput<typeof sharedCommentsRequestSchema>;
|
|
3304
|
+
//#endregion
|
|
3305
|
+
//#region src/contract/community.d.ts
|
|
3306
|
+
/**
|
|
3307
|
+
* Where a community document's thumbnail is served, by its document and revision: the address
|
|
3308
|
+
* changes with each save, so a cached copy never shows an older state.
|
|
3309
|
+
*/
|
|
3310
|
+
declare const COMMUNITY_THUMBNAIL_PATH = "/api/community/thumbnails";
|
|
3311
|
+
declare function communityThumbnailPath(documentId: string, revisionId: string): string;
|
|
3312
|
+
/** A version of a community document someone named, such as the release it was published for. */
|
|
3313
|
+
declare const communityVersionSchema: v.ObjectSchema<{
|
|
3314
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3315
|
+
readonly name: v.StringSchema<undefined>;
|
|
3316
|
+
readonly description: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
3317
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
3318
|
+
/** Whether the document holds this version now, with nothing changed since it was named. */
|
|
3319
|
+
readonly current: v.BooleanSchema<undefined>;
|
|
3320
|
+
}, undefined>;
|
|
3321
|
+
type CommunityVersion = v.InferOutput<typeof communityVersionSchema>;
|
|
3322
|
+
/**
|
|
3323
|
+
* A document in the deployment's community workspace, which anyone may open read-only: its name,
|
|
3324
|
+
* when it last changed, its thumbnail's path on the server, and its named versions, newest first.
|
|
3325
|
+
*/
|
|
3326
|
+
declare const communityDocumentSchema: v.ObjectSchema<{
|
|
3327
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3328
|
+
readonly name: v.StringSchema<undefined>;
|
|
3329
|
+
readonly kind: v.PicklistSchema<["design", "board"], undefined>;
|
|
3330
|
+
readonly updatedAt: v.StringSchema<undefined>;
|
|
3331
|
+
readonly revisionId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3332
|
+
readonly thumbnailPath: v.StringSchema<undefined>;
|
|
3333
|
+
readonly versions: v.ArraySchema<v.ObjectSchema<{
|
|
3334
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3335
|
+
readonly name: v.StringSchema<undefined>;
|
|
3336
|
+
readonly description: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
3337
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
3338
|
+
/** Whether the document holds this version now, with nothing changed since it was named. */
|
|
3339
|
+
readonly current: v.BooleanSchema<undefined>;
|
|
3340
|
+
}, undefined>, undefined>;
|
|
3341
|
+
}, undefined>;
|
|
3342
|
+
type CommunityDocument = v.InferOutput<typeof communityDocumentSchema>;
|
|
3343
|
+
/** The community workspace's documents, most recently changed first. */
|
|
3344
|
+
declare const communityDocumentsSchema: v.ObjectSchema<{
|
|
3345
|
+
readonly documents: v.ArraySchema<v.ObjectSchema<{
|
|
3346
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3347
|
+
readonly name: v.StringSchema<undefined>;
|
|
3348
|
+
readonly kind: v.PicklistSchema<["design", "board"], undefined>;
|
|
3349
|
+
readonly updatedAt: v.StringSchema<undefined>;
|
|
3350
|
+
readonly revisionId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3351
|
+
readonly thumbnailPath: v.StringSchema<undefined>;
|
|
3352
|
+
readonly versions: v.ArraySchema<v.ObjectSchema<{
|
|
3353
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3354
|
+
readonly name: v.StringSchema<undefined>;
|
|
3355
|
+
readonly description: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
3356
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
3357
|
+
/** Whether the document holds this version now, with nothing changed since it was named. */
|
|
3358
|
+
readonly current: v.BooleanSchema<undefined>;
|
|
3359
|
+
}, undefined>, undefined>;
|
|
3360
|
+
}, undefined>, undefined>;
|
|
3361
|
+
}, undefined>;
|
|
3362
|
+
type CommunityDocuments = v.InferOutput<typeof communityDocumentsSchema>;
|
|
3363
|
+
/** Which state of a community document to open: a named version, or else the latest. */
|
|
3364
|
+
declare const communityDownloadQuerySchema: v.ObjectSchema<{
|
|
3365
|
+
readonly version: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>, undefined>;
|
|
3366
|
+
}, undefined>;
|
|
3367
|
+
type CommunityDownloadQuery = v.InferOutput<typeof communityDownloadQuerySchema>;
|
|
3368
|
+
declare function parseCommunityDownloadQuery(input: unknown): CommunityDownloadQuery;
|
|
3369
|
+
/** A community document, or one of its named versions, with where to download it. */
|
|
3370
|
+
declare const communityDownloadSchema: v.ObjectSchema<{
|
|
3371
|
+
readonly document: v.ObjectSchema<{
|
|
3372
|
+
readonly document: v.ObjectSchema<{
|
|
3373
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3374
|
+
readonly workspaceId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3375
|
+
readonly name: v.StringSchema<undefined>;
|
|
3376
|
+
readonly kind: v.OptionalSchema<v.PicklistSchema<["design", "board"], undefined>, "design">;
|
|
3377
|
+
readonly currentRevisionId: v.NullableSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>, undefined>;
|
|
3378
|
+
readonly version: v.NumberSchema<undefined>;
|
|
3379
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
3380
|
+
readonly updatedAt: v.StringSchema<undefined>;
|
|
3381
|
+
}, undefined>;
|
|
3382
|
+
readonly revisionId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3383
|
+
readonly byteSize: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
3384
|
+
readonly checksum: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
3385
|
+
readonly contentType: v.StringSchema<undefined>;
|
|
3386
|
+
readonly download: v.ObjectSchema<{
|
|
3387
|
+
readonly url: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
3388
|
+
readonly method: v.LiteralSchema<"GET", undefined>;
|
|
3389
|
+
readonly headers: v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>;
|
|
3390
|
+
readonly expiresAt: v.StringSchema<undefined>;
|
|
3391
|
+
}, undefined>;
|
|
3392
|
+
readonly images: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
|
|
3393
|
+
readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
3394
|
+
readonly checksum: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>]>;
|
|
3395
|
+
readonly byteSize: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
|
|
3396
|
+
readonly download: v.ObjectSchema<{
|
|
3397
|
+
readonly url: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
3398
|
+
readonly method: v.LiteralSchema<"GET", undefined>;
|
|
3399
|
+
readonly headers: v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>;
|
|
3400
|
+
readonly expiresAt: v.StringSchema<undefined>;
|
|
3401
|
+
}, undefined>;
|
|
3402
|
+
}, undefined>, undefined>, v.MaxLengthAction<{
|
|
3403
|
+
name: string;
|
|
3404
|
+
checksum: string;
|
|
3405
|
+
byteSize: number;
|
|
3406
|
+
download: {
|
|
3407
|
+
url: string;
|
|
3408
|
+
method: "GET";
|
|
3409
|
+
headers: {
|
|
3410
|
+
[x: string]: string;
|
|
3411
|
+
};
|
|
3412
|
+
expiresAt: string;
|
|
3413
|
+
};
|
|
3414
|
+
}[], 10000, undefined>]>;
|
|
3415
|
+
}, undefined>;
|
|
3416
|
+
readonly version: v.NullableSchema<v.ObjectSchema<{
|
|
3417
|
+
readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UuidAction<string, undefined>]>;
|
|
3418
|
+
readonly name: v.StringSchema<undefined>;
|
|
3419
|
+
readonly description: v.NullableSchema<v.StringSchema<undefined>, undefined>;
|
|
3420
|
+
readonly createdAt: v.StringSchema<undefined>;
|
|
3421
|
+
/** Whether the document holds this version now, with nothing changed since it was named. */
|
|
3422
|
+
readonly current: v.BooleanSchema<undefined>;
|
|
3423
|
+
}, undefined>, undefined>;
|
|
3424
|
+
}, undefined>;
|
|
3425
|
+
type CommunityDownload = v.InferOutput<typeof communityDownloadSchema>;
|
|
3426
|
+
//#endregion
|
|
2133
3427
|
//#region src/contract/reports.d.ts
|
|
2134
3428
|
/** Why someone reports a document shared with them. */
|
|
2135
3429
|
declare const documentReportReasonSchema: v.PicklistSchema<["spam-phishing", "illegal", "copyright", "harassment", "other"], undefined>;
|
|
@@ -2155,5 +3449,5 @@ declare const fileDocumentReportResponseSchema: v.ObjectSchema<{
|
|
|
2155
3449
|
readonly received: v.LiteralSchema<true, undefined>;
|
|
2156
3450
|
}, undefined>;
|
|
2157
3451
|
//#endregion
|
|
2158
|
-
export { AcceptDocumentInvitationInput, AcceptedInvitation, AccountSecurityErrorCode, AdminAuditEvent, AdminErrorCode, AdminOperations, CLOUD_API_MAX_BODY_BYTES, CLOUD_DISCOVERY_PATH, CLOUD_DOCUMENT_NAME_MAX_LENGTH, CLOUD_IMAGE_NAME_PATTERN, CLOUD_MAX_DOCUMENT_IMAGES, CLOUD_PICTURE_MAX_BYTES, CLOUD_PICTURE_SIZE, CLOUD_PORTAL_PAGE_ROOTS, CLOUD_PROTOCOL_MAX_UPLOAD_BYTES, CLOUD_PROTOCOL_VERSION, CLOUD_SERVICES_API_PATHS, CLOUD_SERVICES_CONTRACT_VERSION, CLOUD_SERVICES_JWKS_PATH, CLOUD_SERVICES_TOKEN_AUDIENCE, COLLAB_ACTIONS, ChatModel, CloudAccountDeletion, CloudAccountSession, CloudAccountStatus, CloudActorContract, CloudAdminAuditFilter, CloudAdminDocument, CloudAdminDocumentFilter, CloudAdminEmailFilter, CloudAdminReport, CloudAdminReportFilter, CloudAdminReportStatus, CloudAdminSessionResponse, CloudAdminUser, CloudAdminUserDetail, CloudAdminUserFilter, CloudAdminUsers, CloudAuthentication, CloudAuthenticationMethod, CloudAuthenticationMethods, CloudAuthenticationProvider, CloudBillingDiscovery, CloudCapabilities, CloudDeployment, CloudDiscovery, CloudLegalDiscovery, CloudLinkKind, CloudLinkPathKind, CloudListing, CloudPresence, CloudProfile, CloudServicesAPI, CloudServicesDiscovery, CloudServicesSchema, CloudSession, CloudSignIn, CloudSignInMethod, CloudUserProfile, CollaborationPrincipal, CollaborationTicket, CommitImageUploadsInput, CommitUploadInput, CommitUploadRequest, CreateDocumentInput, CreateDocumentInvitationInput, CreateDocumentRequest, CreateDocumentShareInput, CreateInvitationContinuationInput, CreateServicesTokenInput, CreateUploadInput, CreateWorkspaceInput, CreateWorkspaceInvitationInput, CreatedWorkspaceInvitation, CreditBucket, CreditWallet, DOCUMENT_REPORT_DESCRIPTION_MAX, DOCUMENT_VERSION_DESCRIPTION_MAX_LENGTH, DOCUMENT_VERSION_NAME_MAX_LENGTH, DocumentAccess, DocumentAccessSource, DocumentDownload, DocumentGrant, DocumentImageDownload, DocumentImageLink, DocumentInvitation, DocumentPermission, DocumentReportReason, DocumentShare, DocumentSummary, DocumentVersion, DocumentVersionDownload, DocumentVersionKind, DocumentVersions, DuplicateDocumentVersionInput, Enrollment, EnrollmentStatus, FileDocumentReportInput, ImageUploadOffer, InvitationContinuation, InvitationPreview, MAX_COLLAB_MESSAGE_BYTES, MAX_PRESENCE_NAME_LENGTH, MAX_SEARCH_QUERY_LENGTH, MAX_SEARCH_RESULTS, ObjectUploadTarget, PutDocumentGrantInput, RELAY_CLOSE, RELAY_DOCUMENT_PARAM, RELAY_FORWARDING_BYTES, RELAY_FRAGMENT_BYTES, RELAY_HEARTBEAT, RELAY_MINIMUM_MESSAGE_BYTES, RELAY_PATH, RELAY_SERVER_PEER, RelayAssembly, RelayClientFrame, RelayServerFrame, RequestImageLinksInput, RequestImageUploadsInput, RequestSharedImageLinksInput, ResolveDocumentShareInput, ResolvedDocumentShare, SERVICE_ERROR_STATUS, SaveDocumentVersionInput, SearchPricing, SearchRequest, SearchRequestInput, SearchResponse, SearchResult, ServiceCatalog, ServiceError, ServiceErrorCode, ServicesToken, ServicesTokenClaims, SharedDocument, TransactionalEmailAdmin, TrashedDocument, UpdateDocumentShareInput, UpdateDocumentVersionInput, UpdateWorkspaceInput, UpdateWorkspaceMemberInput, UsageEntry, UsagePage, UsageQuery, WorkspaceEntitlements, WorkspaceInvitation, WorkspaceList, WorkspaceMember, WorkspaceMembers, WorkspaceRole, WorkspaceSummary, WorkspaceUsage, acceptDocumentInvitationSchema, acceptedInvitationSchema, accountSecurityErrorCodeSchema, accountSecurityErrorResponseSchema, adminAuditEventSchema, adminAuditResponseSchema, adminEmailResponseSchema, adminErrorCodeSchema, adminErrorResponseSchema, adminMutationResponseSchema, adminOperationsResponseSchema, chatModelSchema, cloudAccountDeleteSchema, cloudAccountDeletionDocumentSchema, cloudAccountDeletionResponseSchema, cloudAccountDeletionSchema, cloudAccountDeletionWorkspaceSchema, cloudAccountMutationResponseSchema, cloudAccountSessionSchema, cloudAccountSessionsResponseSchema, cloudAccountStateSchema, cloudAccountStatusResponseSchema, cloudActorSchema, cloudAdminAuditFilterSchema, cloudAdminDocumentFilterSchema, cloudAdminDocumentSchema, cloudAdminDocumentsResponseSchema, cloudAdminEmailFilterSchema, cloudAdminReportFilterSchema, cloudAdminReportSchema, cloudAdminReportStatusSchema, cloudAdminReportsResponseSchema, cloudAdminSessionResponseSchema, cloudAdminUserDetailSchema, cloudAdminUserFilterSchema, cloudAdminUserSchema, cloudAdminUsersResponseSchema, cloudAuthenticationMethodSchema, cloudAuthenticationMethodsResponseSchema, cloudAuthenticationProviderSchema, cloudAuthenticationSchema, cloudBillingDiscoverySchema, cloudCapabilitiesSchema, cloudDeploymentSchema, cloudDesktopLinkURL, cloudDiscoverySchema, cloudDocumentPath, cloudDocumentURL, cloudEditorVersionSchema, cloudEmailChangeSchema, cloudIdentitySchema, cloudInvitationURL, cloudLegalDiscoverySchema, cloudListingSchema, cloudMFAEnableResponseSchema, cloudMFAEnableSchema, cloudMFARecoveryCodesResponseSchema, cloudMFAStatusResponseSchema, cloudMFAStatusSchema, cloudMFAVerifyResponseSchema, cloudMFAVerifySchema, cloudPasskeyDeleteSchema, cloudPasskeySchema, cloudPasskeysResponseSchema, cloudPasswordChangeSchema, cloudPersonSchema, cloudPictureResponseSchema, cloudPictureUploadSchema, cloudPresenceSchema, cloudProfileResponseSchema, cloudProfileSchema, cloudProfileUpdateSchema, cloudServerOrigin, cloudServicesDiscoverySchema, cloudSessionRevokeSchema, cloudSessionSchema, cloudShareURL, cloudSignInMethodSchema, cloudSignInSchema, cloudSignInsResponseSchema, cloudSocialLinkResponseSchema, cloudSocialLinkSchema, cloudTermsAcceptanceSchema, cloudUnlinkAuthenticationMethodSchema, cloudUserProfileSchema, collaborationPrincipalSchema, collaborationTicketSchema, commitImageUploadsSchema, commitUploadSchema, createDocumentInvitationSchema, createDocumentSchema, createDocumentShareSchema, createInvitationContinuationSchema, createRelayClientAssembler, createRelayServerAssembler, createServicesTokenSchema, createUploadSchema, createWorkspaceInvitationSchema, createWorkspaceSchema, createdWorkspaceInvitationSchema, creditBucketSchema, creditWalletSchema, decodeRelayClientFrame, decodeRelayServerFrame, decodeRoomUpdate, defaultRelayURL, documentAccessSchema, documentAccessSourceSchema, documentDownloadSchema, documentGrantSchema, documentImageDownloadSchema, documentImageLinkSchema, documentInvitationSchema, documentPermissionSchema, documentReportReasonSchema, documentShareSchema, documentSummarySchema, documentVersionDownloadSchema, documentVersionKindSchema, documentVersionResponseSchema, documentVersionSchema, documentVersionsSchema, duplicateDocumentVersionSchema, encodeRelayClientFrame, encodeRelayServerFrame, encodeSyncReply, enrollmentReviewResponseSchema, enrollmentSchema, enrollmentStatusSchema, enrollmentsResponseSchema, fileDocumentReportResponseSchema, fileDocumentReportSchema, imageUploadOfferSchema, invitationContinuationSchema, invitationPreviewSchema, isCloudChecksum, isCloudPortalPage, objectUploadSchema, parseAcceptDocumentInvitation, parseCloudAccountDelete, parseCloudDiscovery, parseCloudEmailChange, parseCloudLinkPath, parseCloudMFAEnable, parseCloudMFAVerify, parseCloudPasskeyDelete, parseCloudPasswordChange, parseCloudPictureUpload, parseCloudProfileUpdate, parseCloudSessionRevoke, parseCloudSocialLink, parseCloudTermsAcceptance, parseCloudUnlinkAuthenticationMethod, parseCommitImageUploads, parseCommitUpload, parseCreateDocument, parseCreateDocumentInvitation, parseCreateDocumentShare, parseCreateInvitationContinuation, parseCreateServicesToken, parseCreateUpload, parseCreateWorkspace, parseCreateWorkspaceInvitation, parseDuplicateDocumentVersion, parseFileDocumentReport, parsePutDocumentGrant, parseRequestImageLinks, parseRequestImageUploads, parseRequestSharedImageLinks, parseResolveDocumentShare, parseSaveDocumentVersion, parseSearchRequest, parseUpdateDocumentShare, parseUpdateDocumentVersion, parseUpdateWorkspace, parseUpdateWorkspaceMember, parseUsageQuery, presenceName, putDocumentGrantSchema, relayClientMessages, relayServerMessages, requestImageLinksSchema, requestImageUploadsSchema, requestSharedImageLinksSchema, resolveDocumentShareSchema, resolvedDocumentShareSchema, restoredDocumentSchema, saveDocumentVersionSchema, searchPricingSchema, searchRequestSchema, searchResponseSchema, searchResultSchema, serviceCatalogSchema, serviceErrorCodeSchema, serviceErrorSchema, servicesTokenClaimsSchema, servicesTokenSchema, sharedDocumentSchema, transactionalEmailAdminSchema, trashSchema, trashedDocumentSchema, updateDocumentShareSchema, updateDocumentVersionSchema, updateWorkspaceMemberSchema, updateWorkspaceSchema, usageEntrySchema, usagePageSchema, usageQuerySchema, workspaceEntitlementsSchema, workspaceInvitationSchema, workspaceListSchema, workspaceMemberSchema, workspaceMembersSchema, workspaceRoleSchema, workspaceSummarySchema, workspaceUsageSchema };
|
|
3452
|
+
export { AcceptDocumentInvitationInput, AcceptedInvitation, AccountEntitlements, AccountSecurityErrorCode, AdminAuditEvent, AdminErrorCode, AdminOperations, BILLING_ERROR_STATUS, BillingAccount, BillingCatalog, BillingError, BillingErrorCode, BillingFreePlan, BillingPlan, BillingRedirect, BillingSeatPricing, BillingToken, BillingTokenClaims, CLOUD_ACCESS_TOKEN_MAX_DAYS, CLOUD_ACCESS_TOKEN_NAME_MAX_LENGTH, CLOUD_ACCESS_TOKEN_PREFIX, CLOUD_ACCOUNT_BILLING_PATH, CLOUD_ACCOUNT_PLAN_PATH, CLOUD_API_MAX_BODY_BYTES, CLOUD_BILLING_API_PATHS, CLOUD_BILLING_CONTRACT_VERSION, CLOUD_BILLING_PAGE_PATHS, CLOUD_BILLING_TOKEN_AUDIENCE, CLOUD_COMMUNITY_PATH, CLOUD_DISCOVERY_PATH, CLOUD_DOCUMENT_NAME_MAX_LENGTH, CLOUD_EDITOR_VERSION_HEADER, CLOUD_IMAGE_NAME_PATTERN, CLOUD_MAX_DOCUMENT_IMAGES, CLOUD_PICTURE_MAX_BYTES, CLOUD_PICTURE_SIZE, CLOUD_PORTAL_COMMUNITY_PAGES, CLOUD_PORTAL_PAGE_ROOTS, CLOUD_PROTOCOL_MAX_UPLOAD_BYTES, CLOUD_PROTOCOL_VERSION, CLOUD_SERVICES_API_PATHS, CLOUD_SERVICES_CONTRACT_VERSION, CLOUD_SERVICES_JWKS_PATH, CLOUD_SERVICES_TOKEN_AUDIENCE, CLOUD_SOCIAL_PROVIDERS, CLOUD_SOCIAL_PROVIDER_NAMES, COLLAB_ACTIONS, COMMENT_BODY_MAX_LENGTH, COMMENT_NAME_MAX_LENGTH, COMMUNITY_THUMBNAIL_PATH, ChatModel, CheckoutRequest, CloudAccessToken, CloudAccessTokenCreate, CloudAccountDeletion, CloudAccountSession, CloudAccountStatus, CloudActorContract, CloudAdminAuditFilter, CloudAdminDocument, CloudAdminDocumentFilter, CloudAdminEmailFilter, CloudAdminReport, CloudAdminReportFilter, CloudAdminReportStatus, CloudAdminSessionResponse, CloudAdminUser, CloudAdminUserDetail, CloudAdminUserFilter, CloudAdminUserMethod, CloudAdminUsers, CloudAuthentication, CloudAuthenticationMethod, CloudAuthenticationMethods, CloudAuthenticationProvider, CloudBillingAPI, CloudBillingDiscovery, CloudBillingSchema, CloudBranding, CloudCapabilities, CloudComment, CloudCommentThread, CloudCommunityDiscovery, CloudDeployment, CloudDiscovery, CloudLegalDiscovery, CloudLinkKind, CloudLinkPathKind, CloudListing, CloudPresence, CloudProfile, CloudServicesAPI, CloudServicesDiscovery, CloudServicesSchema, CloudSession, CloudSignIn, CloudSignInMethod, CloudSocialProvider, CloudUserProfile, CollaborationPrincipal, CollaborationTicket, CommentAccess, CommentAnchor, CommentAuthor, CommentEmailSetting, CommentPerson, CommentThreads, CommitImageUploadsInput, CommitUploadInput, CommitUploadRequest, CommunityDocument, CommunityDocuments, CommunityDownload, CommunityDownloadQuery, CommunityVersion, CreateCommentInput, CreateCommentThreadInput, CreateDocumentInput, CreateDocumentInvitationInput, CreateDocumentRequest, CreateDocumentShareInput, CreateInvitationContinuationInput, CreateServicesTokenInput, CreateUploadInput, CreateWorkspaceInput, CreateWorkspaceInvitationInput, CreatedWorkspaceInvitation, CreditBucket, CreditPack, CreditWallet, DOCUMENT_REPORT_DESCRIPTION_MAX, DOCUMENT_VERSION_DESCRIPTION_MAX_LENGTH, DOCUMENT_VERSION_NAME_MAX_LENGTH, DocumentAccess, DocumentAccessSource, DocumentDownload, DocumentGrant, DocumentImageDownload, DocumentImageLink, DocumentInvitation, DocumentPermission, DocumentReportReason, DocumentShare, DocumentSummary, DocumentVersion, DocumentVersionDownload, DocumentVersionKind, DocumentVersions, DuplicateDocumentVersionInput, Enrollment, EnrollmentStatus, FileDocumentReportInput, ImageUploadOffer, ImportCommentThreadsInput, InvitationContinuation, InvitationPreview, MAX_COLLAB_MESSAGE_BYTES, MAX_COMMENTS_PER_THREAD, MAX_COMMENT_AGENT_LENGTH, MAX_COMMENT_MENTIONS, MAX_COMMENT_THREADS_PER_DOCUMENT, MAX_IMPORTED_COMMENTS, MAX_IMPORTED_COMMENT_THREADS, MAX_PRESENCE_NAME_LENGTH, MAX_SEARCH_QUERY_LENGTH, MAX_SEARCH_RESULTS, NotificationSettings, ObjectUploadTarget, PutDocumentGrantInput, RELAY_CLOSE, RELAY_DOCUMENT_PARAM, RELAY_FORWARDING_BYTES, RELAY_FRAGMENT_BYTES, RELAY_HEARTBEAT, RELAY_MINIMUM_MESSAGE_BYTES, RELAY_PATH, RELAY_SERVER_PEER, RelayAssembly, RelayClientFrame, RelayServerFrame, RequestImageLinksInput, RequestImageUploadsInput, RequestSharedImageLinksInput, ResolveDocumentShareInput, ResolvedDocumentShare, RoleModels, SERVICE_ERROR_STATUS, SaveDocumentVersionInput, SearchPricing, SearchRequest, SearchRequestInput, SearchResponse, SearchResult, ServiceCatalog, ServiceError, ServiceErrorCode, ServicesToken, ServicesTokenClaims, SharedCommentsRequest, SharedDocument, TransactionalEmailAdmin, TrashedDocument, UpdateCommentInput, UpdateCommentThreadInput, UpdateDocumentShareInput, UpdateDocumentVersionInput, UpdateWorkspaceInput, UpdateWorkspaceMemberInput, UsageEntry, UsagePage, UsageQuery, WorkspaceEntitlements, WorkspaceInvitation, WorkspaceList, WorkspaceMember, WorkspaceMembers, WorkspaceRole, WorkspaceSummary, WorkspaceUsage, acceptDocumentInvitationSchema, acceptedInvitationSchema, accountEntitlementsResponseSchema, accountEntitlementsSchema, accountSecurityErrorCodeSchema, accountSecurityErrorResponseSchema, adminAuditEventSchema, adminAuditResponseSchema, adminEmailResponseSchema, adminErrorCodeSchema, adminErrorResponseSchema, adminMutationResponseSchema, adminOperationsResponseSchema, billingAccountSchema, billingCatalogSchema, billingErrorCodeSchema, billingErrorSchema, billingFreePlanSchema, billingPlanSchema, billingRedirectSchema, billingSeatPricingSchema, billingTokenClaimsSchema, billingTokenSchema, chatModelSchema, checkoutRequestSchema, cloudAccessTokenCreateSchema, cloudAccessTokenCreatedResponseSchema, cloudAccessTokenRevokeSchema, cloudAccessTokenSchema, cloudAccessTokensResponseSchema, cloudAccountDeleteSchema, cloudAccountDeletionDocumentSchema, cloudAccountDeletionResponseSchema, cloudAccountDeletionSchema, cloudAccountDeletionWorkspaceSchema, cloudAccountMutationResponseSchema, cloudAccountSessionSchema, cloudAccountSessionsResponseSchema, cloudAccountStateSchema, cloudAccountStatusResponseSchema, cloudActorSchema, cloudAdminAuditFilterSchema, cloudAdminDocumentFilterSchema, cloudAdminDocumentSchema, cloudAdminDocumentsResponseSchema, cloudAdminEmailFilterSchema, cloudAdminReportFilterSchema, cloudAdminReportSchema, cloudAdminReportStatusSchema, cloudAdminReportsResponseSchema, cloudAdminSessionResponseSchema, cloudAdminUserDetailSchema, cloudAdminUserFilterSchema, cloudAdminUserMethodSchema, cloudAdminUserSchema, cloudAdminUsersResponseSchema, cloudAuthenticationMethodSchema, cloudAuthenticationMethodsResponseSchema, cloudAuthenticationProviderSchema, cloudAuthenticationSchema, cloudBillingDiscoverySchema, cloudBrandingSchema, cloudCapabilitiesSchema, cloudCommentSchema, cloudCommentThreadSchema, cloudCommentURL, cloudCommunityDesktopLinkURL, cloudCommunityDiscoverySchema, cloudCommunityPagePath, cloudCommunityPath, cloudCommunityURL, cloudDeploymentSchema, cloudDesktopLinkURL, cloudDiscoverySchema, cloudDocumentPath, cloudDocumentURL, cloudEditorVersionSchema, cloudEmailChangeSchema, cloudIdentitySchema, cloudInvitationURL, cloudLanguageTagSchema, cloudLegalDiscoverySchema, cloudListingSchema, cloudLocaleUpdateSchema, cloudMFAEnableResponseSchema, cloudMFAEnableSchema, cloudMFARecoveryCodesResponseSchema, cloudMFAStatusResponseSchema, cloudMFAStatusSchema, cloudMFAVerifyResponseSchema, cloudMFAVerifySchema, cloudPasskeyDeleteSchema, cloudPasskeySchema, cloudPasskeysResponseSchema, cloudPasswordChangeSchema, cloudPersonSchema, cloudPictureResponseSchema, cloudPictureUploadSchema, cloudPresenceSchema, cloudProfileResponseSchema, cloudProfileSchema, cloudProfileUpdateSchema, cloudServerOrigin, cloudServicesDiscoverySchema, cloudSessionRevokeSchema, cloudSessionSchema, cloudShareURL, cloudSignInMethodSchema, cloudSignInSchema, cloudSignInsResponseSchema, cloudSocialLinkResponseSchema, cloudSocialLinkSchema, cloudSocialProviderSchema, cloudTermsAcceptanceSchema, cloudUnlinkAuthenticationMethodSchema, cloudUserProfileSchema, collaborationPrincipalSchema, collaborationTicketSchema, commentAccessSchema, commentAnchorSchema, commentAuthorSchema, commentEmailSettingSchema, commentPeopleSchema, commentPersonSchema, commentThreadResponseSchema, commentThreadsSchema, commitImageUploadsSchema, commitUploadSchema, communityDocumentSchema, communityDocumentsSchema, communityDownloadQuerySchema, communityDownloadSchema, communityThumbnailPath, communityVersionSchema, createCommentSchema, createCommentThreadSchema, createDocumentInvitationSchema, createDocumentSchema, createDocumentShareSchema, createInvitationContinuationSchema, createRelayClientAssembler, createRelayServerAssembler, createServicesTokenSchema, createUploadSchema, createWorkspaceInvitationSchema, createWorkspaceSchema, createdWorkspaceInvitationSchema, creditBucketSchema, creditPackSchema, creditWalletSchema, decodeRelayClientFrame, decodeRelayServerFrame, decodeRoomUpdate, defaultRelayURL, documentAccessSchema, documentAccessSourceSchema, documentDownloadSchema, documentGrantSchema, documentImageDownloadSchema, documentImageLinkSchema, documentInvitationSchema, documentPermissionSchema, documentReportReasonSchema, documentShareSchema, documentSummarySchema, documentVersionDownloadSchema, documentVersionKindSchema, documentVersionResponseSchema, documentVersionSchema, documentVersionsSchema, duplicateDocumentVersionSchema, encodeRelayClientFrame, encodeRelayServerFrame, encodeSyncReply, enrollmentInviteResponseSchema, enrollmentReviewResponseSchema, enrollmentSchema, enrollmentStatusSchema, enrollmentsResponseSchema, fileDocumentReportResponseSchema, fileDocumentReportSchema, imageUploadOfferSchema, importCommentThreadsSchema, invitationContinuationSchema, invitationPreviewSchema, isCloudChecksum, isCloudPortalPage, isEditorVersionAtLeast, isKnownAuthenticationProvider, isKnownSocialProvider, notificationSettingsSchema, objectUploadSchema, parseAcceptDocumentInvitation, parseCloudAccessTokenCreate, parseCloudAccessTokenRevoke, parseCloudAccountDelete, parseCloudDiscovery, parseCloudEmailChange, parseCloudLinkPath, parseCloudLocaleUpdate, parseCloudMFAEnable, parseCloudMFAVerify, parseCloudPasskeyDelete, parseCloudPasswordChange, parseCloudPictureUpload, parseCloudProfileUpdate, parseCloudSessionRevoke, parseCloudSocialLink, parseCloudTermsAcceptance, parseCloudUnlinkAuthenticationMethod, parseCommitImageUploads, parseCommitUpload, parseCommunityDownloadQuery, parseCreateDocument, parseCreateDocumentInvitation, parseCreateDocumentShare, parseCreateInvitationContinuation, parseCreateServicesToken, parseCreateUpload, parseCreateWorkspace, parseCreateWorkspaceInvitation, parseDuplicateDocumentVersion, parseFileDocumentReport, parsePutDocumentGrant, parseRequestImageLinks, parseRequestImageUploads, parseRequestSharedImageLinks, parseResolveDocumentShare, parseSaveDocumentVersion, parseSearchRequest, parseUpdateDocumentShare, parseUpdateDocumentVersion, parseUpdateWorkspace, parseUpdateWorkspaceMember, parseUsageQuery, presenceName, putDocumentGrantSchema, relayClientMessages, relayServerMessages, requestImageLinksSchema, requestImageUploadsSchema, requestSharedImageLinksSchema, resolveDocumentShareSchema, resolvedDocumentShareSchema, restoredDocumentSchema, roleModelsSchema, saveDocumentVersionSchema, searchPricingSchema, searchRequestSchema, searchResponseSchema, searchResultSchema, sendsTokenSafely, serviceCatalogSchema, serviceErrorCodeSchema, serviceErrorSchema, servicesTokenClaimsSchema, servicesTokenSchema, sharedCommentsRequestSchema, sharedCreateCommentSchema, sharedCreateCommentThreadSchema, sharedDocumentSchema, sharedUpdateCommentSchema, sharedUpdateCommentThreadSchema, transactionalEmailAdminSchema, trashSchema, trashedDocumentSchema, updateCommentSchema, updateCommentThreadSchema, updateDocumentShareSchema, updateDocumentVersionSchema, updateWorkspaceMemberSchema, updateWorkspaceSchema, usageEntrySchema, usagePageSchema, usageQuerySchema, workspaceEntitlementsSchema, workspaceInvitationSchema, workspaceListSchema, workspaceMemberSchema, workspaceMembersSchema, workspaceRoleSchema, workspaceSummarySchema, workspaceUsageSchema };
|
|
2159
3453
|
//# sourceMappingURL=index.d.ts.map
|