92 lines
2.6 KiB
Plaintext
92 lines
2.6 KiB
Plaintext
import { isPlainObject, isTruthy } from './utils';
|
|
|
|
import type { Source } from './resolve';
|
|
import type { OasRef } from './typings/openapi';
|
|
|
|
export function joinPointer(base: string, key: string | number) {
|
|
if (base === '') base = '#/';
|
|
return base[base.length - 1] === '/' ? base + key : base + '/' + key;
|
|
}
|
|
|
|
export function isRef(node: unknown): node is OasRef {
|
|
return isPlainObject(node) && typeof node.$ref === 'string';
|
|
}
|
|
|
|
export function isExternalValue(node: unknown) {
|
|
return isPlainObject(node) && typeof node.externalValue === 'string';
|
|
}
|
|
|
|
export class Location {
|
|
constructor(public source: Source, public pointer: string) {}
|
|
|
|
child(components: (string | number)[] | string | number) {
|
|
return new Location(
|
|
this.source,
|
|
joinPointer(
|
|
this.pointer,
|
|
(Array.isArray(components) ? components : [components]).map(escapePointer).join('/')
|
|
)
|
|
);
|
|
}
|
|
|
|
key() {
|
|
return { ...this, reportOnKey: true };
|
|
}
|
|
|
|
get absolutePointer() {
|
|
return this.source.absoluteRef + (this.pointer === '#/' ? '' : this.pointer);
|
|
}
|
|
}
|
|
|
|
export function unescapePointer(fragment: string): string {
|
|
return decodeURIComponent(fragment.replace(/~1/g, '/').replace(/~0/g, '~'));
|
|
}
|
|
|
|
export function escapePointer<T extends string | number>(fragment: T): T {
|
|
if (typeof fragment === 'number') return fragment;
|
|
return (fragment as string).replace(/~/g, '~0').replace(/\//g, '~1') as T;
|
|
}
|
|
|
|
export function parseRef(ref: string): { uri: string | null; pointer: string[] } {
|
|
const [uri, pointer = ''] = ref.split('#/');
|
|
return {
|
|
uri: (uri.endsWith('#') ? uri.slice(0, -1) : uri) || null,
|
|
pointer: parsePointer(pointer),
|
|
};
|
|
}
|
|
|
|
export function parsePointer(pointer: string) {
|
|
return pointer.split('/').map(unescapePointer).filter(isTruthy);
|
|
}
|
|
|
|
export function pointerBaseName(pointer: string) {
|
|
const parts = pointer.split('/');
|
|
return parts[parts.length - 1];
|
|
}
|
|
|
|
export function refBaseName(ref: string) {
|
|
// eslint-disable-next-line no-useless-escape
|
|
const parts = ref.split(/[\/\\]/); // split by '\' and '/'
|
|
return parts[parts.length - 1].replace(/\.[^.]+$/, ''); // replace extension with empty string
|
|
}
|
|
|
|
export function isAbsoluteUrl(ref: string) {
|
|
return ref.startsWith('http://') || ref.startsWith('https://');
|
|
}
|
|
|
|
export function isMappingRef(mapping: string) {
|
|
// TODO: proper detection of mapping refs
|
|
return (
|
|
mapping.startsWith('#') ||
|
|
mapping.startsWith('https://') ||
|
|
mapping.startsWith('http://') ||
|
|
mapping.startsWith('./') ||
|
|
mapping.startsWith('../') ||
|
|
mapping.indexOf('/') > -1
|
|
);
|
|
}
|
|
|
|
export function isAnchor(ref: string) {
|
|
return /^#[A-Za-z][A-Za-z0-9\-_:.]*$/.test(ref);
|
|
}
|