source/packages/services/greengrass2-provisioning/src/utils/pkUtils.util.ts

/*********************************************************************************************************************
 *  Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.                                           *
 *                                                                                                                    *
 *  Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance    *
 *  with the License. A copy of the License is located at                                                             *
 *                                                                                                                    *
 *      http://www.apache.org/licenses/LICENSE-2.0                                                                    *
 *                                                                                                                    *
 *  or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES *
 *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions    *
 *  and limitations under the License.                                                                                *
 *********************************************************************************************************************/
const PK_DELIMITER = ':::';

export function createDelimitedAttribute(
    type: PkType,
    ...items: (string | number | boolean)[]
): string {
    const escapedItems = items.map((i) => {
        if (typeof i === 'string') {
            return escape(i);
        } else {
            return i;
        }
    });
    return `${delimitedAttributePrefix(type)}${escapedItems.join(PK_DELIMITER)}`;
}

export function createDelimitedAttributePrefix(
    type: PkType,
    ...items: (string | number | boolean)[]
): string {
    return `${createDelimitedAttribute(type, ...items)}`;
}

export function expandDelimitedAttribute(value: string): string[] {
    if (value === null || value === undefined) {
        return undefined;
    }
    const expanded = value.split(PK_DELIMITER);
    return expanded.map((i) => {
        if (typeof i === 'string') {
            return unescape(i);
        } else {
            return i;
        }
    });
}

export function delimitedAttributePrefix(type: PkType): string {
    return `${type}${PK_DELIMITER}`;
}

export function isPkType(value: string, type: PkType): boolean {
    return value.startsWith(delimitedAttributePrefix(type));
}

export enum PkType {
    Template = 'T',
    Component = 'TC',
    TemplateVersion = 'TV',
    CoreDeviceTask = 'CT',
    CoreDevice = 'C',
    ClientDeviceTask = 'DT',
    ClientDevice = 'D',
    DeploymentTask = 'DMT',
    Deployment = 'DM',
    DeploymentRevision = 'DMR',
    DeploymentStatus = 'DMS',
    IotJob = 'J',
    Artifact = 'A',
    Fleet = 'F',
}