@snowplow/snowtype 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -1,10 +1,35 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const commands_1 = require("./commands");
4
- (0, commands_1.main)()
5
- .then(() => {
6
- return undefined;
7
- })
8
- .catch(() => {
9
- process.exitCode = 1;
10
- });
1
+ "use strict";var ne=Object.create;var at=Object.defineProperty;var oe=Object.getOwnPropertyDescriptor;var ie=Object.getOwnPropertyNames;var se=Object.getPrototypeOf,ae=Object.prototype.hasOwnProperty;var ce=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of ie(e))!ae.call(t,o)&&o!==r&&at(t,o,{get:()=>e[o],enumerable:!(n=oe(e,o))||n.enumerable});return t};var x=(t,e,r)=>(r=t!=null?ne(se(t)):{},ce(e||!t||!t.__esModule?at(r,"default",{value:t,enumerable:!0}):r,t));var ee=x(require("process")),q=require("@commander-js/extra-typings");var E=require("@inquirer/prompts");var pe={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."},ge="Please report a bug.",l=class extends Error{code;constructor(e,r=""){let n=pe[e].concat(r);super(n),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=e}},b=class extends l{constructor(){super("ConfigAlreadyExists")}},R=class extends l{constructor(){super("ConfigNotExists")}},F=class extends l{constructor(e){super("ConfigInvalid",e)}},w=class extends l{constructor(e){super("InternalError",e.concat(ge))}},T=class extends l{constructor(e,r){let n=`Value ${r} is an invalid ${e}.`;super("InvalidOption",n)}},G=class extends l{constructor(){super("MissingOptions")}},v=class extends l{constructor(){super("AuthError")}},z=class extends l{constructor(){super("WriteLockFile")}},_=class extends l{constructor(){super("MissingLockFile")}};var ct=x(require("got"));async function pt({schema:t}){return(await(0,ct.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${t.replace("iglu:","")}`)).body}var Q=x(require("got"));var gt=require("js-sha256");function Y(t){let e=gt.sha256.create();return e.update(t),e.hex()}function O(t){let e=t.replace("iglu:",""),[r,n,o,i]=e.split("/");return{vendor:r,name:n,format:o,version:i}}function ut(t,{vendor:e,name:r,format:n,version:o}){let i=t.replace("iglu:",""),[s,a,c,d]=i.split("/");return`iglu:${e||s}/${r||a}/${n||c}/${o||d}`}var f=class{apiKey;organizationId;accessToken;apiHost="https://console.snowplowanalytics.com/api/msc";constructor({apiKey:e,organizationId:r}){this.apiKey=e,this.organizationId=r}async fetchAccessToken(){if(this.accessToken)return this.accessToken;let e=`${this.apiHost}/v1/organizations/${this.organizationId}/credentials/v2/token`,{accessToken:r}=await(0,Q.default)(e,{headers:{"X-API-Key":this.apiKey}}).json();return this.accessToken=r,r}async fetchResource(e){let r=await this.fetchAccessToken();return(0,Q.default)(e,{headers:{Authorization:"Bearer "+r}}).json()}fetchSchemaVersion({schema:e}){let{vendor:r,name:n,format:o,version:i}=O(e),s=Y(`${this.organizationId}-${r}-${n}-${o}`),a=`${this.apiHost}/v1/organizations/${this.organizationId}/data-structures/v1/${s}/versions/${i}`;return this.fetchResource(a)}fetchSchemaHash({schema:e}){let{vendor:r,name:n,format:o}=O(e),i=Y(`${this.organizationId}-${r}-${n}-${o}`),s=`${this.apiHost}/v1/organizations/${this.organizationId}/data-structures/v1/${i}`;return this.fetchResource(s)}fetchTrackingScenario({scenarioId:e}){let r=`${this.apiHost}/v1/organizations/${this.organizationId}/tracking-scenarios/v1/${e}`;return this.fetchResource(r)}async authenticate(){try{return await this.fetchAccessToken(),!0}catch{return!1}}};var p=x(require("joi"));var lt=new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$"),ue=p.default.object().required().keys({tracker:p.default.string().required().valid("@snowplow/browser-tracker","@snowplow/javascript-tracker","@snowplow/node-tracker","snowplow-android-tracker","snowplow-ios-tracker","snowplow-golang-tracker"),language:p.default.string().required().valid("typescript","kotlin","swift","javascript","go"),outpath:p.default.string().required(),organizationId:p.default.string().when("dataStructures",{is:p.default.array().min(1),then:p.default.required(),otherwise:p.default.optional()}).when("trackingScenarioIds",{is:p.default.array().min(1),then:p.default.required(),otherwise:p.default.optional()}),igluCentralSchemas:p.default.array().optional().items(p.default.string().regex(lt)),dataStructures:p.default.array().optional().items(p.default.string().regex(lt)),trackingScenarioIds:p.default.array().optional().items(p.default.string())}),P=t=>{let e=ue.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new F(e.error.annotate());return t};var mt="snowtype.config.json",V=".snowtype-lock.json",dt="snowplow";var j={"@snowplow/javascript-tracker":[{value:"javascript",name:"JavaScript"}],"@snowplow/browser-tracker":[{value:"javascript",name:"JavaScript"},{value:"typescript",name:"TypeScript"}],"@snowplow/node-tracker":[{value:"javascript",name:"JavaScript"},{value:"typescript",name:"TypeScript"}],"snowplow-android-tracker":[{value:"kotlin",name:"Kotlin"}],"snowplow-ios-tracker":[{value:"swift",name:"Swift"}],"snowplow-golang-tracker":[{value:"go",name:"Go"}]};var C=require("process"),A=require("path"),y=require("fs");var ht=require("cli-spinner"),g=x(require("chalk"));function wt(){let t=new ht.Spinner;return t.setSpinnerString(18),t}var le="https://snowplow.io",me="https://docs.snowplow.io/docs/collecting-data/code-generation/",L={SUCCESS:"\u2714",LOG:"\u2139",DEBUG:"\u27A4",ERROR:"\u2717",WARN:"\u26A0"},St={LINK:"#9911BB",OPTION:"#9911DD"};function ft(t){return g.default.hex(St.LINK).bold(t)}function S(t){return g.default.hex(St.OPTION).italic(t)}function K(t,e){switch(t){case"h1":return g.default.bold.underline(e);default:return g.default.bold(e)}}function yt(){return`
2
+ ${K("h1","CLI Help")}
3
+
4
+ For more information visit the Snowplow website ${ft(le)}
5
+
6
+ For details see the CLI documentation ${ft(me)}
7
+
8
+ ${K("h2","How to get started")}
9
+ 1. Use ${g.default.cyanBright("snowtype init")} to initialize the setup.
10
+ 2. Use ${g.default.cyanBright("snowtype patch")} to add a Data Structure or Tracking Scenario.
11
+ 3. Use ${g.default.cyanBright("snowtype generate")} to generate tracking code.
12
+
13
+ ${K("h2","Available commands")}
14
+ To learn more about each CLI command, use the ${S("--help")} option, for example, ${S("snowtype init --help")}.
15
+
16
+ ${S("snowtype init")}
17
+ Initialize the setup of Snowtype code generation in a project. Creates the \`snowtype.config.json\` file.
18
+
19
+ ${S("snowtype patch")}
20
+ Adds new Data Structures and Tracking Scenarios in the \`snowtype.config.json\` file.
21
+
22
+ ${S("snowtype generate")}
23
+ Generates tracking code based on configuration on the \`snowtype.config.json\` file.
24
+
25
+ ${S("snowtype update")}
26
+ Checks for latest version updates in Data Structures and Tracking Scenarios.
27
+
28
+ ${K("h2","Debug")}
29
+ Use the ${S("-v")} to output verbose logs
30
+ `}function kt(t){let e=`${L.SUCCESS}: `;return g.default.cyanBright(e)+t}function xt(t){let e=`${L.WARN} Warning: `;return g.default.hex("#FFA500")(e)+t}function vt(t){let e=`${L.LOG} ${t}`;return g.default.yellowBright(e)}function Pt(t){let e=`${L.DEBUG} Debug: `;return g.default.magenta(e)+t}function Ct(t){let e=`${L.ERROR} Error: `;return g.default.redBright(e)+t}function At(t,e){let r=`- ${t}`,n=`+ ${e}`;return`
31
+ ${g.default.magenta(r)}
32
+ ${g.default.cyanBright(n)}
33
+ `}var It={...j},M=`./${mt}`;function Et(t){return t.length!==0}function bt(t){return Array.isArray(It[t])}function Tt(t,e){let r=It[t];return Array.isArray(r)?!!r.map(o=>o.value).includes(e):!1}function Ot(t){let e={organizationId:t.organizationId,tracker:t.tracker,language:t.language,outpath:t.outpath};return Object.assign({igluCentralSchemas:[],dataStructures:[],trackingScenarioIds:[]},e)}function H(t){let e=(0,A.resolve)((0,C.cwd)(),M);return(0,y.writeFileSync)(e,JSON.stringify(t,null,2))}function $(t){let e=(0,y.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function J(t){return(0,y.readFileSync)(t,{encoding:"utf-8"})}function B(){let t=(0,A.resolve)((0,C.cwd)(),M);return JSON.parse(J(t))}function Lt(t){return JSON.parse(J(t))}function I(){let t=(0,A.resolve)((0,C.cwd)(),M);if($(t)===!1)throw new R;let e=JSON.parse(J(t));return P(e)}function $t(){let t=(0,A.resolve)((0,C.cwd)(),M);if($(t)===!0){let e=J(t);try{throw P(JSON.parse(e)),new b}catch(r){if(r instanceof b)throw r}}}function Ut(t){return{javascript:".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go"}[t]||""}async function Dt(t,e){let r=[];for(let n of e){let o=await t.fetchTrackingScenario({scenarioId:n}),i=o.data[0]?.name,s=o.data[0]?.version,a=o.data[0]?.event;if(typeof a>"u")continue;let c=await t.fetchSchemaVersion({schema:a.source||""}),d=[],m=[];o.data[0]?.entities?.tracked?.forEach(k=>m.push(k.source)),await Promise.all(m.map(async k=>{let u=await t.fetchSchemaVersion({schema:k});d.push(u)})),r.push({scenario:{name:i||"",id:n},version:s||0,eventSchema:c,entitiesSchemas:d})}return r}function Nt(t,e){let r={trackingScenarios:{}};t.forEach(o=>{r.trackingScenarios[o.scenario.id]=o.version});let n=(0,A.resolve)((0,C.cwd)(),e,V);try{(0,y.writeFileSync)(n,JSON.stringify(r,null,2))}catch{throw new z}}async function Rt(t){return await Promise.all(t.map(async r=>JSON.parse(await pt({schema:r}))))}async function Ft(t,e){return await Promise.all(e.map(n=>t.fetchSchemaVersion({schema:n})))}function Gt(t,e,r){let n=Object.entries(t);n.length>0&&r.success("Available Tracking Scenario Updates"),n.forEach(([o,i])=>{let s=`${o}: version ${i.previous}`,a=`${o}: version ${i.next}`;r.diff(s,a)}),e.length>0&&r.success("Available Data Structures Updates"),e.forEach(o=>{let i=`${o.previous}`,s=`${o.next}`;r.diff(i,s)})}function zt(t){let e=t.optsWithGlobals();return{...e,apiKey:e.apiKey||process.env.SNOWPLOW_CONSOLE_API_KEY}}function W(t){return!!(Array.isArray(t)&&!t.length)}function _t(t){return t.type==="input"}function Vt(t){return t.type==="password"}function tt(t){return t.type==="select"}function jt(){return{withVerbosity:e=>({success:n=>{console.log(kt(n))},warn:n=>{console.log(xt(n))},log:n=>{console.log(vt(n))},diff:(n,o)=>{console.log(At(n,o))},debug:n=>{e===!0&&console.log(Pt(JSON.stringify(n)))},error:n=>{console.log(Ct(n.message)),e===!0&&console.log(n)}})}}function h(t){return(e,r)=>{let n=zt(r),o=jt(),i=wt(),s=o.withVerbosity(n.verbose),a=n.apiKey;return t(a,s,i,e).then(()=>Kt(i)).catch(c=>{de(c,s,i)})}}function de(t,e,r){throw Kt(r),e.error(t),t}function Kt(t){t.isSpinning()===!0&&t.stop(!0)}var U=[{type:"password",message:"Enter your Snowplow organization ID:",mask:!0,validate:Et},{type:"select",message:"Select the Snowplow Tracker to use:",choices:[{value:"@snowplow/javascript-tracker",name:"JavaScript Tracker"},{value:"@snowplow/browser-tracker",name:"Browser Tracker"},{value:"@snowplow/node-tracker",name:"Node Tracker"},{value:"snowplow-android-tracker",name:"Android Tracker"},{value:"snowplow-ios-tracker",name:"iOS Tracker"},{value:"snowplow-golang-tracker",name:"Golang Tracker"}]},{type:"select",message:"Select the language to use:"},{type:"input",message:"Enter the directory for Snowtype output:",default:"./snowtype"}],fe={organizationId:"",tracker:"",language:"",outpath:""};function D(t,e,r,n=""){if(n)return Promise.resolve(n);if(Object.prototype.hasOwnProperty.call(e,t)&&e[t]!=null){let o=e[t];if(typeof o=="string")return Promise.resolve(o);throw new w("Invalid default options.")}if(_t(r))return(0,E.input)(r);if(Vt(r))return(0,E.password)(r);if(tt(r))return(0,E.select)(r);throw new w("Unknown Prompt inquired.")}function he(t,e){return tt(e)&&(e.choices=t),e}async function we(t,e){let r={...fe};e.debug("Checking for existing configuration file.."),$t();let n=await D("organizationId",t,U[0]);r.organizationId=n;let o=await D("tracker",t,U[1]);if(!bt(o))throw new T("tracker",o);r.tracker=o;let i=j[o];if(!Array.isArray(i)||i.length===0)throw new w("Missing language entry.");let s;if(i.length===1){let c=i[0];if(typeof c>"u")throw new w("Missing language.");s=await D("language",t,U[2],c.value)}else s=await D("language",t,he(i,U[2]));if(!Tt(r.tracker,s))throw new T("language",s);r.language=s;let a=await D("outpath",t,U[3]);return r.outpath=a,e.debug("Assempling initialization options.."),r}async function Se(t,e,r,n){let o=await we(n,e);r.setSpinnerTitle("Initialising..."),r.isSpinning()===!1&&r.start(),e.debug("Creating configuration with options: ".concat(JSON.stringify(o)));let i=Ot(o);if(P(i),!await new f({apiKey:t,organizationId:i.organizationId}).authenticate())throw new v;e.success("Authentication succeeded"),H(i),e.success("Configuration created")}var et=h(Se);var Yt=require("process"),Qt=require("path");var Z=require("fs"),rt=require("path");var Mt="snowtype.config.json";function ye(t){(0,Z.writeFileSync)((0,rt.resolve)(process.cwd(),`./${Mt}`),JSON.stringify(t,null,2))}function Ht(t,e){try{let r=(0,Z.readFileSync)((0,rt.resolve)(process.cwd(),`./${Mt}`),{encoding:"utf-8"}),n=JSON.parse(r);return n[t].some(i=>i===e)||n[t].push(e),ye(n),!0}catch(r){return console.error(r),!1}}async function Jt(t,e){return await Promise.all(e.map(async n=>{let{version:o}=O(n),{deployments:i}=await t.fetchSchemaHash({schema:n}),s=i.reduce((a,c)=>new Date(c.ts)>new Date(a.ts)?c:a,i[0]);return s.version===o?{previous:n,next:n}:{previous:n,next:ut(n,{version:s.version})}}))}async function Bt(t,e,r){let{trackingScenarios:n}=r,o={};return await Promise.all(e.map(async i=>{let s=n[i];if(!s)return i;let a=(await t.fetchTrackingScenario({scenarioId:i})).data[0];return(a.version||0)>s&&(o[i]={previous:s,next:a.version}),i})),o}var Wt=require("process"),nt=require("path"),Zt=require("fs"),qt=require("mkdirp"),Xt=require("@snowplow/snowtype-core");function ke(t){t.debug("Checking for existing configuration.."),I(),t.success("Valid configuration found")}async function N(t,e,r){ke(e),r.setSpinnerTitle("Generating..."),r.isSpinning()===!1&&r.start();let n=B();W(n.dataStructures)&&W(n.igluCentralSchemas)&&W(n.trackingScenarioIds)&&e.warn("Data Structures, Schemas and Tracking Scenarios are empty.");let o=new f({apiKey:t,organizationId:n.organizationId});if(!await o.authenticate())throw new v;let s=await Dt(o,n.trackingScenarioIds),a=await Rt(n.igluCentralSchemas),c=await Ft(o,n.dataStructures),d={language:n.language,tracker:n.tracker,schemas:[...a,...c],dataProducts:s},m=await(0,Xt.generate)(d);e.success("Code generated, writing...");let k=m?.lines.join(`
34
+ `),u=(0,nt.resolve)((0,Wt.cwd)(),n.outpath);qt.mkdirp.sync(u);let X=dt+Ut(n.language);(0,Zt.writeFileSync)((0,nt.resolve)(u,X),k),Nt(s,n.outpath)}var ot=h(N);var xe={yes:!1};function ve(t,e){let r={...xe,...t};return e.debug("Checking for existing configuration.."),I(),e.success("Valid configuration found"),r}async function Pe(t,e,r,n){let o=ve(n,e);e.debug("Starting update process with options: ".concat(JSON.stringify(o)));let i=B(),s=(0,Qt.resolve)((0,Yt.cwd)(),i.outpath,V),a=new f({apiKey:t,organizationId:i.organizationId});r.setSpinnerTitle("Checking for updates..."),r.isSpinning()===!1&&r.start();let c={};if(!$(s)&&i.trackingScenarioIds.length)throw new _;if($(s)&&i.trackingScenarioIds.length){let u=Lt(s);c=await Bt(a,i.trackingScenarioIds,u)}let m=(await Jt(a,i.dataStructures)).filter(u=>u.previous!==u.next);if((Object.entries(c).length>0||m.length>0)===!0){if(e.success("Available updates found!"),Gt(c,m,e),o.yes===!0)return m.length>0&&(m.forEach(u=>{let X=i.dataStructures.indexOf(u.previous);i.dataStructures[X]=u.next}),H(i)),e.debug("Applying the updates.."),N(t,e,r);e.log("No updates applied"),e.log("To apply the available updates run update with --yes flag")}else e.success("No updates found. Everything is up-to-date!");return Promise.resolve(void 0)}var it=h(Pe);var Ce={trackingScenarioIds:[],dataStructures:[],igluCentralSchemas:[],yes:!1};function Ae(t,e){let r={...Ce,...t};if(Object.values(r).every(n=>typeof n=="boolean"||n.length===0))throw new G;return e.debug("Checking for existing configuration.."),I(),e.success("Valid configuration found"),r}function Ie(t,e,r,n){let o=Ae(n,e);return e.debug("Starting patch process with options: ".concat(JSON.stringify(o))),Object.entries(o).forEach(([s,a])=>{s!=="yes"&&Array.isArray(a)&&a.length!==0&&a.forEach(c=>{Ht(s,c)})}),e.success("Configuration patched"),o.yes===!0?N(t,e,r):(e.log("Code is not generated yet for the patched configuration"),Promise.resolve(void 0))}var st=h(Ie);var te="0.1.2";async function re(){await import("dotenv/config");let t=new q.Command;t.exitOverride(),t.version(te,void 0,"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:!0}).option("-k, --apiKey <string>","Snowplow Console API key").option("-v, --verbose","Enable verbose logging"),t.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(et),t.command("update").description("Checks for latest version updates in Data Structures and Tracking Scenarios.").option("-y, --yes","updates all to latest without asking",!1).action(it),t.command("generate").description("Generates tracking code based on configuration on the `snowtype.config.json` file.").action(ot),t.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",!1).action(st),t.addHelpText("before",yt()).addHelpText("after",`
35
+ `),await t.parseAsync(ee.argv).catch(e=>{Ee(e)})}function Ee(t){if(!(t instanceof q.CommanderError&&["commander.help","commander.version","commander.helpDisplayed"].indexOf(t.code)>-1))throw t}re().then(()=>{}).catch(()=>{process.exitCode=1});
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@snowplow/snowtype",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "A code generator CLI for faster and type-safe Snowplow tracking code",
5
5
  "author": "Peter Perlepes <peter@snowplowanalytics.com>",
6
6
  "homepage": "https://snowplow.io/",
@@ -28,6 +28,7 @@
28
28
  "@types/got": "^9.6.12",
29
29
  "@types/jest": "^29.5.8",
30
30
  "@types/node": "^20.9.0",
31
+ "esbuild": "^0.19.11",
31
32
  "jest": "^29.7.0",
32
33
  "rimraf": "^5.0.5",
33
34
  "ts-jest": "^29.1.1",
@@ -36,12 +37,15 @@
36
37
  "typescript": "5.2.2"
37
38
  },
38
39
  "scripts": {
39
- "prebuild": "node ./scripts/version.js",
40
+ "fix-version": "node ./scripts/version.js",
41
+ "prebuild": "npm run fix-version",
40
42
  "build": "tsc",
41
- "lint": "eslint",
42
- "lint:fix": "eslint --fix",
43
- "prepack": "npm run build",
44
- "test": "jest"
43
+ "lint": "eslint src",
44
+ "lint:fix": "eslint src --fix",
45
+ "format": "prettier --write src",
46
+ "test": "jest --passWithNoTests",
47
+ "prebuild:production": "npm run fix-version && rimraf ./dist",
48
+ "build:production": "esbuild --bundle --packages=external --platform=node --target=es2022 --outdir=dist --minify src/index.ts"
45
49
  },
46
50
  "engines": {
47
51
  "node": ">=18"
@@ -50,8 +54,10 @@
50
54
  "snowplow",
51
55
  "analytics"
52
56
  ],
53
- "types": "dist/index.d.ts",
54
57
  "bin": {
55
58
  "snowtype": "bin/bin"
59
+ },
60
+ "publishConfig": {
61
+ "access": "public"
56
62
  }
57
63
  }
@@ -1,60 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.ConsoleAPI = void 0;
7
- const got_1 = __importDefault(require("got"));
8
- const utils_1 = require("../utils");
9
- class ConsoleAPI {
10
- apiKey;
11
- organizationId;
12
- accessToken;
13
- apiHost = "https://console.snowplowanalytics.com/api/msc";
14
- constructor({ apiKey, organizationId }) {
15
- this.apiKey = apiKey;
16
- this.organizationId = organizationId;
17
- }
18
- async fetchAccessToken() {
19
- if (this.accessToken) {
20
- return this.accessToken;
21
- }
22
- const accessTokenUrl = `${this.apiHost}/v1/organizations/${this.organizationId}/credentials/v2/token`;
23
- const { accessToken } = await (0, got_1.default)(accessTokenUrl, {
24
- headers: { "X-API-Key": this.apiKey },
25
- }).json();
26
- this.accessToken = accessToken;
27
- return accessToken;
28
- }
29
- /* TODO allow for adding params in the resourceUrl before reaching fetchResource */
30
- async fetchResource(resourceUrl) {
31
- const token = await this.fetchAccessToken();
32
- return (0, got_1.default)(resourceUrl, {
33
- headers: { Authorization: "Bearer " + token },
34
- }).json();
35
- }
36
- /* Todo, return schema type */
37
- async fetchSchemaVersion({ schema, }) {
38
- const { vendor, name, format, version } = (0, utils_1.splitIgluSchemaUrlParts)(schema);
39
- const schemaSHA256 = (0, utils_1.hashSHA256)(`${this.organizationId}-${vendor}-${name}-${format}`);
40
- const schemaVersionUrl = `${this.apiHost}/v1/organizations/${this.organizationId}/data-structures/v1/${schemaSHA256}/versions/${version}`;
41
- return await this.fetchResource(schemaVersionUrl);
42
- }
43
- async fetchSchemaHash({ schema }) {
44
- const { vendor, name, format } = (0, utils_1.splitIgluSchemaUrlParts)(schema);
45
- const schemaSHA256 = (0, utils_1.hashSHA256)(`${this.organizationId}-${vendor}-${name}-${format}`);
46
- const schemaVersionUrl = `${this.apiHost}/v1/organizations/${this.organizationId}/data-structures/v1/${schemaSHA256}`;
47
- return await this.fetchResource(schemaVersionUrl);
48
- }
49
- async fetchTrackingScenario({ scenarioId }) {
50
- const schemaVersionUrl = `${this.apiHost}/v1/organizations/${this.organizationId}/tracking-scenarios/v1/${scenarioId}`;
51
- return await this.fetchResource(schemaVersionUrl);
52
- }
53
- // TODO - refine all of it
54
- async authenticate() {
55
- return this.fetchAccessToken()
56
- .then((token) => !!token)
57
- .catch(() => false);
58
- }
59
- }
60
- exports.ConsoleAPI = ConsoleAPI;
@@ -1,11 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.fetchIgluCentralSchema = void 0;
7
- const got_1 = __importDefault(require("got"));
8
- async function fetchIgluCentralSchema({ schema, }) {
9
- return (await (0, got_1.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${schema.replace("iglu:", "")}`)).body;
10
- }
11
- exports.fetchIgluCentralSchema = fetchIgluCentralSchema;
package/dist/api/index.js DELETED
@@ -1,18 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./fetchIgluCentralSchema"), exports);
18
- __exportStar(require("./ConsoleAPI"), exports);
@@ -1,121 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.checkScenarioUpdates = exports.createStorageJSON = exports.checkDataStructureUpdates = exports.addConfigAttribute = exports.createConfigFile = void 0;
4
- const fs_1 = require("fs");
5
- const path_1 = require("path");
6
- const utils_1 = require("../utils");
7
- const DEFAULT_CONFIG_NAME = 'snowtype.config.json';
8
- const DEFAULT_CONFIG = {
9
- tracker: "@snowplow/browser-tracker",
10
- language: "typescript",
11
- outpath: "./snowtype"
12
- };
13
- const DEFAULT_STORAGE_FILE = '.snowtype-lock.json';
14
- function writeToConfig(config) {
15
- (0, fs_1.writeFileSync)((0, path_1.resolve)(process.cwd(), `./${DEFAULT_CONFIG_NAME}`), JSON.stringify(config, null, 2));
16
- }
17
- function createConfigFile(partialConfig) {
18
- const config = { ...DEFAULT_CONFIG, ...partialConfig };
19
- try {
20
- writeToConfig(config);
21
- return true;
22
- }
23
- catch (error) {
24
- console.error(error);
25
- return false;
26
- }
27
- }
28
- exports.createConfigFile = createConfigFile;
29
- // TODO refactor file stuff
30
- function addConfigAttribute(attribute, value) {
31
- try {
32
- const rawConfig = (0, fs_1.readFileSync)((0, path_1.resolve)(process.cwd(), `./${DEFAULT_CONFIG_NAME}`), { encoding: "utf-8" });
33
- const parsedConfig = JSON.parse(rawConfig);
34
- const valueExists = parsedConfig[attribute].some(entry => entry === value);
35
- if (!valueExists) {
36
- parsedConfig[attribute].push(value);
37
- }
38
- // TODO, run validate after patch and if failed abort ?
39
- writeToConfig(parsedConfig);
40
- return true;
41
- }
42
- catch (error) {
43
- console.error(error);
44
- return false;
45
- }
46
- }
47
- exports.addConfigAttribute = addConfigAttribute;
48
- /**
49
- *
50
- *
51
- * @export
52
- * @param {ConsoleAPI} consoleApi
53
- * @param {string[]} dataStructures Array with Console data structure iglu URLs
54
- * @return {*} {Promise<string[]>}
55
- */
56
- async function checkDataStructureUpdates(consoleApi, dataStructures) {
57
- // Should we store the time we fetched the previous URL ?
58
- // Does newest means by time uploaded or by version, should this be an option ?
59
- const schemaUpdates = await Promise.all(dataStructures.map(async (dataStructureUrl) => {
60
- const { version } = (0, utils_1.splitIgluSchemaUrlParts)(dataStructureUrl);
61
- const { deployments } = (await consoleApi.fetchSchemaHash({ schema: dataStructureUrl }));
62
- // Should we get only PROD ? (PROLLY)
63
- // With one pass, find the latest.
64
- const latestDeployment = deployments.reduce((accum, cur) => {
65
- const currentTs = new Date(cur.ts);
66
- if (currentTs > new Date(accum.ts)) {
67
- return cur;
68
- }
69
- return accum;
70
- }, deployments[0]);
71
- if (latestDeployment.version === version) {
72
- return {
73
- previous: dataStructureUrl,
74
- next: dataStructureUrl
75
- };
76
- }
77
- return {
78
- previous: dataStructureUrl,
79
- next: (0, utils_1.replaceIgluSchemaPart)(dataStructureUrl, { version: latestDeployment.version })
80
- };
81
- }));
82
- return schemaUpdates;
83
- }
84
- exports.checkDataStructureUpdates = checkDataStructureUpdates;
85
- // the storage JSON file. Will it go on the `snowtype` folder or in a `.snowtype` directory ?
86
- function createStorageJSON({ trackingScenarios }) {
87
- try {
88
- const latestGenerationConfig = { trackingScenarios: trackingScenarios.map(ts => ({ [ts.id]: ts.version })) };
89
- (0, fs_1.writeFileSync)((0, path_1.resolve)(process.cwd(), `./${DEFAULT_CONFIG_NAME}/${DEFAULT_STORAGE_FILE}`), JSON.stringify(latestGenerationConfig, null, 2));
90
- return true;
91
- }
92
- catch (error) {
93
- console.error(error);
94
- return false;
95
- }
96
- }
97
- exports.createStorageJSON = createStorageJSON;
98
- // replace latestGenerationConfig type with what we decide. Created from createStorageJSON
99
- // Just check if there is any update ? The generator for now will regenerate all anyway.
100
- async function checkScenarioUpdates(consoleApi, trackingScenarioIds, latestGenerationConfig) {
101
- // trackingScenarios would be [ts.id]: ts.version
102
- const { trackingScenarios } = latestGenerationConfig;
103
- const updates = {};
104
- await Promise.all(trackingScenarioIds.map(async (trackingScenarioId) => {
105
- const existingScenarioGeneratedVersion = trackingScenarios[trackingScenarioId];
106
- // should we check if trackingScenarioId exists in the storage, and if not notify for update ?
107
- if (!existingScenarioGeneratedVersion) {
108
- return trackingScenarioId;
109
- }
110
- const scenario = (await consoleApi.fetchTrackingScenario({ scenarioId: trackingScenarioId })).data[0];
111
- if ((scenario.version || 0) > existingScenarioGeneratedVersion) {
112
- updates[trackingScenarioId] = {
113
- previous: existingScenarioGeneratedVersion,
114
- next: scenario.version
115
- };
116
- }
117
- return trackingScenarioId;
118
- }));
119
- return updates;
120
- }
121
- exports.checkScenarioUpdates = checkScenarioUpdates;
@@ -1,53 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.TRACKER_LANGUAGES = exports.DEFAULT_LOCK = exports.DEFAULT_FILENAME = exports.DEFAULT_STORAGE_FILENAME = exports.DEFAULT_CONFIG_NAME = void 0;
4
- exports.DEFAULT_CONFIG_NAME = 'snowtype.config.json';
5
- exports.DEFAULT_STORAGE_FILENAME = '.snowtype-lock.json';
6
- exports.DEFAULT_FILENAME = 'snowplow';
7
- exports.DEFAULT_LOCK = '.snowtype.json';
8
- exports.TRACKER_LANGUAGES = {
9
- '@snowplow/javascript-tracker': [
10
- {
11
- value: 'javascript',
12
- name: 'JavaScript'
13
- }
14
- ],
15
- '@snowplow/browser-tracker': [
16
- {
17
- value: 'javascript',
18
- name: 'JavaScript'
19
- },
20
- {
21
- value: 'typescript',
22
- name: 'TypeScript'
23
- }
24
- ],
25
- '@snowplow/node-tracker': [
26
- {
27
- value: 'javascript',
28
- name: 'JavaScript'
29
- },
30
- {
31
- value: 'typescript',
32
- name: 'TypeScript'
33
- }
34
- ],
35
- 'snowplow-android-tracker': [
36
- {
37
- value: 'kotlin',
38
- name: 'Kotlin'
39
- }
40
- ],
41
- 'snowplow-ios-tracker': [
42
- {
43
- value: 'swift',
44
- name: 'Swift'
45
- }
46
- ],
47
- 'snowplow-golang-tracker': [
48
- {
49
- value: 'go',
50
- name: 'Go'
51
- }
52
- ]
53
- };
@@ -1,30 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.act = void 0;
4
- const logger_1 = require("../logger");
5
- const utils_1 = require("./utils");
6
- function act(action) {
7
- return (options, cmd) => {
8
- const globalOptions = (0, utils_1.getGlobalOptions)(cmd);
9
- const logging = (0, logger_1.createLogger)();
10
- const spinner = (0, utils_1.createSpinner)();
11
- const logger = logging.withVerbosity(globalOptions.verbose);
12
- const apiKey = globalOptions.apiKey;
13
- return action(apiKey, logger, spinner, options)
14
- .then(() => stopSpinner(spinner))
15
- .catch((err) => {
16
- errHandle(err, logger, spinner);
17
- });
18
- };
19
- }
20
- exports.act = act;
21
- function errHandle(err, logger, spinner) {
22
- stopSpinner(spinner);
23
- logger.error(err);
24
- throw err;
25
- }
26
- function stopSpinner(spinner) {
27
- if (spinner.isSpinning() === true) {
28
- spinner.stop(true);
29
- }
30
- }
@@ -1,59 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.generateAction = exports.execGenerate = void 0;
4
- const process_1 = require("process");
5
- const path_1 = require("path");
6
- const fs_1 = require("fs");
7
- const mkdirp_1 = require("mkdirp");
8
- const snowtype_core_1 = require("@snowplow/snowtype-core");
9
- const api_1 = require("../../api");
10
- const errors_1 = require("../../errors");
11
- const constants_1 = require("./constants");
12
- const utils_1 = require("./utils");
13
- const dispatch_1 = require("./dispatch");
14
- function checkGenerateOptions(logger) {
15
- logger.debug("Checking for existing configuration..");
16
- (0, utils_1.guardConfigExistsValid)();
17
- logger.success("Valid configuration found");
18
- }
19
- async function execGenerate(apiKey, logger, spinner) {
20
- checkGenerateOptions(logger);
21
- spinner.setSpinnerTitle("Generating...");
22
- if (spinner.isSpinning() === false) {
23
- spinner.start();
24
- }
25
- const config = (0, utils_1.getConfig)();
26
- if ((0, utils_1.isEmpty)(config.dataStructures) &&
27
- (0, utils_1.isEmpty)(config.igluCentralSchemas) &&
28
- (0, utils_1.isEmpty)(config.trackingScenarioIds)) {
29
- logger.warn("Data Structures, Schemas and Tracking Scenarios are empty.");
30
- }
31
- const consoleApi = new api_1.ConsoleAPI({
32
- apiKey,
33
- organizationId: config.organizationId,
34
- });
35
- // we could also throw properly in api
36
- const isAuthenticated = await consoleApi.authenticate();
37
- if (!isAuthenticated) {
38
- throw new errors_1.SnowtypeAuthError();
39
- }
40
- const dataProducts = await (0, utils_1.mkDataProducts)(consoleApi, config.trackingScenarioIds);
41
- const igluSchemas = await (0, utils_1.mkIgluSchemas)(config.igluCentralSchemas);
42
- const dataStructures = await (0, utils_1.mkDataStructures)(consoleApi, config.dataStructures);
43
- const genCfg = {
44
- language: config.language,
45
- tracker: config.tracker,
46
- schemas: [...igluSchemas, ...dataStructures],
47
- dataProducts,
48
- };
49
- const generationOutput = await (0, snowtype_core_1.generate)(genCfg);
50
- logger.success("Code generated, writing...");
51
- const output = generationOutput?.lines.join("\n");
52
- const trueDir = (0, path_1.resolve)((0, process_1.cwd)(), config.outpath);
53
- mkdirp_1.mkdirp.sync(trueDir);
54
- const trueFile = constants_1.DEFAULT_FILENAME + (0, utils_1.getExtension)(config.language);
55
- (0, fs_1.writeFileSync)((0, path_1.resolve)(trueDir, trueFile), output);
56
- (0, utils_1.writeLockFile)(dataProducts, config.outpath);
57
- }
58
- exports.execGenerate = execGenerate;
59
- exports.generateAction = (0, dispatch_1.act)(execGenerate);
@@ -1,11 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.patchAction = exports.generateAction = exports.updateAction = exports.initAction = void 0;
4
- var init_1 = require("./init");
5
- Object.defineProperty(exports, "initAction", { enumerable: true, get: function () { return init_1.initAction; } });
6
- var update_1 = require("./update");
7
- Object.defineProperty(exports, "updateAction", { enumerable: true, get: function () { return update_1.updateAction; } });
8
- var generate_1 = require("./generate");
9
- Object.defineProperty(exports, "generateAction", { enumerable: true, get: function () { return generate_1.generateAction; } });
10
- var patch_1 = require("./patch");
11
- Object.defineProperty(exports, "patchAction", { enumerable: true, get: function () { return patch_1.patchAction; } });
@@ -1,153 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.initAction = void 0;
4
- const prompts_1 = require("@inquirer/prompts");
5
- const errors_1 = require("../../errors");
6
- const api_1 = require("../../api");
7
- const config_1 = require("../../config");
8
- const constants_1 = require("./constants");
9
- const utils_1 = require("./utils");
10
- const types_1 = require("./types");
11
- const dispatch_1 = require("./dispatch");
12
- const initPrompts = [
13
- {
14
- type: "password",
15
- message: "Enter your Snowplow organization ID:",
16
- mask: true,
17
- validate: utils_1.isNonEmpty,
18
- },
19
- {
20
- type: "select",
21
- message: "Select the Snowplow Tracker to use:",
22
- choices: [
23
- {
24
- value: "@snowplow/javascript-tracker",
25
- name: "JavaScript Tracker",
26
- },
27
- {
28
- value: "@snowplow/browser-tracker",
29
- name: "Browser Tracker",
30
- },
31
- {
32
- value: "@snowplow/node-tracker",
33
- name: "Node Tracker",
34
- },
35
- {
36
- value: "snowplow-android-tracker",
37
- name: "Android Tracker",
38
- },
39
- {
40
- value: "snowplow-ios-tracker",
41
- name: "iOS Tracker",
42
- },
43
- {
44
- value: "snowplow-golang-tracker",
45
- name: "Golang Tracker",
46
- },
47
- ],
48
- },
49
- {
50
- // placeholder
51
- type: "select",
52
- message: "Select the language to use:",
53
- },
54
- {
55
- type: "input",
56
- message: "Enter the directory for Snowtype output:",
57
- default: "./snowtype",
58
- },
59
- ];
60
- const defaultOptions = {
61
- organizationId: "",
62
- tracker: "",
63
- language: "",
64
- outpath: "",
65
- };
66
- function getOrAsk(key, opts, inquire, override = "") {
67
- if (override) {
68
- return Promise.resolve(override);
69
- }
70
- // @ts-expect-error index signature
71
- if (Object.prototype.hasOwnProperty.call(opts, key) && opts[key] != null) {
72
- // @ts-expect-error index signature
73
- const provided = opts[key];
74
- if (typeof provided === "string") {
75
- return Promise.resolve(provided);
76
- }
77
- throw new errors_1.SnowtypeInternalError("Invalid default options.");
78
- }
79
- if ((0, types_1.isInputPrompt)(inquire)) {
80
- return (0, prompts_1.input)(inquire);
81
- }
82
- if ((0, types_1.isPasswordPrompt)(inquire)) {
83
- return (0, prompts_1.password)(inquire);
84
- }
85
- if ((0, types_1.isSelectPrompt)(inquire)) {
86
- return (0, prompts_1.select)(inquire);
87
- }
88
- throw new errors_1.SnowtypeInternalError("Unknown Prompt inquired.");
89
- }
90
- function mkChoices(languages, prompt) {
91
- if ((0, types_1.isSelectPrompt)(prompt)) {
92
- prompt.choices = languages;
93
- }
94
- return prompt;
95
- }
96
- async function checkInitOptions(options, logger) {
97
- const initOptions = { ...defaultOptions };
98
- logger.debug("Checking for existing configuration file..");
99
- (0, utils_1.guardConfigNotExistsValid)();
100
- const orgId = await getOrAsk("organizationId", options, initPrompts[0]);
101
- initOptions.organizationId = orgId;
102
- const tracker = await getOrAsk("tracker", options, initPrompts[1]);
103
- if (!(0, utils_1.isValidTracker)(tracker)) {
104
- throw new errors_1.SnowtypeOptionError("tracker", tracker);
105
- }
106
- initOptions.tracker = tracker;
107
- const langs = constants_1.TRACKER_LANGUAGES[tracker];
108
- if (!Array.isArray(langs) || langs.length === 0) {
109
- throw new errors_1.SnowtypeInternalError("Missing language entry.");
110
- }
111
- let language;
112
- if (langs.length === 1) {
113
- const languageSelection = langs[0];
114
- if (typeof languageSelection === "undefined") {
115
- throw new errors_1.SnowtypeInternalError("Missing language.");
116
- }
117
- language = await getOrAsk("language", options, initPrompts[2], languageSelection.value);
118
- }
119
- else {
120
- language = await getOrAsk("language", options, mkChoices(langs, initPrompts[2]));
121
- }
122
- if (!(0, utils_1.isValidLanguage)(initOptions.tracker, language)) {
123
- throw new errors_1.SnowtypeOptionError("language", language);
124
- }
125
- initOptions.language = language;
126
- const outpath = await getOrAsk("outpath", options, initPrompts[3]);
127
- initOptions.outpath = outpath;
128
- logger.debug("Assempling initialization options..");
129
- return initOptions;
130
- }
131
- async function execInit(apiKey, logger, spinner, options) {
132
- const initOpts = await checkInitOptions(options, logger);
133
- spinner.setSpinnerTitle("Initialising...");
134
- if (spinner.isSpinning() === false) {
135
- spinner.start();
136
- }
137
- logger.debug("Creating configuration with options: ".concat(JSON.stringify(initOpts)));
138
- const config = (0, utils_1.completeInitConfig)(initOpts);
139
- // @ts-expect-error fix
140
- (0, config_1.validateConfig)(config);
141
- const consoleApi = new api_1.ConsoleAPI({
142
- apiKey,
143
- organizationId: config.organizationId,
144
- });
145
- const isAuthenticated = await consoleApi.authenticate();
146
- if (!isAuthenticated) {
147
- throw new errors_1.SnowtypeAuthError();
148
- }
149
- logger.success("Authentication succeeded");
150
- (0, utils_1.writeConfigToFile)(config);
151
- logger.success("Configuration created");
152
- }
153
- exports.initAction = (0, dispatch_1.act)(execInit);