mirror of
https://github.com/google/blockly.git
synced 2026-01-08 17:40:09 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
81 lines
2.2 KiB
TypeScript
81 lines
2.2 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Generators for unique IDs.
|
|
*
|
|
* @namespace Blockly.utils.idGenerator
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.utils.idGenerator');
|
|
|
|
|
|
/**
|
|
* Namespace object for internal implementations we want to be able to
|
|
* stub in tests.
|
|
*
|
|
* @ignore
|
|
*/
|
|
const internal = {};
|
|
export const TEST_ONLY = internal;
|
|
|
|
/** Next unique ID to use. */
|
|
let nextId = 0;
|
|
|
|
/**
|
|
* Generate the next unique element IDs.
|
|
* IDs are compatible with the HTML4 id attribute restrictions:
|
|
* Use only ASCII letters, digits, '_', '-' and '.'
|
|
*
|
|
* For UUIDs use genUid (below) instead; this ID generator should
|
|
* primarily be used for IDs that end up in the DOM.
|
|
*
|
|
* @returns The next unique identifier.
|
|
* @alias Blockly.utils.idGenerator.getNextUniqueId
|
|
*/
|
|
export function getNextUniqueId(): string {
|
|
return 'blockly-' + (nextId++).toString(36);
|
|
}
|
|
|
|
/**
|
|
* Legal characters for the universally unique IDs. Should be all on
|
|
* a US keyboard. No characters that conflict with XML or JSON.
|
|
* Requests to remove additional 'problematic' characters from this
|
|
* soup will be denied. That's your failure to properly escape in
|
|
* your own environment. Issues #251, #625, #682, #1304.
|
|
*/
|
|
const soup = '!#$%()*+,-./:;=?@[]^_`{|}~' +
|
|
'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
|
|
|
|
/**
|
|
* Generate a random unique ID. This should be globally unique.
|
|
* 87 characters ^ 20 length > 128 bits (better than a UUID).
|
|
*
|
|
* @returns A globally unique ID string.
|
|
*/
|
|
// AnyDuringMigration because: Property 'genUid' does not exist on type '{}'.
|
|
(internal as AnyDuringMigration).genUid = function(): string {
|
|
const length = 20;
|
|
const soupLength = soup.length;
|
|
const id = [];
|
|
for (let i = 0; i < length; i++) {
|
|
id[i] = soup.charAt(Math.random() * soupLength);
|
|
}
|
|
return id.join('');
|
|
};
|
|
|
|
/**
|
|
* Generate a random unique ID.
|
|
*
|
|
* @see internal.genUid
|
|
* @returns A globally unique ID string.
|
|
* @alias Blockly.utils.idGenerator.genUid
|
|
*/
|
|
export function genUid(): string {
|
|
// AnyDuringMigration because: Property 'genUid' does not exist on type '{}'.
|
|
return (internal as AnyDuringMigration).genUid();
|
|
}
|