@snowplow/snowtype 0.1.2 → 0.2.1

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.
Files changed (2) hide show
  1. package/dist/index.js +12 -12
  2. package/package.json +2 -2
package/dist/index.js CHANGED
@@ -1,13 +1,13 @@
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`
1
+ "use strict";var se=Object.create;var ct=Object.defineProperty;var ae=Object.getOwnPropertyDescriptor;var ce=Object.getOwnPropertyNames;var pe=Object.getPrototypeOf,ge=Object.prototype.hasOwnProperty;var ue=(t,e,n,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of ce(e))!ge.call(t,r)&&r!==n&&ct(t,r,{get:()=>e[r],enumerable:!(o=ae(e,r))||o.enumerable});return t};var v=(t,e,n)=>(n=t!=null?se(pe(t)):{},ue(e||!t||!t.__esModule?ct(n,"default",{value:t,enumerable:!0}):n,t));var oe=v(require("process")),X=require("@commander-js/extra-typings");var k=require("@inquirer/prompts");var fe={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."},de="Please report a bug.",f=class extends Error{code;constructor(e,n=""){let o=fe[e].concat(n);super(o),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=e}},O=class extends f{constructor(){super("ConfigAlreadyExists")}},G=class extends f{constructor(){super("ConfigNotExists")}},z=class extends f{constructor(e){super("ConfigInvalid",e)}},w=class extends f{constructor(e){super("InternalError",e.concat(de))}},T=class extends f{constructor(e,n){let o=`Value ${n} is an invalid ${e}.`;super("InvalidOption",o)}},_=class extends f{constructor(){super("MissingOptions")}},x=class extends f{constructor(){super("AuthError")}},j=class extends f{constructor(){super("WriteLockFile")}},V=class extends f{constructor(){super("MissingLockFile")}};var pt=v(require("got"));async function gt({schema:t}){return(await(0,pt.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${t.replace("iglu:","")}`)).body}var Q=v(require("got"));var ut=require("js-sha256");function Y(t){let e=ut.sha256.create();return e.update(t),e.hex()}function L(t){let e=t.replace("iglu:",""),[n,o,r,i]=e.split("/");return{vendor:n,name:o,format:r,version:i}}function ft(t,{vendor:e,name:n,format:o,version:r}){let i=t.replace("iglu:",""),[s,a,p,h]=i.split("/");return`iglu:${e||s}/${n||a}/${o||p}/${r||h}`}var l=class{apiKey;organizationId;accessToken;apiHost="https://console.snowplowanalytics.com/api/msc";constructor({apiKey:e,organizationId:n}){this.apiKey=e,this.organizationId=n}async fetchAccessToken(){if(this.accessToken)return this.accessToken;let e=`${this.apiHost}/v1/organizations/${this.organizationId}/credentials/v2/token`,{accessToken:n}=await(0,Q.default)(e,{headers:{"X-API-Key":this.apiKey}}).json();return this.accessToken=n,n}async fetchResource(e){let n=await this.fetchAccessToken();return(0,Q.default)(e,{headers:{Authorization:"Bearer "+n}}).json()}fetchSchemaVersion({schema:e}){let{vendor:n,name:o,format:r,version:i}=L(e),s=Y(`${this.organizationId}-${n}-${o}-${r}`),a=`${this.apiHost}/v1/organizations/${this.organizationId}/data-structures/v1/${s}/versions/${i}`;return this.fetchResource(a)}fetchSchemaHash({schema:e}){let{vendor:n,name:o,format:r}=L(e),i=Y(`${this.organizationId}-${n}-${o}-${r}`),s=`${this.apiHost}/v1/organizations/${this.organizationId}/data-structures/v1/${i}`;return this.fetchResource(s)}async fetchEventSpecification({eventSpecificationId:e}){let n=`${this.apiHost}/v1/organizations/${this.organizationId}/tracking-scenarios/v2/${e}`;return await this.fetchResource(n)}async fetchDataProduct({dataProductId:e}){let n=`${this.apiHost}/v1/organizations/${this.organizationId}/data-products/v1/${e}`;return await this.fetchResource(n)}async authenticate(){try{return await this.fetchAccessToken(),!0}catch{return!1}}};var c=v(require("joi"));var dt=new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$"),le=c.default.object().required().keys({tracker:c.default.string().required().valid("@snowplow/browser-tracker","@snowplow/javascript-tracker","@snowplow/node-tracker","snowplow-android-tracker","snowplow-ios-tracker","snowplow-golang-tracker"),language:c.default.string().required().valid("typescript","kotlin","swift","javascript","go"),outpath:c.default.string().required(),organizationId:c.default.string().when("dataStructures",{is:c.default.array().min(1),then:c.default.required(),otherwise:c.default.optional()}).when("eventSpecificationIds",{is:c.default.array().min(1),then:c.default.required(),otherwise:c.default.optional()}).when("dataProductIds",{is:c.default.array().min(1),then:c.default.required(),otherwise:c.default.optional()}),igluCentralSchemas:c.default.array().optional().items(c.default.string().regex(dt)),dataStructures:c.default.array().optional().items(c.default.string().regex(dt)),eventSpecificationIds:c.default.array().optional().items(c.default.string()),dataProductIds:c.default.array().optional().items(c.default.string())}),P=t=>{let e=le.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new z(e.error.annotate());return t};var lt="snowtype.config.json",M=".snowtype-lock.json",mt="snowplow";var H={"@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 I=require("process"),C=require("path"),y=require("fs");var me=["iglu:com.snowplowanalytics.snowplow/page_ping/jsonschema/1-0-0","iglu:com.snowplowanalytics.snowplow/link_click/jsonschema/1-0-1","iglu:com.snowplowanalytics.snowplow/page_view/jsonschema/1-0-0","iglu:com.snowplowanalytics.mobile/screen_view/jsonschema/1-0-0"];async function ht(t,e){let n=[];for(let r of e)n.push(t.fetchDataProduct({dataProductId:r}));return(await Promise.all(n)).map(({data:r})=>r[0]?.trackingScenarios).flat().map(r=>r?.id).filter(r=>!!r)}async function wt(t,e,n){let o=[];for(let r of e){let i=await t.fetchEventSpecification({eventSpecificationId:r}),s=i.data[0]?.name,a=i.data[0]?.version,p=i.data[0]?.event;if(p?.source&&me.indexOf(p.source)!==-1){n.warn("Currently you cannot generate code for `Standard` events. Skipping...");continue}let h=await t.fetchSchemaVersion({schema:p?.source||""}),d=[],A=[];i.data[0]?.entities?.tracked?.forEach(u=>A.push(u.source)),await Promise.all(A.map(async u=>{let b=await t.fetchSchemaVersion({schema:u});d.push(b)})),o.push({eventSpecification:{name:s||"",id:r},version:a||0,eventSchema:h,entitiesSchemas:d})}return o}async function St(t){return await Promise.all(t.map(async n=>JSON.parse(await gt({schema:n}))))}async function yt(t,e){return await Promise.all(e.map(o=>t.fetchSchemaVersion({schema:o})))}var xt=require("cli-spinner"),g=v(require("chalk"));function Pt(){let t=new xt.Spinner;return t.setSpinnerString(18),t}var he="https://snowplow.io",we="https://docs.snowplow.io/docs/collecting-data/code-generation/",$={SUCCESS:"\u2714",LOG:"\u2139",DEBUG:"\u27A4",ERROR:"\u2717",WARN:"\u26A0"},It={LINK:"#9911BB",OPTION:"#9911DD"};function vt(t){return g.default.hex(It.LINK).bold(t)}function S(t){return g.default.hex(It.OPTION).italic(t)}function K(t,e){switch(t){case"h1":return g.default.bold.underline(e);default:return g.default.bold(e)}}function Ct(){return`
2
2
  ${K("h1","CLI Help")}
3
3
 
4
- For more information visit the Snowplow website ${ft(le)}
4
+ For more information visit the Snowplow website ${vt(he)}
5
5
 
6
- For details see the CLI documentation ${ft(me)}
6
+ For details see the CLI documentation ${vt(we)}
7
7
 
8
8
  ${K("h2","How to get started")}
9
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.
10
+ 2. Use ${g.default.cyanBright("snowtype patch")} to add a Data Structure or Event Specification.
11
11
  3. Use ${g.default.cyanBright("snowtype generate")} to generate tracking code.
12
12
 
13
13
  ${K("h2","Available commands")}
@@ -17,19 +17,19 @@ To learn more about each CLI command, use the ${S("--help")} option, for example
17
17
  Initialize the setup of Snowtype code generation in a project. Creates the \`snowtype.config.json\` file.
18
18
 
19
19
  ${S("snowtype patch")}
20
- Adds new Data Structures and Tracking Scenarios in the \`snowtype.config.json\` file.
20
+ Adds new Data Structures and Event Specifications in the \`snowtype.config.json\` file.
21
21
 
22
22
  ${S("snowtype generate")}
23
23
  Generates tracking code based on configuration on the \`snowtype.config.json\` file.
24
24
 
25
25
  ${S("snowtype update")}
26
- Checks for latest version updates in Data Structures and Tracking Scenarios.
26
+ Checks for latest version updates in Data Structures and Event Specifications.
27
27
 
28
28
  ${K("h2","Debug")}
29
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});
30
+ `}function Et(t){let e=`${$.SUCCESS}: `;return g.default.cyanBright(e)+t}function kt(t){let e=`${$.WARN} Warning: `;return g.default.hex("#FFA500")(e)+t}function At(t){let e=`${$.LOG} ${t}`;return g.default.yellowBright(e)}function bt(t){let e=`${$.DEBUG} Debug: `;return g.default.magenta(e)+t}function Ot(t){let e=`${$.ERROR} Error: `;return g.default.redBright(e)+t}function Tt(t,e){let n=`- ${t}`,o=`+ ${e}`;return`
31
+ ${g.default.magenta(n)}
32
+ ${g.default.cyanBright(o)}
33
+ `}var Lt={...H},J=`./${lt}`;function $t(t){return t.length!==0}function Ut(t){return Array.isArray(Lt[t])}function Dt(t,e){let n=Lt[t];return Array.isArray(n)?!!n.map(r=>r.value).includes(e):!1}function Nt(t){let e={organizationId:t.organizationId,tracker:t.tracker,language:t.language,outpath:t.outpath};return Object.assign({igluCentralSchemas:[],dataStructures:[],eventSpecificationIds:[],dataProductIds:[]},e)}function B(t){let e=(0,C.resolve)((0,I.cwd)(),J);return(0,y.writeFileSync)(e,JSON.stringify(t,null,2))}function U(t){let e=(0,y.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function W(t){return(0,y.readFileSync)(t,{encoding:"utf-8"})}function q(){let t=(0,C.resolve)((0,I.cwd)(),J);return JSON.parse(W(t))}function Rt(t){return JSON.parse(W(t))}function E(){let t=(0,C.resolve)((0,I.cwd)(),J);if(U(t)===!1)throw new G;let e=JSON.parse(W(t));return P(e)}function Ft(){let t=(0,C.resolve)((0,I.cwd)(),J);if(U(t)===!0){let e=W(t);try{throw P(JSON.parse(e)),new O}catch(n){if(n instanceof O)throw n}}}function Gt(t){return{javascript:".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go"}[t]||""}function zt(t,e){let n={eventSpecifications:{}};t.forEach(r=>{n.eventSpecifications[r.eventSpecification.id]=r.version});let o=(0,C.resolve)((0,I.cwd)(),e,M);try{(0,y.writeFileSync)(o,JSON.stringify(n,null,2))}catch{throw new j}}function _t(t,e,n){let o=Object.entries(t);o.length>0&&n.success("Available Event Specification Updates"),o.forEach(([r,i])=>{let s=`${r}: version ${i.previous}`,a=`${r}: version ${i.next}`;n.diff(s,a)}),e.length>0&&n.success("Available Data Structures Updates"),e.forEach(r=>{let i=`${r.previous}`,s=`${r.next}`;n.diff(i,s)})}function jt(t){let e=t.optsWithGlobals();return{...e,apiKey:e.apiKey||process.env.SNOWPLOW_CONSOLE_API_KEY}}function D(t){return!!(Array.isArray(t)&&!t.length)}function Vt(t){return t.type==="input"}function Mt(t){return t.type==="password"}function tt(t){return t.type==="select"}function Ht(){return{withVerbosity:e=>({success:o=>{console.log(Et(o))},warn:o=>{console.log(kt(o))},log:o=>{console.log(At(o))},diff:(o,r)=>{console.log(Tt(o,r))},debug:o=>{e===!0&&console.log(bt(JSON.stringify(o)))},error:o=>{console.log(Ot(o.message)),e===!0&&console.log(o)}})}}function m(t){return(e,n)=>{let o=jt(n),r=Ht(),i=Pt(),s=r.withVerbosity(o.verbose),a=o.apiKey;return t(a,s,i,e).then(()=>Kt(i)).catch(p=>{Se(p,s,i)})}}function Se(t,e,n){throw Kt(n),e.error(t),t}function Kt(t){t.isSpinning()===!0&&t.stop(!0)}var N=[{type:"password",message:"Enter your Snowplow organization ID:",mask:!0,validate:$t},{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"}],ye={organizationId:"",tracker:"",language:"",outpath:""};function R(t,e,n,o=""){if(o)return Promise.resolve(o);if(Object.prototype.hasOwnProperty.call(e,t)&&e[t]!=null){let r=e[t];if(typeof r=="string")return Promise.resolve(r);throw new w("Invalid default options.")}if(Vt(n))return(0,k.input)(n);if(Mt(n))return(0,k.password)(n);if(tt(n))return(0,k.select)(n);throw new w("Unknown Prompt inquired.")}function ve(t,e){return tt(e)&&(e.choices=t),e}async function xe(t,e){let n={...ye};e.debug("Checking for existing configuration file.."),Ft();let o=await R("organizationId",t,N[0]);n.organizationId=o;let r=await R("tracker",t,N[1]);if(!Ut(r))throw new T("tracker",r);n.tracker=r;let i=H[r];if(!Array.isArray(i)||i.length===0)throw new w("Missing language entry.");let s;if(i.length===1){let p=i[0];if(typeof p>"u")throw new w("Missing language.");s=await R("language",t,N[2],p.value)}else s=await R("language",t,ve(i,N[2]));if(!Dt(n.tracker,s))throw new T("language",s);n.language=s;let a=await R("outpath",t,N[3]);return n.outpath=a,e.debug("Assempling initialization options.."),n}async function Pe(t,e,n,o){let r=await xe(o,e);n.setSpinnerTitle("Initialising..."),n.isSpinning()===!1&&n.start(),e.debug("Creating configuration with options: ".concat(JSON.stringify(r)));let i=Nt(r);if(P(i),!await new l({apiKey:t,organizationId:i.organizationId}).authenticate())throw new x;e.success("Authentication succeeded"),B(i),e.success("Configuration created")}var et=m(Pe);var te=require("process"),ee=require("path");var Z=require("fs"),nt=require("path");var Jt="snowtype.config.json";function Ie(t){(0,Z.writeFileSync)((0,nt.resolve)(process.cwd(),`./${Jt}`),JSON.stringify(t,null,2))}function Bt(t,e){try{let n=(0,Z.readFileSync)((0,nt.resolve)(process.cwd(),`./${Jt}`),{encoding:"utf-8"}),o=JSON.parse(n);return o[t].some(i=>i===e)||o[t].push(e),Ie(o),!0}catch(n){return console.error(n),!1}}async function Wt(t,e){return await Promise.all(e.map(async o=>{let{version:r}=L(o),{deployments:i}=await t.fetchSchemaHash({schema:o}),s=i.reduce((a,p)=>new Date(p.ts)>new Date(a.ts)?p:a,i[0]);return s.version===r?{previous:o,next:o}:{previous:o,next:ft(o,{version:s.version})}}))}async function qt(t,e,n){let{eventSpecifications:o}=n,r={};return await Promise.all(e.map(async i=>{let s=o[i];if(!s)return i;let a=(await t.fetchEventSpecification({eventSpecificationId:i})).data[0];return(a.version||0)>s&&(r[i]={previous:s,next:a.version}),i})),r}var Zt=require("process"),ot=require("path"),Xt=require("fs"),Yt=require("mkdirp"),Qt=require("@snowplow/snowtype-core");function Ce(t){t.debug("Checking for existing configuration.."),E(),t.success("Valid configuration found")}async function F(t,e,n){Ce(e),n.setSpinnerTitle("Generating..."),n.isSpinning()===!1&&n.start();let o=q();D(o.dataStructures)&&D(o.igluCentralSchemas)&&D(o.eventSpecificationIds)&&D(o.dataProductIds)&&e.warn("Data Structures, Schemas and Event Specifications are empty.");let r=new l({apiKey:t,organizationId:o.organizationId});if(!await r.authenticate())throw new x;let a=[...await ht(r,o.dataProductIds),...o.eventSpecificationIds],p=await wt(r,a,e),h=await St(o.igluCentralSchemas),d=await yt(r,o.dataStructures),A={language:o.language,tracker:o.tracker,schemas:[...h,...d],eventSpecifications:p},u=await(0,Qt.generate)(A);e.success("Code generated, writing...");let b=u?.lines.join(`
34
+ `),at=(0,ot.resolve)((0,Zt.cwd)(),o.outpath);Yt.mkdirp.sync(at);let ie=mt+Gt(o.language);(0,Xt.writeFileSync)((0,ot.resolve)(at,ie),b),zt(p,o.outpath)}var rt=m(F);var Ee={yes:!1};function ke(t,e){let n={...Ee,...t};return e.debug("Checking for existing configuration.."),E(),e.success("Valid configuration found"),n}async function Ae(t,e,n,o){let r=ke(o,e);e.debug("Starting update process with options: ".concat(JSON.stringify(r)));let i=q(),s=(0,ee.resolve)((0,te.cwd)(),i.outpath,M),a=new l({apiKey:t,organizationId:i.organizationId});n.setSpinnerTitle("Checking for updates..."),n.isSpinning()===!1&&n.start();let p={};if(!U(s)&&i.eventSpecificationIds.length)throw new V;if(U(s)&&i.eventSpecificationIds.length){let u=Rt(s);p=await qt(a,i.eventSpecificationIds,u)}let d=(await Wt(a,i.dataStructures)).filter(u=>u.previous!==u.next);if((Object.entries(p).length>0||d.length>0)===!0){if(e.success("Available updates found!"),_t(p,d,e),r.yes===!0)return d.length>0&&(d.forEach(u=>{let b=i.dataStructures.indexOf(u.previous);i.dataStructures[b]=u.next}),B(i)),e.debug("Applying the updates.."),F(t,e,n);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=m(Ae);var be={eventSpecificationIds:[],dataStructures:[],igluCentralSchemas:[],dataProductIds:[],yes:!1};function Oe(t,e){let n={...be,...t};if(Object.values(n).every(o=>typeof o=="boolean"||o.length===0))throw new _;return e.debug("Checking for existing configuration.."),E(),e.success("Valid configuration found"),n}async function Te(t,e,n,o){let r=Oe(o,e);return e.debug("Starting patch process with options: ".concat(JSON.stringify(r))),Object.entries(r).forEach(([s,a])=>{s!=="yes"&&Array.isArray(a)&&a.length!==0&&a.forEach(p=>{Bt(s,p)})}),e.success("Configuration patched"),r.yes===!0?F(t,e,n):(e.log("Code is not generated yet for the patched configuration"),Promise.resolve(void 0))}var st=m(Te);var ne="0.2.1";async function re(){await import("dotenv/config");let t=new X.Command;t.exitOverride(),t.version(ne,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 Event Specifications.").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(rt),t.command("patch").description("Adds new Data Structures and Event Specifications in the `snowtype.config.json` file.").option("-p, --dataProductIds [value...]","data product ID").option("-e, --eventSpecificationIds [value...]","tracking eventSpecification 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",Ct()).addHelpText("after",`
35
+ `),await t.parseAsync(oe.argv).catch(e=>{Le(e)})}function Le(t){if(!(t instanceof X.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.2",
3
+ "version": "0.2.1",
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/",
@@ -13,7 +13,7 @@
13
13
  "dependencies": {
14
14
  "@commander-js/extra-typings": "^11.1.0",
15
15
  "@inquirer/prompts": "^3.3.0",
16
- "@snowplow/snowtype-core": "^0.1.1",
16
+ "@snowplow/snowtype-core": "^0.2.1",
17
17
  "chalk": "^4.1.2",
18
18
  "cli-spinner": "^0.2.10",
19
19
  "dotenv": "^16.3.1",