@scalar/workspace-store 0.40.2 → 0.40.4

package/dist/schemas/v3.1/strict/link.js

@@ -1,20 +1,23 @@
-import { Type } from "@scalar/typebox";
-import { ServerObjectRef } from "../../../schemas/v3.1/strict/ref-definitions.js";
-const LinkObjectSchemaDefinition = Type.Object({
-  /** A URI reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI Description. */
-  operationRef: Type.Optional(Type.String()),
-  /** The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. */
-  operationId: Type.Optional(Type.String()),
-  /** A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. path.id for an id parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. */
-  parameters: Type.Optional(Type.Record(Type.String(), Type.Any())),
-  /** A literal value or {expression} to use as a request body when calling the target operation. */
-  requestBody: Type.Optional(Type.Any()),
-  /** A description of the link. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String()),
-  /** A server object to be used by the target operation. */
-  server: Type.Optional(ServerObjectRef)
+import { Type } from '@scalar/typebox';
+import { ServerObjectRef } from '../../../schemas/v3.1/strict/ref-definitions.js';
+/**
+ * The Link Object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
+ *
+ * Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.
+ *
+ * For computing links and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.
+ */
+export const LinkObjectSchemaDefinition = Type.Object({
+    /** A URI reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI Description. */
+    operationRef: Type.Optional(Type.String()),
+    /** The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. */
+    operationId: Type.Optional(Type.String()),
+    /** A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. path.id for an id parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. */
+    parameters: Type.Optional(Type.Record(Type.String(), Type.Any())),
+    /** A literal value or {expression} to use as a request body when calling the target operation. */
+    requestBody: Type.Optional(Type.Any()),
+    /** A description of the link. CommonMark syntax MAY be used for rich text representation. */
+    description: Type.Optional(Type.String()),
+    /** A server object to be used by the target operation. */
+    server: Type.Optional(ServerObjectRef),
 });
-export {
-  LinkObjectSchemaDefinition
-};
-//# sourceMappingURL=link.js.map

package/dist/schemas/v3.1/strict/media-type.js

@@ -1,17 +1,18 @@
-import { Type } from "@scalar/typebox";
-import { EncodingObjectRef, ExampleObjectRef, SchemaObjectRef } from "./ref-definitions.js";
-import { reference } from "./reference.js";
-const MediaTypeObjectSchemaDefinition = Type.Object({
-  /** The schema defining the content of the request, response, parameter, or header. */
-  schema: Type.Optional(Type.Union([SchemaObjectRef, reference(SchemaObjectRef)])),
-  /** Example of the media type */
-  example: Type.Optional(Type.Any()),
-  /** Examples of the media type */
-  examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObjectRef, reference(ExampleObjectRef)]))),
-  /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding field SHALL only apply to Request Body Objects, and only when the media type is multipart or application/x-www-form-urlencoded. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. */
-  encoding: Type.Optional(Type.Record(Type.String(), EncodingObjectRef))
+import { Type } from '@scalar/typebox';
+import { EncodingObjectRef, ExampleObjectRef, SchemaObjectRef } from './ref-definitions.js';
+import { reference } from './reference.js';
+/**
+ * Each Media Type Object provides schema and examples for the media type identified by its key.
+ *
+ * When example or examples are provided, the example SHOULD match the specified schema and be in the correct format as specified by the media type and its encoding. The example and examples fields are mutually exclusive, and if either is present it SHALL override any example in the schema. See Working With Examples for further guidance regarding the different ways of specifying examples, including non-JSON/YAML values.
+ */
+export const MediaTypeObjectSchemaDefinition = Type.Object({
+    /** The schema defining the content of the request, response, parameter, or header. */
+    schema: Type.Optional(Type.Union([SchemaObjectRef, reference(SchemaObjectRef)])),
+    /** Example of the media type */
+    example: Type.Optional(Type.Any()),
+    /** Examples of the media type */
+    examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObjectRef, reference(ExampleObjectRef)]))),
+    /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding field SHALL only apply to Request Body Objects, and only when the media type is multipart or application/x-www-form-urlencoded. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. */
+    encoding: Type.Optional(Type.Record(Type.String(), EncodingObjectRef)),
 });
-export {
-  MediaTypeObjectSchemaDefinition
-};
-//# sourceMappingURL=media-type.js.map

package/dist/schemas/v3.1/strict/oauth-flow.js

@@ -1,71 +1,37 @@
-import { Type } from "@scalar/typebox";
-import { compose } from "../../../schemas/compose.js";
-import {
-  XScalarCredentialsLocationSchema
-} from "../../../schemas/extensions/security/x-scalar-credentials-location.js";
-import {
-  XScalarSecurityBodySchema
-} from "../../../schemas/extensions/security/x-scalar-security-body.js";
-import {
-  XScalarSecurityQuerySchema
-} from "../../../schemas/extensions/security/x-scalar-security-query.js";
-import {
-  XScalarAuthUrlSchema,
-  XScalarTokenUrlSchema
-} from "../../../schemas/extensions/security/x-scalar-security-secrets.js";
-import { XTokenNameSchema } from "../../../schemas/extensions/security/x-tokenName.js";
-import { XusePkceSchema } from "../../../schemas/extensions/security/x-use-pkce.js";
-const OAuthFlowCommonSchema = compose(
-  Type.Object({
+import { Type } from '@scalar/typebox';
+import { compose } from '../../../schemas/compose.js';
+import { XScalarCredentialsLocationSchema, } from '../../../schemas/extensions/security/x-scalar-credentials-location.js';
+import { XScalarSecurityBodySchema, } from '../../../schemas/extensions/security/x-scalar-security-body.js';
+import { XScalarSecurityQuerySchema, } from '../../../schemas/extensions/security/x-scalar-security-query.js';
+import { XScalarAuthUrlSchema, XScalarTokenUrlSchema, } from '../../../schemas/extensions/security/x-scalar-security-secrets.js';
+import { XTokenNameSchema } from '../../../schemas/extensions/security/x-tokenName.js';
+import { XusePkceSchema } from '../../../schemas/extensions/security/x-use-pkce.js';
+/** Common properties used across all OAuth flows */
+const OAuthFlowCommonSchema = compose(Type.Object({
     /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
     refreshUrl: Type.String(),
     /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
-    scopes: Type.Record(Type.String(), Type.String())
-  }),
-  XScalarSecurityQuerySchema,
-  XScalarSecurityBodySchema,
-  XTokenNameSchema,
-  XScalarAuthUrlSchema,
-  XScalarTokenUrlSchema
-);
-const OAuthFlowImplicitSchema = compose(
-  OAuthFlowCommonSchema,
-  Type.Object({
+    scopes: Type.Record(Type.String(), Type.String()),
+}), XScalarSecurityQuerySchema, XScalarSecurityBodySchema, XTokenNameSchema, XScalarAuthUrlSchema, XScalarTokenUrlSchema);
+/** Configuration for the OAuth Implicit flow */
+export const OAuthFlowImplicitSchema = compose(OAuthFlowCommonSchema, Type.Object({
     /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
-    authorizationUrl: Type.String()
-  })
-);
-const OAuthFlowPasswordSchema = compose(
-  OAuthFlowCommonSchema,
-  Type.Object({
+    authorizationUrl: Type.String(),
+}));
+/** Configuration for the OAuth Resource Owner Password flow */
+export const OAuthFlowPasswordSchema = compose(OAuthFlowCommonSchema, Type.Object({
     /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
-    tokenUrl: Type.String()
-  }),
-  XScalarCredentialsLocationSchema
-);
-const OAuthFlowClientCredentialsSchema = compose(
-  OAuthFlowCommonSchema,
-  Type.Object({
+    tokenUrl: Type.String(),
+}), XScalarCredentialsLocationSchema);
+/** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
+export const OAuthFlowClientCredentialsSchema = compose(OAuthFlowCommonSchema, Type.Object({
     /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
-    tokenUrl: Type.String()
-  }),
-  XScalarCredentialsLocationSchema
-);
-const OAuthFlowAuthorizationCodeSchema = compose(
-  OAuthFlowCommonSchema,
-  Type.Object({
+    tokenUrl: Type.String(),
+}), XScalarCredentialsLocationSchema);
+/** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
+export const OAuthFlowAuthorizationCodeSchema = compose(OAuthFlowCommonSchema, Type.Object({
     /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
     authorizationUrl: Type.String(),
     /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
-    tokenUrl: Type.String()
-  }),
-  XusePkceSchema,
-  XScalarCredentialsLocationSchema
-);
-export {
-  OAuthFlowAuthorizationCodeSchema,
-  OAuthFlowClientCredentialsSchema,
-  OAuthFlowImplicitSchema,
-  OAuthFlowPasswordSchema
-};
-//# sourceMappingURL=oauth-flow.js.map
+    tokenUrl: Type.String(),
+}), XusePkceSchema, XScalarCredentialsLocationSchema);

package/dist/schemas/v3.1/strict/oauthflows.js

@@ -1,21 +1,15 @@
-import { Type } from "@scalar/typebox";
-import {
-  OAuthFlowAuthorizationCodeSchema,
-  OAuthFlowClientCredentialsSchema,
-  OAuthFlowImplicitSchema,
-  OAuthFlowPasswordSchema
-} from "./oauth-flow.js";
-const OAuthFlowsObjectSchemaDefinition = Type.Object({
-  /** Configuration for the OAuth Implicit flow */
-  implicit: Type.Optional(OAuthFlowImplicitSchema),
-  /** Configuration for the OAuth Resource Owner Password flow */
-  password: Type.Optional(OAuthFlowPasswordSchema),
-  /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
-  clientCredentials: Type.Optional(OAuthFlowClientCredentialsSchema),
-  /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
-  authorizationCode: Type.Optional(OAuthFlowAuthorizationCodeSchema)
+import { Type } from '@scalar/typebox';
+import { OAuthFlowAuthorizationCodeSchema, OAuthFlowClientCredentialsSchema, OAuthFlowImplicitSchema, OAuthFlowPasswordSchema, } from './oauth-flow.js';
+/**
+ * Allows configuration of the supported OAuth Flows.
+ */
+export const OAuthFlowsObjectSchemaDefinition = Type.Object({
+    /** Configuration for the OAuth Implicit flow */
+    implicit: Type.Optional(OAuthFlowImplicitSchema),
+    /** Configuration for the OAuth Resource Owner Password flow */
+    password: Type.Optional(OAuthFlowPasswordSchema),
+    /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
+    clientCredentials: Type.Optional(OAuthFlowClientCredentialsSchema),
+    /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
+    authorizationCode: Type.Optional(OAuthFlowAuthorizationCodeSchema),
 });
-export {
-  OAuthFlowsObjectSchemaDefinition
-};
-//# sourceMappingURL=oauthflows.js.map