@scalar/oas-utils 0.11.1 → 0.12.0

package/dist/helpers/security/has-token.js

@@ -1,19 +0,0 @@
-/** Pass in a security scheme and it will return true if it has a token or value depending on the scheme type */
-export const hasToken = (scheme) => {
-    // ApiKey
-    if (scheme.type === 'apiKey') {
-        return Boolean(scheme.value);
-    }
-    // Http
-    if (scheme.type === 'http') {
-        return Boolean((scheme.scheme === 'bearer' && scheme.token) || (scheme.scheme === 'basic' && scheme.username && scheme.password));
-    }
-    // OAuth2 just check for A token
-    if (scheme.type === 'oauth2') {
-        return Boolean(scheme.flows.authorizationCode?.token ||
-            scheme.flows.clientCredentials?.token ||
-            scheme.flows.password?.token ||
-            scheme.flows.implicit?.token);
-    }
-    return false;
-};

package/dist/helpers/security/index.d.ts

@@ -1,3 +0,0 @@
-export { getSchemes } from './get-schemes.js';
-export { hasToken } from './has-token.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/helpers/security/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/helpers/security/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA"}

package/dist/helpers/security/index.js

@@ -1,2 +0,0 @@
-export { getSchemes } from './get-schemes.js';
-export { hasToken } from './has-token.js';

package/dist/helpers/servers.d.ts

@@ -1,24 +0,0 @@
-import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-import { type Server } from '../entities/spec/server.js';
-/**
- * Server processing options containing base URLs for resolving relative server URLs.
- */
-type ServerProcessingOptions = {
-    baseServerURL?: string;
-    documentUrl?: string;
-};
-/**
- * Retrieves and processes servers from an OpenAPI document.
- *
- * This function handles several scenarios:
- * 1. No servers provided - creates a default server from document URL or fallback
- * 2. Invalid server configurations - filters them out with warnings
- * 3. Relative URLs - resolves them to absolute URLs using available base URLs
- *
- * @param servers - Array of OpenAPI server objects from the document
- * @param options - Configuration options for server processing
- * @returns Array of validated Server entities
- */
-export declare function getServersFromDocument(servers: ServerObject[] | undefined, options?: ServerProcessingOptions): Server[];
-export {};
-//# sourceMappingURL=servers.d.ts.map

package/dist/helpers/servers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"servers.d.ts","sourceRoot":"","sources":["../../src/helpers/servers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAEhG,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,wBAAwB,CAAA;AAElE;;GAEG;AACH,KAAK,uBAAuB,GAAG;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,YAAY,EAAE,GAAG,SAAS,EACnC,OAAO,GAAE,uBAA4B,GACpC,MAAM,EAAE,CAsBV"}

package/dist/helpers/servers.js

@@ -1,146 +0,0 @@
-import { isDefined } from '@scalar/helpers/array/is-defined';
-import { combineUrlAndPath } from '@scalar/helpers/url/merge-urls';
-import { serverSchema } from '../entities/spec/server.js';
-/**
- * Retrieves and processes servers from an OpenAPI document.
- *
- * This function handles several scenarios:
- * 1. No servers provided - creates a default server from document URL or fallback
- * 2. Invalid server configurations - filters them out with warnings
- * 3. Relative URLs - resolves them to absolute URLs using available base URLs
- *
- * @param servers - Array of OpenAPI server objects from the document
- * @param options - Configuration options for server processing
- * @returns Array of validated Server entities
- */
-export function getServersFromDocument(servers, options = {}) {
-    // Handle case where no servers are provided
-    if (!servers?.length) {
-        const fallbackServer = createFallbackServer(options);
-        return fallbackServer ? [fallbackServer] : [];
-    }
-    // Handle invalid server array
-    if (!Array.isArray(servers)) {
-        return [];
-    }
-    // Process each server and filter out invalid ones
-    const validServers = servers.map((server) => processServerObject(server, options)).filter(isDefined);
-    // If all servers were invalid, provide a fallback
-    if (validServers.length === 0) {
-        const fallbackServer = createFallbackServer(options);
-        return fallbackServer ? [fallbackServer] : [];
-    }
-    return validServers;
-}
-/**
- * Extracts the base URL (protocol + hostname) from a document URL.
- * Returns undefined if the URL is invalid.
- */
-function extractBaseUrlFromDocumentUrl(documentUrl) {
-    try {
-        const url = new URL(documentUrl);
-        const port = url.port ? `:${url.port}` : '';
-        return `${url.protocol}//${url.hostname}${port}`;
-    }
-    catch {
-        return undefined;
-    }
-}
-/**
- * Gets the fallback URL from window.location.origin if available.
- */
-function getFallbackUrl() {
-    if (typeof window === 'undefined' || typeof window?.location?.origin !== 'string') {
-        return undefined;
-    }
-    return window.location.origin;
-}
-/**
- * Creates a server object from a URL string, with error handling.
- */
-function createServerFromUrl(url, context) {
-    try {
-        return serverSchema.parse({ url });
-    }
-    catch {
-        console.warn(`Failed to create server from ${context}:`, url);
-        return undefined;
-    }
-}
-/**
- * Creates a default server using the document URL as the base.
- */
-function createDefaultServerFromDocumentUrl(documentUrl) {
-    const baseUrl = extractBaseUrlFromDocumentUrl(documentUrl);
-    if (!baseUrl) {
-        return undefined;
-    }
-    return createServerFromUrl(baseUrl, 'document URL');
-}
-/**
- * Creates a default server using the fallback URL (window.location.origin).
- */
-function createDefaultServerFromFallback() {
-    const fallbackUrl = getFallbackUrl();
-    if (!fallbackUrl) {
-        return undefined;
-    }
-    return createServerFromUrl(fallbackUrl, 'fallback URL');
-}
-/**
- * Resolves a relative server URL to an absolute URL using available base URLs.
- * Uses a priority system: baseServerURL > documentUrl > fallbackUrl.
- */
-function resolveRelativeServerUrl(serverUrl, options) {
-    const { baseServerURL, documentUrl } = options;
-    // Priority 1: Use provided base server URL
-    if (baseServerURL) {
-        return combineUrlAndPath(baseServerURL, serverUrl);
-    }
-    // Priority 2: Extract base URL from document URL
-    if (documentUrl) {
-        const baseUrl = extractBaseUrlFromDocumentUrl(documentUrl);
-        if (baseUrl) {
-            return combineUrlAndPath(baseUrl, serverUrl);
-        }
-    }
-    // Priority 3: Use fallback URL (window.location.origin)
-    const fallbackUrl = getFallbackUrl();
-    if (fallbackUrl) {
-        return combineUrlAndPath(fallbackUrl, serverUrl);
-    }
-    // If no base URL is available, return the original URL
-    return serverUrl;
-}
-/**
- * Processes a single server object, handling validation and URL resolution.
- */
-function processServerObject(server, options) {
-    try {
-        const parsedServer = serverSchema.parse(server);
-        // Resolve relative URLs to absolute URLs
-        if (parsedServer.url?.startsWith('/')) {
-            parsedServer.url = resolveRelativeServerUrl(parsedServer.url, options);
-        }
-        return parsedServer;
-    }
-    catch (error) {
-        console.warn('Invalid server configuration:', server, 'Error:', error);
-        return undefined;
-    }
-}
-/**
- * Creates a fallback server when no valid servers are available.
- * Uses document URL first, then fallback URL.
- */
-function createFallbackServer(options) {
-    // Priority 1: Try to create default server from document URL
-    if (options.documentUrl) {
-        const defaultServer = createDefaultServerFromDocumentUrl(options.documentUrl);
-        if (defaultServer) {
-            return defaultServer;
-        }
-    }
-    // Priority 2: Try to create default server from fallback URL
-    return createDefaultServerFromFallback();
-}

package/dist/helpers/should-ignore-entity.d.ts

@@ -1,8 +0,0 @@
-/**
- * Check if an entity should be ignored
- */
-export declare const shouldIgnoreEntity: (data: {
-    "x-internal"?: boolean;
-    "x-scalar-ignore"?: boolean;
-}) => boolean;
-//# sourceMappingURL=should-ignore-entity.d.ts.map

package/dist/helpers/should-ignore-entity.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"should-ignore-entity.d.ts","sourceRoot":"","sources":["../../src/helpers/should-ignore-entity.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAAI,MAAM;IAAE,YAAY,CAAC,EAAE,OAAO,CAAC;IAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAAE,YAC3B,CAAA"}

package/dist/helpers/should-ignore-entity.js

@@ -1,4 +0,0 @@
-/**
- * Check if an entity should be ignored
- */
-export const shouldIgnoreEntity = (data) => data?.['x-internal'] === true || data?.['x-scalar-ignore'] === true;

package/dist/migrations/generate-types.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=generate-types.d.ts.map

package/dist/migrations/generate-types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-types.d.ts","sourceRoot":"","sources":["../../src/migrations/generate-types.ts"],"names":[],"mappings":""}

package/dist/migrations/generate-types.js

@@ -1,53 +0,0 @@
-import { writeFile } from 'node:fs';
-import { securitySchemeSchema } from '@scalar/types/entities';
-import { createTypeAlias, printNode, zodToTs } from 'zod-to-ts';
-import { cookieSchema } from '../entities/cookie/cookie.js';
-import { environmentSchema } from '../entities/environment/environment.js';
-import { collectionSchema } from '../entities/spec/collection.js';
-import { requestExampleSchema } from '../entities/spec/request-examples.js';
-import { requestSchema } from '../entities/spec/requests.js';
-import { serverSchema } from '../entities/spec/server.js';
-import { tagSchema } from '../entities/spec/spec-objects.js';
-import { workspaceSchema } from '../entities/workspace/workspace.js';
-import { DATA_VERSION } from '../migrations/data-version.js';
-console.warn('Make sure the generate types file is updated for the current version');
-console.info('Generating...');
-const entities = [
-    { identifier: 'Collection', schema: collectionSchema },
-    { identifier: 'Cookie', schema: cookieSchema },
-    { identifier: 'Environment', schema: environmentSchema },
-    { identifier: 'Tag', schema: tagSchema },
-    { identifier: 'RequestExample', schema: requestExampleSchema },
-    { identifier: 'Request', schema: requestSchema },
-    { identifier: 'SecurityScheme', schema: securitySchemeSchema },
-    { identifier: 'Server', schema: serverSchema },
-    { identifier: 'Workspace', schema: workspaceSchema },
-];
-/**
- * Export the types in a namespace
- * TODO:
- * - go back to typescript compiler api and print pretty types as these ones are optional
- */
-let typeString = entities.reduce((prev, { identifier, schema }) => {
-    const { node } = zodToTs(schema, identifier);
-    const typeAlias = createTypeAlias(node, identifier);
-    const nodeString = '  export ' + printNode(typeAlias) + '\n\n';
-    return prev + nodeString;
-}, `export namespace v_${DATA_VERSION.replace(/\./g, '_')} {\n`);
-// Add all types data object
-typeString += `
-  export type DataRecord = { 
-    collections: Record<string, Collection>
-    cookies: Record<string, Cookie>
-    environments: Record<string, Environment>
-    requestExamples: Record<string, RequestExample>
-    requests: Record<string, Request>
-    securitySchemes: Record<string, SecurityScheme>
-    servers: Record<string, Server>
-    tags: Record<string, Tag>
-    workspaces: Record<string, Workspace>
-  }
-}
-`;
-// Write to file
-writeFile(import.meta.dirname + `/v-${DATA_VERSION}/types.generated.ts`, typeString, { flag: 'w' }, (err) => err ? console.error(err) : console.log('Generation complete!'));

package/dist/spec-getters/get-example-from-schema.d.ts

@@ -1,36 +0,0 @@
-import type { OpenAPIV3_1 } from '@scalar/openapi-types';
-/**
- * Generate an example value from a given OpenAPI SchemaObject.
- *
- * This function recursively processes OpenAPI schemas to create realistic example data.
- * It handles all OpenAPI schema types including primitives, objects, arrays, and
- * composition schemas (allOf, oneOf, anyOf).
- * Uses a tonne of caching for maximum performance.
- *
- * @param schema - The OpenAPI SchemaObject to generate an example from.
- * @param options - Options to customize example generation.
- * @param level - The current recursion depth.
- * @param parentSchema - The parent schema, if any.
- * @param name - The name of the property being processed.
- * @returns An example value for the given schema.
- *
- * @deprecated Use the one from `@scalar/api-client/v2/blocks/operation-code-sample` instead.
- */
-export declare const getExampleFromSchema: (schema: OpenAPIV3_1.SchemaObject, options?: {
-    /** Fallback string for empty string values. */
-    emptyString?: string;
-    /** Whether to use XML tag names as keys. */
-    xml?: boolean;
-    /** Whether to show read-only/write-only properties. */
-    mode?: "read" | "write";
-    /** Dynamic variables which can replace values via x-variable. */
-    variables?: Record<string, unknown>;
-    /** Whether to omit empty and optional properties. */
-    omitEmptyAndOptionalProperties?: boolean;
-}, args?: Partial<{
-    level: number;
-    parentSchema: OpenAPIV3_1.SchemaObject;
-    name: string;
-    seen: WeakSet<object>;
-}>) => any;
-//# sourceMappingURL=get-example-from-schema.d.ts.map

package/dist/spec-getters/get-example-from-schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-example-from-schema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/get-example-from-schema.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAgdxD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,WAAW,CAAC,YAAY,EAChC,UAAU;IACR,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,qDAAqD;IACrD,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,EACD,OAAO,OAAO,CAAC;IACb,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,WAAW,CAAC,YAAY,CAAA;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;CACtB,CAAC,KACD,GAyJF,CAAA"}