UNPKG

@cloudinary/url-gen

Version:

You are invited to influence our new SDK [Click here to view github discussion](https://github.com/cloudinary/js-url-gen/discussions/602) =========================

20 lines (19 loc) 1.42 kB
import { ITrackedPropertiesThroughAnalytics } from "./interfaces/ITrackedPropertiesThroughAnalytics.js"; /** * @private * @description Creates the complete SDK signature by using all the values provided by ITrackedPropertiesThroughAnalytics * Creation of the signature * - Set the AlgoVersion of the encoding, this is an internal letter that represents the version * of our encoding algorithm, it will allow us to perform breaking changes if we'll need them. * - Take the constant SDK code (Arbitrary letter chosen for each SDK, for Base that letter is 'T') * this is used to tell apart which SDK is being tracked. * - Take the {major.minor} versions of the node version (techVersion) (14.2, 16.2 etc.) * - Take the full semver of the SDK you wish to track * - Take the features used(lazy, placeholder etc.) and turn them to a letter (for example accessibility -> D) * - Before appending the string, the Versions must be encoded, see the function `encodeVersion` for more details * - Append all the variables to a single string * - In any case of an error, return the single letter 'E' * * @return {string} sdkAnalyticsSignature */ export declare function getSDKAnalyticsSignature(_trackedAnalytics?: Partial<ITrackedPropertiesThroughAnalytics>): string | 'E';