Skip to content

AI-native design editor. Open-source Figma alternative.

3.1 KB
Raw Blame
import * as v from 'valibot'

import { cloudAIDiscoverySchema, cloudBillingDiscoverySchema } from './ai'

export const CLOUD_PROTOCOL_VERSION = '1' as const
export const CLOUD_DISCOVERY_PATH = '/.well-known/openpencil' as const

export const cloudDeploymentSchema = v.picklist(['official', 'self-hosted'])
export type CloudDeployment = v.InferOutput<typeof cloudDeploymentSchema>

export const cloudAuthenticationSchema = v.object({
  emailPassword: v.optional(
    v.object({
      signIn: v.boolean(),
      signUp: v.boolean(),
      minimumPasswordLength: v.pipe(v.number(), v.integer(), v.minValue(8)),
      captcha: v.optional(
        v.object({
          provider: v.literal('cloudflare-turnstile'),
          siteKey: v.pipe(v.string(), v.trim(), v.minLength(1))
        })
      )
    })
  ),
  socialProviders: v.array(v.picklist(['apple', 'google'])),
  enterpriseSSO: v.boolean(),
  enrollmentMode: v.optional(v.picklist(['open', 'approval', 'closed']), 'open'),
  mfa: v.optional(
    v.object({
      deploymentAdminRequired: v.boolean(),
      totp: v.boolean(),
      passkeys: v.boolean(),
      recoveryCodes: v.boolean()
    })
  )
})
export type CloudAuthentication = v.InferOutput<typeof cloudAuthenticationSchema>

export const cloudCapabilitiesSchema = v.object({
  documents: v.boolean(),
  workspaces: v.boolean(),
  collaboration: v.boolean()
})
export type CloudCapabilities = v.InferOutput<typeof cloudCapabilitiesSchema>

/** A released editor version, `major.minor.patch`. */
export const cloudEditorVersionSchema = v.pipe(v.string(), v.regex(/^\d+\.\d+\.\d+$/))

/**
 * Whether editors offer this server to everyone, and from which editor version on. Only the
 * official server's listing is read: it turns the Cloud entry points on without an editor release,
 * and an editor older than the minimum keeps them hidden.
 */
export const cloudListingSchema = v.object({ minimumEditorVersion: cloudEditorVersionSchema })
export type CloudListing = v.InferOutput<typeof cloudListingSchema>

export const cloudDiscoverySchema = v.object({
  protocolVersion: v.literal(CLOUD_PROTOCOL_VERSION),
  deployment: cloudDeploymentSchema,
  apiURL: v.pipe(v.string(), v.url()),
  authURL: v.pipe(v.string(), v.url()),
  /** Whether the server's own editor works with files on this device without signing in. */
  localEditor: v.optional(v.boolean(), true),
  authentication: cloudAuthenticationSchema,
  capabilities: cloudCapabilitiesSchema,
  listing: v.optional(cloudListingSchema),
  /** The AI service editors reach with Cloud-signed tokens; absent when the deployment has none. */
  ai: v.optional(cloudAIDiscoverySchema),
  /** Where people manage their plan and buy credits; absent when the deployment does not bill. */
  billing: v.optional(cloudBillingDiscoverySchema)
})
export type CloudDiscovery = v.InferOutput<typeof cloudDiscoverySchema>

/** The server's own address, where its editor and pages are, from its auth API's. */
export function cloudServerOrigin(discovery: CloudDiscovery): string {
  return new URL(discovery.authURL).origin
}

export function parseCloudDiscovery(input: unknown): CloudDiscovery {
  return v.parse(cloudDiscoverySchema, input)
}