agerix/iconify
2
0
Fork 0
mirror of https://github.com/iconify/iconify.git synced 2025-01-22 14:48:24 +00:00
Code Issues Releases Activity

Remove old JSONP API module, clean up API config

Browse Source
This commit is contained in:
Vjacheslav Trushkin 2022-06-28 19:03:10 +03:00
parent 772aaf4686
commit 0bd0bae6c2
3 changed files with 5 additions and 242 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/core/package.json
View File

@ -45,10 +45,6 @@
"require": "./lib/api/modules.cjs", "require": "./lib/api/modules.cjs",
"import": "./lib/api/modules.mjs" "import": "./lib/api/modules.mjs"
}, },
"./lib/api/modules/deprecated-jsonp": {
"require": "./lib/api/modules/deprecated-jsonp.cjs",
"import": "./lib/api/modules/deprecated-jsonp.mjs"
},
"./lib/api/modules/fetch": { "./lib/api/modules/fetch": {
"require": "./lib/api/modules/fetch.cjs", "require": "./lib/api/modules/fetch.cjs",
"import": "./lib/api/modules/fetch.mjs" "import": "./lib/api/modules/fetch.mjs"

10
packages/core/src/api/config.ts
View File

@ -35,22 +35,22 @@ export function createAPIConfig(
resources: resources, resources: resources,
// Root path // Root path
path: source.path === void 0 ? '/' : source.path, path: source.path || '/',
// URL length limit // URL length limit
maxURL: source.maxURL ? source.maxURL : 500, maxURL: source.maxURL || 500,
// Timeout before next host is used. // Timeout before next host is used.
rotate: source.rotate ? source.rotate : 750, rotate: source.rotate || 750,
// Timeout before failing query. // Timeout before failing query.
timeout: source.timeout ? source.timeout : 5000, timeout: source.timeout || 5000,
// Randomise default API end point. // Randomise default API end point.
random: source.random === true, random: source.random === true,
// Start index // Start index
index: source.index ? source.index : 0, index: source.index || 0,
// Receive data after time out (used if time out kicks in first, then API module sends data anyway). // Receive data after time out (used if time out kicks in first, then API module sends data anyway).
dataAfterTimeout: source.dataAfterTimeout !== false, dataAfterTimeout: source.dataAfterTimeout !== false,

233
packages/core/src/api/modules/deprecated-jsonp.ts
View File

@ -1,233 +0,0 @@
import type { QueryModuleResponse } from '@iconify/api-redundancy';
import type {
IconifyAPIQueryParams,
IconifyAPIPrepareIconsQuery,
IconifyAPISendQuery,
IconifyAPIModule,
IconifyAPIIconsQueryParams,
} from '../modules';
import { getAPIConfig } from '../config';
/**
* Global
*/
type Callback = (data: unknown) => void;
type JSONPRoot = Record<string, Callback>;
let rootVar: JSONPRoot | null = null;
let rootVarName: string | null = null;
/**
* Cache: provider:prefix = value
*/
const maxLengthCache: Record<string, number> = {};
const pathCache: Record<string, string> = {};
/**
* Get hash for query
*
* Hash is used in JSONP callback name, so same queries end up with same JSONP callback,
* allowing response to be cached in browser.
*/
function hash(str: string): number {
let total = 0,
i;
for (i = str.length - 1; i >= 0; i--) {
total += str.charCodeAt(i);
}
return total % 999;
}
/**
* Get root object
*/
function getGlobal(): JSONPRoot {
// Create root
if (rootVar === null) {
// window
const globalRoot = self as unknown as Record<string, unknown>;
// Test for window.Iconify. If missing, create 'IconifyJSONP'
let prefix = 'Iconify';
let extraPrefix = '.cb';
if (globalRoot[prefix] === void 0) {
// Use 'IconifyJSONP' global
prefix = 'IconifyJSONP';
extraPrefix = '';
if (globalRoot[prefix] === void 0) {
globalRoot[prefix] = {};
}
rootVar = globalRoot[prefix] as JSONPRoot;
} else {
// Use 'Iconify.cb'
const iconifyRoot = globalRoot[prefix] as Record<string, JSONPRoot>;
if (iconifyRoot.cb === void 0) {
iconifyRoot.cb = {};
}
rootVar = iconifyRoot.cb;
}
// Change end point
rootVarName = prefix + extraPrefix + '.{cb}';
}
return rootVar;
}
/**
* Calculate maximum icons list length for prefix
*/
function calculateMaxLength(provider: string, prefix: string): number {
// Get config and store path
const config = getAPIConfig(provider);
if (!config) {
return 0;
}
// Calculate
let result;
if (!config.maxURL) {
result = 0;
} else {
let maxHostLength = 0;
config.resources.forEach((item) => {
const host = item;
maxHostLength = Math.max(maxHostLength, host.length);
});
// Make sure global is set
getGlobal();
// Get available length
const params = new URLSearchParams({
icons: '',
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
callback: rootVarName!,
});
const url = prefix + '.js?' + params.toString();
result =
config.maxURL - maxHostLength - config.path.length - url.length;
}
// Cache stuff and return result
const cacheKey = provider + ':' + prefix;
pathCache[cacheKey] = config.path;
maxLengthCache[cacheKey] = result;
return result;
}
/**
* Prepare params
*/
const prepare: IconifyAPIPrepareIconsQuery = (
provider: string,
prefix: string,
icons: string[]
): IconifyAPIIconsQueryParams[] => {
const results: IconifyAPIIconsQueryParams[] = [];
// Get maximum icons list length
const cacheKey = provider + ':' + prefix;
let maxLength = maxLengthCache[cacheKey];
if (maxLength === void 0) {
maxLength = calculateMaxLength(provider, prefix);
}
// Split icons
const type = 'icons';
let item: IconifyAPIIconsQueryParams = {
type,
provider,
prefix,
icons: [],
};
let length = 0;
icons.forEach((name, index) => {
length += name.length + 3; // comma = %2C
if (length >= maxLength && index > 0) {
// Next set
results.push(item);
item = {
type,
provider,
prefix,
icons: [],
};
length = name.length;
}
item.icons.push(name);
});
results.push(item);
return results;
};
/**
* Load icons
*/
const send: IconifyAPISendQuery = (
host: string,
params: IconifyAPIQueryParams,
callback: QueryModuleResponse
): void => {
if (params.type !== 'icons') {
// JSONP supports only icons
callback('abort', 400);
return;
}
const provider = params.provider;
const prefix = params.prefix;
const icons = params.icons;
const iconsList = icons.join(',');
const cacheKey = provider + ':' + prefix;
// Create callback prefix
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const cbPrefix = prefix.split('-').shift()!.slice(0, 3);
const global = getGlobal();
// Callback hash
let cbCounter = hash(
provider + ':' + host + ':' + prefix + ':' + iconsList
);
while (global[`${cbPrefix}${cbCounter}`] !== void 0) {
cbCounter++;
}
const callbackName = `${cbPrefix}${cbCounter}`;
const urlParams = new URLSearchParams({
icons: iconsList,
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
callback: rootVarName!.replace('{cb}', callbackName),
});
const url = prefix + '.js?' + urlParams.toString();
const path = pathCache[cacheKey] + url;
global[callbackName] = (data: unknown): void => {
// Remove callback and complete query
delete global[callbackName];
callback('success', data);
};
// Create URI
const uri = host + path;
// console.log('API query:', uri);
// Create script and append it to head
const script = document.createElement('script');
script.type = 'text/javascript';
script.async = true;
script.src = uri;
document.head.appendChild(script);
};
/**
* Return API module
*/
export const jsonpAPIModule: IconifyAPIModule = { prepare, send };