@scalar/oas-utils 0.10.8 → 0.10.9

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/oas-utils
 
+## 0.10.9
+
+### Patch Changes
+
+- [#8466](https://github.com/scalar/scalar/pull/8466): chore: new build pipeline
+
 ## 0.10.8
 
 ### Patch Changes

package/dist/entities/cookie/cookie.js

@@ -1,16 +1,12 @@
-import { z } from "zod";
-import { nanoidSchema } from "@scalar/types/utils";
-const cookieSchema = z.object({
-  uid: nanoidSchema.brand(),
-  /**  Defines the cookie name and its value. A cookie definition begins with a name-value pair.  */
-  name: z.string().default(""),
-  value: z.string().default(""),
-  /** Defines the host to which the cookie will be sent. */
-  domain: z.string().optional(),
-  /** Indicates the path that must exist in the requested URL for the browser to send the Cookie header. */
-  path: z.string().optional()
+import { z } from 'zod';
+import { nanoidSchema } from '@scalar/types/utils';
+export const cookieSchema = z.object({
+    uid: nanoidSchema.brand(),
+    /**  Defines the cookie name and its value. A cookie definition begins with a name-value pair.  */
+    name: z.string().default(''),
+    value: z.string().default(''),
+    /** Defines the host to which the cookie will be sent. */
+    domain: z.string().optional(),
+    /** Indicates the path that must exist in the requested URL for the browser to send the Cookie header. */
+    path: z.string().optional(),
 });
-export {
-  cookieSchema
-};
-//# sourceMappingURL=cookie.js.map

package/dist/entities/cookie/index.js

@@ -1,5 +1 @@
-import { cookieSchema } from "./cookie.js";
-export {
-  cookieSchema
-};
-//# sourceMappingURL=index.js.map
+export { cookieSchema } from './cookie.js';

package/dist/entities/environment/environment.js

@@ -1,12 +1,8 @@
-import { z } from "zod";
-const environmentSchema = z.object({
-  uid: z.string().brand(),
-  name: z.string().optional().default("Default Environment"),
-  color: z.string().optional().default("#FFFFFF"),
-  value: z.string().default(""),
-  isDefault: z.boolean().optional()
+import { z } from 'zod';
+export const environmentSchema = z.object({
+    uid: z.string().brand(),
+    name: z.string().optional().default('Default Environment'),
+    color: z.string().optional().default('#FFFFFF'),
+    value: z.string().default(''),
+    isDefault: z.boolean().optional(),
 });
-export {
-  environmentSchema
-};
-//# sourceMappingURL=environment.js.map

package/dist/entities/environment/index.js

@@ -1,5 +1 @@
-import { environmentSchema } from "./environment.js";
-export {
-  environmentSchema
-};
-//# sourceMappingURL=index.js.map
+export { environmentSchema } from './environment.js';

package/dist/entities/hotkeys/hotkeys.js

@@ -1,113 +1,118 @@
-const HOTKEY_EVENT_NAMES = [
-  "addTopNav",
-  "closeModal",
-  "closeTopNav",
-  "createNew",
-  "executeRequest",
-  "focusAddressBar",
-  "focusRequestSearch",
-  "jumpToLastTab",
-  "jumpToTab",
-  "navigateSearchResultsDown",
-  "navigateSearchResultsUp",
-  "navigateTopNavLeft",
-  "navigateTopNavRight",
-  "openCommandPalette",
-  "selectSearchResult",
-  "toggleSidebar"
+/**
+ * Array of all of the events that we support
+ */
+export const HOTKEY_EVENT_NAMES = [
+    'addTopNav',
+    'closeModal',
+    'closeTopNav',
+    'createNew',
+    'executeRequest',
+    'focusAddressBar',
+    'focusRequestSearch',
+    'jumpToLastTab',
+    'jumpToTab',
+    'navigateSearchResultsDown',
+    'navigateSearchResultsUp',
+    'navigateTopNavLeft',
+    'navigateTopNavRight',
+    'openCommandPalette',
+    'selectSearchResult',
+    'toggleSidebar',
 ];
-const KEYDOWN_KEYS = [
-  "Space",
-  "Backspace",
-  "Tab",
-  "Enter",
-  "Escape",
-  "ArrowDown",
-  "ArrowLeft",
-  "ArrowRight",
-  "ArrowUp",
-  "End",
-  "Home",
-  "PageDown",
-  "PageUp",
-  "Delete",
-  "0",
-  "1",
-  "2",
-  "3",
-  "4",
-  "5",
-  "6",
-  "7",
-  "8",
-  "9",
-  "a",
-  "b",
-  "c",
-  "d",
-  "e",
-  "f",
-  "g",
-  "h",
-  "i",
-  "j",
-  "k",
-  "l",
-  "m",
-  "n",
-  "o",
-  "p",
-  "q",
-  "r",
-  "s",
-  "t",
-  "u",
-  "v",
-  "w",
-  "x",
-  "y",
-  "z",
-  "0",
-  "1",
-  "2",
-  "3",
-  "4",
-  "5",
-  "6",
-  "7",
-  "8",
-  "9",
-  "*",
-  "+",
-  "-",
-  ".",
-  "/",
-  "F1",
-  "F2",
-  "F3",
-  "F4",
-  "F5",
-  "F6",
-  "F7",
-  "F8",
-  "F9",
-  "F10",
-  "F11",
-  "F12",
-  ";",
-  "=",
-  ",",
-  "-",
-  ".",
-  "/",
-  "`",
-  "[",
-  "\\",
-  "]",
-  ""
+/**
+ * Array of all of the hotkeys that we support
+ *
+ * Space is a special case because its actually ' ' but we name it space here and will handle it separately
+ * If you need more
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values
+ */
+export const KEYDOWN_KEYS = [
+    'Space',
+    'Backspace',
+    'Tab',
+    'Enter',
+    'Escape',
+    'ArrowDown',
+    'ArrowLeft',
+    'ArrowRight',
+    'ArrowUp',
+    'End',
+    'Home',
+    'PageDown',
+    'PageUp',
+    'Delete',
+    '0',
+    '1',
+    '2',
+    '3',
+    '4',
+    '5',
+    '6',
+    '7',
+    '8',
+    '9',
+    'a',
+    'b',
+    'c',
+    'd',
+    'e',
+    'f',
+    'g',
+    'h',
+    'i',
+    'j',
+    'k',
+    'l',
+    'm',
+    'n',
+    'o',
+    'p',
+    'q',
+    'r',
+    's',
+    't',
+    'u',
+    'v',
+    'w',
+    'x',
+    'y',
+    'z',
+    '0',
+    '1',
+    '2',
+    '3',
+    '4',
+    '5',
+    '6',
+    '7',
+    '8',
+    '9',
+    '*',
+    '+',
+    '-',
+    '.',
+    '/',
+    'F1',
+    'F2',
+    'F3',
+    'F4',
+    'F5',
+    'F6',
+    'F7',
+    'F8',
+    'F9',
+    'F10',
+    'F11',
+    'F12',
+    ';',
+    '=',
+    ',',
+    '-',
+    '.',
+    '/',
+    '`',
+    '[',
+    '\\',
+    ']',
+    '',
 ];
-export {
-  HOTKEY_EVENT_NAMES,
-  KEYDOWN_KEYS
-};
-//# sourceMappingURL=hotkeys.js.map

package/dist/entities/hotkeys/index.js

@@ -1,6 +1 @@
-import { HOTKEY_EVENT_NAMES, KEYDOWN_KEYS } from "./hotkeys.js";
-export {
-  HOTKEY_EVENT_NAMES,
-  KEYDOWN_KEYS
-};
-//# sourceMappingURL=index.js.map
+export { HOTKEY_EVENT_NAMES, KEYDOWN_KEYS } from './hotkeys.js';

package/dist/entities/shared/index.js

@@ -1,7 +1 @@
-import {
-  selectedSecuritySchemeUidSchema
-} from "./utility.js";
-export {
-  selectedSecuritySchemeUidSchema
-};
-//# sourceMappingURL=index.js.map
+export { selectedSecuritySchemeUidSchema, } from './utility.js';

package/dist/entities/shared/utility.js

@@ -1,9 +1,9 @@
-import { z } from "zod";
-const selectedSecuritySchemeUidSchema = z.union([
-  z.string().brand(),
-  z.string().brand().array()
-]).array().default([]);
-export {
-  selectedSecuritySchemeUidSchema
-};
-//# sourceMappingURL=utility.js.map
+import { z } from 'zod';
+/** Schema for selectedSecuritySchemeUids */
+export const selectedSecuritySchemeUidSchema = z
+    .union([
+    z.string().brand(),
+    z.string().brand().array(),
+])
+    .array()
+    .default([]);

package/dist/entities/spec/collection.js

@@ -1,93 +1,95 @@
-import { oasSecurityRequirementSchema } from "@scalar/types/entities";
-import { nanoidSchema } from "@scalar/types/utils";
-import { z } from "zod";
-import { selectedSecuritySchemeUidSchema } from "../../entities/shared/utility.js";
-import { xScalarEnvironmentsSchema } from "../../entities/spec/x-scalar-environments.js";
-import { xScalarSecretsSchema } from "../../entities/spec/x-scalar-secrets.js";
-import { oasExternalDocumentationSchema, oasInfoSchema } from "./spec-objects.js";
+import { oasSecurityRequirementSchema } from '@scalar/types/entities';
+import { nanoidSchema } from '@scalar/types/utils';
+import { z } from 'zod';
+import { selectedSecuritySchemeUidSchema } from '../../entities/shared/utility.js';
+import { xScalarEnvironmentsSchema } from '../../entities/spec/x-scalar-environments.js';
+import { xScalarSecretsSchema } from '../../entities/spec/x-scalar-secrets.js';
+import { oasExternalDocumentationSchema, oasInfoSchema } from './spec-objects.js';
 const oasCollectionSchema = z.object({
-  /**
-   * @deprecated
-   * Needs to be remove as it is not a spec property
-   */
-  "type": z.literal("collection").optional().default("collection"),
-  "openapi": z.union([z.string(), z.literal("3.0.0"), z.literal("3.1.0"), z.literal("4.0.0")]).optional().default("3.1.0"),
-  "jsonSchemaDialect": z.string().optional(),
-  "info": oasInfoSchema.catch({
-    title: "API",
-    version: "1.0"
-  }),
-  /**
-   * A declaration of which security mechanisms can be used across the API. The list of
-   * values includes alternative security requirement objects that can be used. Only
-   * one of the security requirement objects need to be satisfied to authorize a request.
-   * Individual operations can override this definition. To make security optional, an empty
-   * security requirement ({}) can be included in the array.
-   */
-  "security": z.array(oasSecurityRequirementSchema).optional().default([]),
-  "externalDocs": oasExternalDocumentationSchema.optional().catch(void 0),
-  /** TODO: Type these */
-  "components": z.record(z.string(), z.unknown()).optional(),
-  /** TODO: Type these */
-  "webhooks": z.record(z.string(), z.unknown()).optional(),
-  /** A custom icon representing the collection */
-  "x-scalar-icon": z.string().optional().default("interface-content-folder"),
-  "x-scalar-active-environment": z.string().optional(),
-  "x-scalar-environments": xScalarEnvironmentsSchema.optional(),
-  "x-scalar-secrets": xScalarSecretsSchema.optional()
-  // These properties will be stripped out and mapped back as id lists
-  // servers
-  // paths/**
-  // servers
-  // tags
-  // security
+    /**
+     * @deprecated
+     * Needs to be remove as it is not a spec property
+     */
+    'type': z.literal('collection').optional().default('collection'),
+    'openapi': z
+        .union([z.string(), z.literal('3.0.0'), z.literal('3.1.0'), z.literal('4.0.0')])
+        .optional()
+        .default('3.1.0'),
+    'jsonSchemaDialect': z.string().optional(),
+    'info': oasInfoSchema.catch({
+        title: 'API',
+        version: '1.0',
+    }),
+    /**
+     * A declaration of which security mechanisms can be used across the API. The list of
+     * values includes alternative security requirement objects that can be used. Only
+     * one of the security requirement objects need to be satisfied to authorize a request.
+     * Individual operations can override this definition. To make security optional, an empty
+     * security requirement ({}) can be included in the array.
+     */
+    'security': z.array(oasSecurityRequirementSchema).optional().default([]),
+    'externalDocs': oasExternalDocumentationSchema.optional().catch(undefined),
+    /** TODO: Type these */
+    'components': z.record(z.string(), z.unknown()).optional(),
+    /** TODO: Type these */
+    'webhooks': z.record(z.string(), z.unknown()).optional(),
+    /** A custom icon representing the collection */
+    'x-scalar-icon': z.string().optional().default('interface-content-folder'),
+    'x-scalar-active-environment': z.string().optional(),
+    'x-scalar-environments': xScalarEnvironmentsSchema.optional(),
+    'x-scalar-secrets': xScalarSecretsSchema.optional(),
+    // These properties will be stripped out and mapped back as id lists
+    // servers
+    // paths/**
+    // servers
+    // tags
+    // security
 });
 const extendedCollectionSchema = z.object({
-  uid: nanoidSchema.brand(),
-  /** A list of security schemes UIDs associated with the collection */
-  securitySchemes: z.string().array().default([]),
-  /** List of currently selected security scheme UIDs, these can be overridden per request */
-  selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema,
-  /** The currently selected server */
-  selectedServerUid: z.string().brand().optional(),
-  /** UIDs which refer to servers on the workspace base */
-  servers: z.string().brand().array().default([]),
-  /** Request UIDs associated with a collection */
-  requests: z.string().brand().array().default([]),
-  /** Tag UIDs associated with the collection */
-  tags: z.string().brand().array().default([]),
-  /** List of requests without tags and top level tag "folders" */
-  children: z.union([z.string().brand(), z.string().brand()]).array().default([]),
-  /**
-   * A link to where this document is stored
-   *
-   * - Used for watch mode
-   * - Possibly useful for Git sync down the line
-   */
-  documentUrl: z.string().optional(),
-  /**
-   * Enables polling of OpenAPI document urls
-   *
-   * @remarks Only effective when `documentUrl` is set
-   */
-  watchMode: z.boolean().optional().default(false),
-  /** Keeps track of which integration is associated with the specific collection */
-  integration: z.string().nullable().optional(),
-  /**
-   * Selected authentication will be set at the collection level instead of the request level
-   *
-   * @default false
-   */
-  useCollectionSecurity: z.boolean().optional().default(false),
-  /**
-   * Status of the watcher from above
-   *
-   * @defaults to idle for all collections, doesn't mean that it can watch for changes
-   */
-  watchModeStatus: z.enum(["IDLE", "WATCHING", "ERROR"]).optional().default("IDLE")
+    uid: nanoidSchema.brand(),
+    /** A list of security schemes UIDs associated with the collection */
+    securitySchemes: z.string().array().default([]),
+    /** List of currently selected security scheme UIDs, these can be overridden per request */
+    selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema,
+    /** The currently selected server */
+    selectedServerUid: z.string().brand().optional(),
+    /** UIDs which refer to servers on the workspace base */
+    servers: z.string().brand().array().default([]),
+    /** Request UIDs associated with a collection */
+    requests: z.string().brand().array().default([]),
+    /** Tag UIDs associated with the collection */
+    tags: z.string().brand().array().default([]),
+    /** List of requests without tags and top level tag "folders" */
+    children: z
+        .union([z.string().brand(), z.string().brand()])
+        .array()
+        .default([]),
+    /**
+     * A link to where this document is stored
+     *
+     * - Used for watch mode
+     * - Possibly useful for Git sync down the line
+     */
+    documentUrl: z.string().optional(),
+    /**
+     * Enables polling of OpenAPI document urls
+     *
+     * @remarks Only effective when `documentUrl` is set
+     */
+    watchMode: z.boolean().optional().default(false),
+    /** Keeps track of which integration is associated with the specific collection */
+    integration: z.string().nullable().optional(),
+    /**
+     * Selected authentication will be set at the collection level instead of the request level
+     *
+     * @default false
+     */
+    useCollectionSecurity: z.boolean().optional().default(false),
+    /**
+     * Status of the watcher from above
+     *
+     * @defaults to idle for all collections, doesn't mean that it can watch for changes
+     */
+    watchModeStatus: z.enum(['IDLE', 'WATCHING', 'ERROR']).optional().default('IDLE'),
 });
-const collectionSchema = oasCollectionSchema.merge(extendedCollectionSchema);
-export {
-  collectionSchema
-};
-//# sourceMappingURL=collection.js.map
+export const collectionSchema = oasCollectionSchema.merge(extendedCollectionSchema);

package/dist/entities/spec/index.js

@@ -1,59 +1,10 @@
-import {
-  oasSecurityRequirementSchema,
-  oasSecuritySchemeSchema,
-  pkceOptions,
-  securityApiKeySchema,
-  securityHttpSchema,
-  securityOauthSchema,
-  securityOpenIdSchema,
-  securitySchemeSchema
-} from "@scalar/types/entities";
-import { collectionSchema } from "./collection.js";
-import {
-  operationSchema
-} from "./operation.js";
-import { oasParameterSchema } from "./parameters.js";
-import {
-  createExampleFromRequest,
-  requestExampleParametersSchema,
-  requestExampleSchema
-} from "./request-examples.js";
-import {
-  requestSchema
-} from "./requests.js";
-import { serverSchema } from "./server.js";
-import {
-  oasContactSchema,
-  oasExternalDocumentationSchema,
-  oasInfoSchema,
-  oasLicenseSchema,
-  tagSchema
-} from "./spec-objects.js";
-import {
-  xScalarEnvironmentsSchema
-} from "./x-scalar-environments.js";
-export {
-  collectionSchema,
-  createExampleFromRequest,
-  oasContactSchema,
-  oasExternalDocumentationSchema,
-  oasInfoSchema,
-  oasLicenseSchema,
-  oasParameterSchema,
-  oasSecurityRequirementSchema,
-  oasSecuritySchemeSchema,
-  operationSchema,
-  pkceOptions,
-  requestExampleParametersSchema,
-  requestExampleSchema,
-  requestSchema,
-  securityApiKeySchema,
-  securityHttpSchema,
-  securityOauthSchema,
-  securityOpenIdSchema,
-  securitySchemeSchema,
-  serverSchema,
-  tagSchema,
-  xScalarEnvironmentsSchema
-};
-//# sourceMappingURL=index.js.map
+/** Re-exported here for ease of use but we should use the other ones directly */
+export { oasSecurityRequirementSchema, oasSecuritySchemeSchema, pkceOptions, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeSchema, } from '@scalar/types/entities';
+export { collectionSchema } from './collection.js';
+export { operationSchema, } from './operation.js';
+export { oasParameterSchema } from './parameters.js';
+export { createExampleFromRequest, requestExampleParametersSchema, requestExampleSchema, } from './request-examples.js';
+export { requestSchema, } from './requests.js';
+export { serverSchema } from './server.js';
+export { oasContactSchema, oasExternalDocumentationSchema, oasInfoSchema, oasLicenseSchema, tagSchema, } from './spec-objects.js';
+export { xScalarEnvironmentsSchema, } from './x-scalar-environments.js';

package/dist/entities/spec/operation.js

@@ -1,6 +1,6 @@
-import { requestSchema } from "./requests.js";
-const operationSchema = requestSchema;
-export {
-  operationSchema
-};
-//# sourceMappingURL=operation.js.map
+/**
+ * Aliases Request to Operation which is closer to the spec,
+ * also will not conflict with the builtin Request class
+ */
+import { requestSchema } from './requests.js';
+export const operationSchema = requestSchema;