@snowplow/snowtype 0.1.1 → 0.2.0

package/dist/commands/index.js

@@ -1,92 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = void 0;
-const process = __importStar(require("process"));
-const extra_typings_1 = require("@commander-js/extra-typings");
-const actions_1 = require("./actions");
-const utils_1 = require("./actions/utils");
-const version_1 = require("../version");
-async function main() {
-    await import("dotenv/config");
-    const program = new extra_typings_1.Command();
-    program.exitOverride();
-    program
-        .version(version_1.PKG_VERSION, undefined, "Snowtype CLI version number")
-        .name("snowtype")
-        .description("The Snowtype CLI is a tool which aims to speed up tracking implementations, provide type safety and inline documentation for developers and ultimately reduce the number of erroneous events.")
-        .showHelpAfterError()
-        .configureHelp({ showGlobalOptions: true })
-        .option("-k, --apiKey <string>", "Snowplow Console API key")
-        .option("-v, --verbose", "Enable verbose logging");
-    program
-        .command("init")
-        .description("Initialize the setup of Snowtype code generation in a project. Creates the `snowtype.config.json` file.")
-        .option("-i, --organizationId <string>", "organization ID")
-        .option("-t, --tracker <string>", "tracker to use")
-        .option("-l, --language <string>", "language to use")
-        .option("-o, --outpath <string>", "output path")
-        .action(actions_1.initAction);
-    program
-        .command("update")
-        .description("Checks for latest version updates in Data Structures and Tracking Scenarios.")
-        .option("-y, --yes", "updates all to latest without asking", false)
-        .action(actions_1.updateAction);
-    // generate
-    // - Does the codegen based on snowtype.config.json
-    program
-        .command("generate")
-        .description("Generates tracking code based on configuration on the `snowtype.config.json` file.")
-        .action(actions_1.generateAction);
-    // patch
-    // - options to specify TS ID, DS URI, IgluCentral URI
-    // - This will add an entry to the corresponding array in snowtype.config.json
-    program
-        .command("patch")
-        .description("Adds new Data Structures and Tracking Scenarios in the `snowtype.config.json` file.")
-        .option("-t, --trackingScenarioIds [value...]", "tracking scenario ID")
-        .option("-d, --dataStructures [value...]", "data structure URI")
-        .option("-i, --igluCentralSchemas [value...]", "iglu central URI")
-        .option("-y, --yes", "updates all to latest without asking", false)
-        .action(actions_1.patchAction);
-    program.addHelpText("before", (0, utils_1.renderHelp)()).addHelpText("after", `\n`);
-    await program.parseAsync(process.argv).catch((err) => {
-        handleCommanderError(err);
-    });
-}
-exports.main = main;
-function handleCommanderError(err) {
-    if (err instanceof extra_typings_1.CommanderError) {
-        const ignoreCodes = [
-            'commander.help',
-            'commander.version',
-            'commander.helpDisplayed'
-        ];
-        if (ignoreCodes.indexOf(err.code) > -1) {
-            return;
-        }
-    }
-    throw err;
-}

package/dist/commands/logger/index.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLogger = void 0;
-const utils_1 = require("../actions/utils");
-function createLogger() {
-    const logging = {
-        withVerbosity: (verbose) => {
-            const logger = {
-                success: (msg) => {
-                    console.log((0, utils_1.renderSuccess)(msg));
-                    return undefined;
-                },
-                warn: (msg) => {
-                    console.log((0, utils_1.renderWarn)(msg));
-                    return undefined;
-                },
-                log: (msg) => {
-                    console.log((0, utils_1.renderLog)(msg));
-                    return undefined;
-                },
-                diff: (current, next) => {
-                    console.log((0, utils_1.renderDiff)(current, next));
-                },
-                debug: (msg) => {
-                    if (verbose === true) {
-                        console.log((0, utils_1.renderDebug)(JSON.stringify(msg)));
-                    }
-                    return undefined;
-                },
-                error: (err) => {
-                    console.log((0, utils_1.renderErrorMessage)(err.message));
-                    if (verbose === true) {
-                        console.log(err);
-                    }
-                    return undefined;
-                }
-            };
-            return logger;
-        }
-    };
-    return logging;
-}
-exports.createLogger = createLogger;

package/dist/config/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateConfig = void 0;
-var schema_1 = require("./schema");
-Object.defineProperty(exports, "validateConfig", { enumerable: true, get: function () { return schema_1.validateConfig; } });

package/dist/config/schema.js

@@ -1,52 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateConfig = void 0;
-const joi_1 = __importDefault(require("joi"));
-const errors_1 = require("../errors");
-const IGLU_URL_REGEX = new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$");
-/** Joi schema for performing validation on snowtype.config.json files. */
-const ConfigSchema = joi_1.default.object()
-    .required()
-    .keys({
-    tracker: joi_1.default.string()
-        .required()
-        .valid("@snowplow/browser-tracker", "@snowplow/javascript-tracker", "@snowplow/node-tracker", "snowplow-android-tracker", "snowplow-ios-tracker", "snowplow-golang-tracker"),
-    language: joi_1.default.string()
-        .required()
-        .valid("typescript", "kotlin", "swift", "javascript", "go"),
-    outpath: joi_1.default.string().required(),
-    organizationId: joi_1.default.string()
-        .when("dataStructures", {
-        is: joi_1.default.array().min(1),
-        then: joi_1.default.required(),
-        otherwise: joi_1.default.optional(),
-    })
-        .when("trackingScenarioIds", {
-        is: joi_1.default.array().min(1),
-        then: joi_1.default.required(),
-        otherwise: joi_1.default.optional(),
-    }),
-    igluCentralSchemas: joi_1.default.array()
-        .optional()
-        .items(joi_1.default.string().regex(IGLU_URL_REGEX)),
-    dataStructures: joi_1.default.array()
-        .optional()
-        .items(joi_1.default.string().regex(IGLU_URL_REGEX)),
-    trackingScenarioIds: joi_1.default.array().optional().items(joi_1.default.string()),
-});
-const validateConfig = (rawConfig) => {
-    // Validate the provided configuration file using our Joi schema.
-    const result = ConfigSchema.validate(rawConfig, {
-        abortEarly: false,
-        convert: false,
-    });
-    if (result.error) {
-        throw new errors_1.SnowtypeConfigInvalidError(result.error.annotate());
-    }
-    // We can safely type cast the config, now that is has been validated.
-    return rawConfig;
-};
-exports.validateConfig = validateConfig;

package/dist/errors/index.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SnowtypeMissingLockError = exports.SnowtypeWriteLockError = exports.SnowtypeAuthError = exports.SnowtypeMissingOptionsError = exports.SnowtypeOptionError = exports.SnowtypeInternalError = exports.SnowtypeConfigInvalidError = exports.SnowtypeConfigMissingError = exports.SnowtypeConfigExistsError = exports.SnowtypeError = void 0;
-const ERROR_CODES = {
-    AuthError: 'Authentication failed. Check if your API key and organization ID are correct.',
-    ConfigAlreadyExists: `Snowtype config file already exists.`,
-    ConfigNotExists: `Snowtype config file does not exist in current directory. Start with running 'init'.`,
-    ConfigInvalid: `Snowtype config exists but it is invalid.`,
-    InternalError: 'An internal error occured.',
-    InvalidOption: 'Invalid option provided.',
-    MissingOptions: 'Action called with no options.',
-    WriteLockFile: 'Failed writing lock file.',
-    MissingLockFile: 'Missing lockfile. You might need to run `snowtype generate` first.'
-};
-const BUG_PROMPT = 'Please report a bug.';
-class SnowtypeError extends Error {
-    code;
-    constructor(code, message = '') {
-        const errMessage = ERROR_CODES[code].concat(message);
-        super(errMessage);
-        // hide this constructor calls from the stack
-        Error.captureStackTrace(this, this.constructor);
-        this.name = this.constructor.name;
-        this.code = code;
-    }
-}
-exports.SnowtypeError = SnowtypeError;
-class SnowtypeConfigExistsError extends SnowtypeError {
-    constructor() {
-        super('ConfigAlreadyExists');
-    }
-}
-exports.SnowtypeConfigExistsError = SnowtypeConfigExistsError;
-class SnowtypeConfigMissingError extends SnowtypeError {
-    constructor() {
-        super('ConfigNotExists');
-    }
-}
-exports.SnowtypeConfigMissingError = SnowtypeConfigMissingError;
-class SnowtypeConfigInvalidError extends SnowtypeError {
-    constructor(message) {
-        super('ConfigInvalid', message);
-    }
-}
-exports.SnowtypeConfigInvalidError = SnowtypeConfigInvalidError;
-class SnowtypeInternalError extends SnowtypeError {
-    constructor(message) {
-        super('InternalError', message.concat(BUG_PROMPT));
-    }
-}
-exports.SnowtypeInternalError = SnowtypeInternalError;
-class SnowtypeOptionError extends SnowtypeError {
-    constructor(option, value) {
-        const msg = `Value ${value} is an invalid ${option}.`;
-        super('InvalidOption', msg);
-    }
-}
-exports.SnowtypeOptionError = SnowtypeOptionError;
-class SnowtypeMissingOptionsError extends SnowtypeError {
-    constructor() {
-        super('MissingOptions');
-    }
-}
-exports.SnowtypeMissingOptionsError = SnowtypeMissingOptionsError;
-class SnowtypeAuthError extends SnowtypeError {
-    constructor() {
-        super('AuthError');
-    }
-}
-exports.SnowtypeAuthError = SnowtypeAuthError;
-class SnowtypeWriteLockError extends SnowtypeError {
-    constructor() {
-        super('WriteLockFile');
-    }
-}
-exports.SnowtypeWriteLockError = SnowtypeWriteLockError;
-class SnowtypeMissingLockError extends SnowtypeError {
-    constructor() {
-        super('MissingLockFile');
-    }
-}
-exports.SnowtypeMissingLockError = SnowtypeMissingLockError;

package/dist/utils/index.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceIgluSchemaPart = exports.splitIgluSchemaUrlParts = exports.hashSHA256 = void 0;
-const js_sha256_1 = require("js-sha256");
-function hashSHA256(content) {
-    const hash = js_sha256_1.sha256.create();
-    hash.update(content);
-    const hashHex = hash.hex();
-    return hashHex;
-}
-exports.hashSHA256 = hashSHA256;
-function splitIgluSchemaUrlParts(schema) {
-    /* Remove iglu: prefix to allow for it to be either included or not */
-    const schemaFormat = schema.replace("iglu:", "");
-    const [vendor, name, format, version] = schemaFormat.split("/");
-    return { vendor, name, format, version };
-}
-exports.splitIgluSchemaUrlParts = splitIgluSchemaUrlParts;
-function replaceIgluSchemaPart(schema, { vendor, name, format, version }) {
-    const schemaFormat = schema.replace("iglu:", "");
-    const [initialVendor, initialName, initialFormat, initialVersion] = schemaFormat.split("/");
-    return `iglu:${vendor || initialVendor}/${name || initialName}/${format || initialFormat}/${version || initialVersion}`;
-}
-exports.replaceIgluSchemaPart = replaceIgluSchemaPart;

package/dist/version.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PKG_VERSION = void 0;
-exports.PKG_VERSION = "0.1.1";