@scalar/workspace-store 0.1.0

package/src/schemas/reference.ts

@@ -0,0 +1,18 @@
+import { Type } from '@sinclair/typebox'
+
+/**
+ * A simple object to allow referencing other components in the OpenAPI Description, internally and externally.
+ *
+ * The $ref string value contains a URI RFC3986, which identifies the value being referenced.
+ *
+ * See the rules for resolving Relative References. */
+export const ReferenceObject = Type.Object({
+  /** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
+  '$ref': Type.String(),
+  /** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
+  '$status': Type.Optional(Type.Union([Type.Literal('loading'), Type.Literal('error')])),
+  /** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */
+  summary: Type.Optional(Type.String()),
+  /** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */
+  description: Type.Optional(Type.String()),
+})

package/src/schemas/request-body.ts

@@ -0,0 +1,12 @@
+import { Type } from '@sinclair/typebox'
+import { MediaTypeObject } from './media-type'
+
+/** Describes a single request body. */
+export const RequestBodyObject = Type.Object({
+  /** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
+  description: Type.Optional(Type.String()),
+  /** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/* */
+  content: Type.Record(Type.String(), MediaTypeObject),
+  /** Determines if the request body is required in the request. Defaults to false. */
+  required: Type.Optional(Type.Boolean()),
+})

package/src/schemas/response.ts

@@ -0,0 +1,16 @@
+import { Type } from '@sinclair/typebox'
+import { HeaderObject } from './header'
+import { ReferenceObject } from './reference'
+import { MediaTypeObject } from './media-type'
+import { LinkObject } from './link'
+
+export const ResponseObject = Type.Object({
+  /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */
+  description: Type.String(),
+  /** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored. */
+  headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObject, ReferenceObject]))),
+  /** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/*"  */
+  content: Type.Optional(Type.Record(Type.String(), MediaTypeObject)),
+  /** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */
+  links: Type.Optional(Type.Record(Type.String(), Type.Union([LinkObject, ReferenceObject]))),
+})

package/src/schemas/responses.ts

@@ -0,0 +1,14 @@
+import { Type } from '@sinclair/typebox'
+import { ReferenceObject } from './reference'
+import { ResponseObject } from './response'
+
+/**
+ * A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
+ *
+ * The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.
+ *
+ * The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.
+ *
+ * The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.
+ */
+export const ResponsesObject = Type.Record(Type.String(), Type.Union([ResponseObject, ReferenceObject]))

package/src/schemas/schema.ts

@@ -0,0 +1,26 @@
+import { Type } from '@sinclair/typebox'
+import { DiscriminatorObject } from './discriminator'
+import { XMLObject } from './xml'
+import { ExternalDocumentationObject } from './external-documentation'
+
+/**
+ * The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 2020-12. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
+ *
+ * For more information about the keywords, see JSON Schema Core and JSON Schema Validation.
+ *
+ * Unless stated otherwise, the keyword definitions follow those of JSON Schema and do not add any additional semantics; this includes keywords such as $schema, $id, $ref, and $dynamicRef being URIs rather than URLs. Where JSON Schema indicates that behavior is defined by the application (e.g. for annotations), OAS also defers the definition of semantics to the application consuming the OpenAPI document.
+ */
+export const SchemaObject = Type.Object({
+  /** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
+  discriminator: Type.Optional(DiscriminatorObject),
+  /** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
+  xml: Type.Optional(XMLObject),
+  /** Additional external documentation for this schema. */
+  externalDocs: Type.Optional(ExternalDocumentationObject),
+  /**
+   * A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
+   *
+   * Deprecated: The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
+   */
+  example: Type.Optional(Type.Any()),
+})

package/src/schemas/security-requirement.ts

@@ -0,0 +1,16 @@
+import { Type } from '@sinclair/typebox'
+
+/**
+ * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.
+ *
+ * A Security Requirement Object MAY refer to multiple security schemes in which case all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.
+ *
+ * When the security field is defined on the OpenAPI Object or Operation Object and contains multiple Security Requirement Objects, only one of the entries in the list needs to be satisfied to authorize the request. This enables support for scenarios where the API allows multiple, independent security schemes.
+ *
+ * An empty Security Requirement Object ({}) indicates anonymous access is supported.
+ */
+export const SecurityRequirementObject = Type.Record(
+  Type.String(),
+  /** Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. */
+  Type.Array(Type.String()),
+)

package/src/schemas/security-scheme.ts

@@ -0,0 +1,58 @@
+import { Type } from '@sinclair/typebox'
+import { OAuthFlowsObject } from './oauthflows'
+
+export const DescriptionSchema = Type.Object({
+  /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
+  description: Type.Optional(Type.String()),
+})
+
+export const ApiKeySchema = Type.Intersect([
+  DescriptionSchema,
+  Type.Object({
+    /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
+    type: Type.Literal('apiKey'),
+    /** REQUIRED. The name of the header, query or cookie parameter to be used. */
+    name: Type.String(),
+    /** REQUIRED. The location of the API key. Valid values are "query", "header", or "cookie". */
+    in: Type.String(),
+  }),
+])
+
+export const HttpSchema = Type.Intersect([
+  DescriptionSchema,
+  Type.Object({
+    /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
+    type: Type.Literal('http'),
+    /** REQUIRED. The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235. */
+    scheme: Type.String(),
+    /** A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. */
+    bearerFormat: Type.Optional(Type.String()),
+  }),
+])
+
+export const OAuth2 = Type.Intersect([
+  DescriptionSchema,
+  Type.Object({
+    /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
+    type: Type.Literal('oauth2'),
+    /** REQUIRED. An object containing configuration information for the flow types supported. */
+    flows: OAuthFlowsObject,
+  }),
+])
+
+export const OpenIdConnect = Type.Intersect([
+  DescriptionSchema,
+  Type.Object({
+    /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect". */
+    type: Type.Literal('openIdConnect'),
+    /** REQUIRED. Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata. */
+    openIdConnectUrl: Type.String(),
+  }),
+])
+
+/**
+ * Defines a security scheme that can be used by the operations.
+ *
+ * Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and [[OpenID-Connect-Core]]. Please note that as of 2020, the implicit flow is about to be deprecated by OAuth 2.0 Security Best Current Practice. Recommended for most use cases is Authorization Code Grant flow with PKCE.
+ */
+export const SecuritySchemeObject = Type.Union([ApiKeySchema, HttpSchema, OAuth2, OpenIdConnect])

package/src/schemas/server-variable.ts

@@ -0,0 +1,11 @@
+import { Type } from '@sinclair/typebox'
+
+/** An object representing a Server Variable for server URL template substitution. */
+export const ServerVariableObject = Type.Object({
+  /** An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. */
+  enum: Type.Optional(Type.Array(Type.String())),
+  /** REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. If the enum is defined, the value MUST exist in the enum's values. Note that this behavior is different from the Schema Object's default keyword, which documents the receiver's behavior rather than inserting the value into the data. */
+  default: Type.Optional(Type.String()),
+  /** An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. */
+  description: Type.Optional(Type.String()),
+})

package/src/schemas/server-workspace.ts

@@ -0,0 +1,36 @@
+import { type Static, Type } from '@sinclair/typebox'
+import { OpenAPIDocumentSchema } from './openapi-document'
+
+const WorkspaceDocumentMetaSchema = Type.Partial(
+  Type.Object({
+    'x-scalar-active-auth': Type.String(),
+    'x-scalar-active-server': Type.String(),
+  }),
+)
+
+export type WorkspaceDocumentMeta = Static<typeof WorkspaceDocumentMetaSchema>
+
+export const WorkspaceDocumentSchema = Type.Intersect([WorkspaceDocumentMetaSchema, OpenAPIDocumentSchema])
+
+export type WorkspaceDocument = Static<typeof WorkspaceDocumentSchema>
+
+const WorkspaceMetaSchema = Type.Partial(
+  Type.Object({
+    'x-scalar-dark-mode': Type.Boolean(),
+    'x-scalar-default-client': Type.String(),
+    'x-scalar-active-document': Type.String(),
+    'x-scalar-theme': Type.String(),
+  }),
+)
+
+export type WorkspaceMeta = Static<typeof WorkspaceMetaSchema>
+
+export const WorkspaceSchema = Type.Intersect([
+  WorkspaceMetaSchema,
+  Type.Object({
+    documents: Type.Record(Type.String(), Type.Partial(WorkspaceDocumentSchema)),
+    activeDocument: Type.Partial(WorkspaceDocumentSchema),
+  }),
+])
+
+export type Workspace = Static<typeof WorkspaceSchema>

package/src/schemas/server.ts

@@ -0,0 +1,12 @@
+import { Type } from '@sinclair/typebox'
+import { ServerVariableObject } from './server-variable'
+
+/** An object representing a Server. */
+export const ServerObject = Type.Object({
+  /** REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in {braces}. */
+  url: Type.String(),
+  /** An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation. */
+  description: Type.Optional(Type.String()),
+  /** A map between a variable name and its value. The value is used for substitution in the server's URL template. */
+  variables: Type.Optional(Type.Record(Type.String(), ServerVariableObject)),
+})

package/src/schemas/tag.ts

@@ -0,0 +1,12 @@
+import { Type } from '@sinclair/typebox'
+import { ExternalDocumentationObject } from './external-documentation'
+
+/** Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. */
+export const TagObject = Type.Object({
+  /** REQUIRED. The name of the tag. */
+  name: Type.String(),
+  /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
+  description: Type.Optional(Type.String()),
+  /** Additional external documentation for this tag. */
+  externalDocs: Type.Optional(ExternalDocumentationObject),
+})

package/src/schemas/xml.ts

@@ -0,0 +1,19 @@
+import { Type } from '@sinclair/typebox'
+
+/**
+ * A metadata object that allows for more fine-tuned XML model definitions.
+ *
+ * When using arrays, XML element names are not inferred (for singular/plural forms) and the name field SHOULD be used to add that information. See examples for expected behavior.
+ */
+export const XMLObject = Type.Object({
+  /** Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being "array" (outside the items), it will affect the wrapping element if and only if wrapped is true. If wrapped is false, it will be ignored. */
+  name: Type.Optional(Type.String()),
+  /** The URI of the namespace definition. Value MUST be in the form of a non-relative URI. */
+  namespace: Type.Optional(Type.String()),
+  /** The prefix to be used for the name. */
+  prefix: Type.Optional(Type.String()),
+  /** Declares whether the property definition translates to an attribute instead of an element. Default value is false. */
+  attribute: Type.Optional(Type.Boolean()),
+  /** MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>). Default value is false. The definition takes effect only when defined alongside type being "array" (outside the items). */
+  wrapped: Type.Optional(Type.Boolean()),
+})

package/test/helpers.ts

@@ -0,0 +1,16 @@
+import fs from 'node:fs/promises'
+
+export async function allFilesMatch(fileList: { path: string; content: string }[]): Promise<boolean> {
+  for (const { content, path } of fileList) {
+    try {
+      const actualContent = await fs.readFile(path, 'utf8')
+      if (actualContent !== content) {
+        return false
+      }
+    } catch {
+      // If file doesn't exist or any other read error
+      return false
+    }
+  }
+  return true
+}

package/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src"],
+  "exclude": ["**/*.test.ts", "**/*.test-d.ts"],
+  "compilerOptions": {
+    "skipLibCheck": true,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "dist/"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}

package/vite.config.ts

@@ -0,0 +1,9 @@
+import { alias } from '@scalar/build-tooling'
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  plugins: [],
+  resolve: {
+    alias: alias(import.meta.url),
+  },
+})