@snowplow/snowtype 0.4.2 → 0.5.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.
- package/dist/index.js +25 -25
- package/package.json +2 -2
package/dist/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
"use strict";var
|
|
2
|
-
`);super(s)}};function
|
|
1
|
+
"use strict";var Xe=Object.create;var Ft=Object.defineProperty;var Ye=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Qe=Object.getPrototypeOf,tn=Object.prototype.hasOwnProperty;var en=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of Ze(e))!tn.call(t,o)&&o!==n&&Ft(t,o,{get:()=>e[o],enumerable:!(i=Ye(e,o))||i.enumerable});return t};var d=(t,e,n)=>(n=t!=null?Xe(Qe(t)):{},en(e||!t||!t.__esModule?Ft(n,"default",{value:t,enumerable:!0}):n,t));var Je=d(require("process")),vt=require("@commander-js/extra-typings");var D=require("@inquirer/prompts");var nn={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.",GenerationFailed:"Something went wrong with code generation.",PatchingNotSupported:"Patching is only supported using a Snowtype config file in JSON format."},on="Please report a bug.",m=class extends Error{code;constructor(e,n=""){let i=nn[e].concat(n);super(i),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=e}},W=class extends m{constructor(){super("GenerationFailed")}},N=class extends m{constructor(){super("ConfigAlreadyExists")}},J=class extends m{constructor(){super("ConfigNotExists")}},B=class extends m{constructor(e){super("ConfigInvalid",e)}},E=class extends m{constructor(e){super("InternalError",e.concat(on))}},T=class extends m{constructor(e,n){let i=`Value ${n} is an invalid ${e}.`;super("InvalidOption",i)}},K=class extends m{constructor(){super("MissingOptions")}},A=class extends m{constructor(){super("AuthError")}},q=class extends m{constructor(){super("WriteLockFile")}},X=class extends m{constructor(){super("MissingLockFile")}},Y=class extends m{constructor(){super("PatchingNotSupported")}};var Nt=d(require("got"));async function _t({schema:t}){return(await(0,Nt.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${t.replace("iglu:","")}`)).body}var Q=d(require("got"));var jt=require("js-sha256"),Ut=d(require("assert"));function wt(t){let e=jt.sha256.create();return e.update(t),e.hex()}function w(t){let e=t.replace("iglu:",""),[n,i,o,r]=e.split("/");return(0,Ut.default)(typeof n=="string"&&typeof i=="string"&&typeof o=="string"&&typeof r=="string",`invalid iglu uri ${t}`),{vendor:n,name:i,format:o,version:r}}function yt(t,{vendor:e,name:n,format:i,version:o}){let r=t.replace("iglu:",""),[s,c,a,p]=r.split("/");return`iglu:${e||s}/${n||c}/${i||a}/${o||p}`}function Vt(t){return t.some(e=>e.eventSchema.isEcomTemplateSchema)}var Z=class extends Error{constructor(e){let n=e.response?.statusCode||0,{method:i,url:o}=e.options,r=e.response?.body||e.message,s=[[n,i,o].filter(Boolean).join(" "),r].filter(Boolean).join(`
|
|
2
|
+
`);super(s)}};function Gt(t){return!!Object.hasOwn(t||{},"response")}var y=class{apiKey;organizationId;accessToken;apiUrl=process.env.SNOWPLOW_CONSOLE_API_URL||"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.apiUrl}/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();try{return await(0,Q.default)(e,{headers:{Authorization:"Bearer "+n}}).json()}catch(i){throw Gt(i)?new Z(i):i}}fetchSchemaVersion({schema:e,env:n="DEV"}){let{vendor:i,name:o,format:r,version:s}=w(e),c=wt(`${this.organizationId}-${i}-${o}-${r}`),a=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/${c}/versions/${s}?env=${n}`;return this.fetchResource(a)}fetchSchemaHash({schema:e}){let{vendor:n,name:i,format:o}=w(e),r=wt(`${this.organizationId}-${n}-${i}-${o}`),s=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/${r}`;return this.fetchResource(s)}fetchEventSpecification({eventSpecificationId:e}){let n=`${this.apiUrl}/v1/organizations/${this.organizationId}/tracking-scenarios/v2/${e}`;return this.fetchResource(n)}async fetchImageVariant({imageId:e,imageVariant:n}){let i=`${this.apiUrl}/v1/organizations/${this.organizationId}/images/v1/${e}/${n}`,o=await this.fetchAccessToken();return(0,Q.default)(i,{headers:{Authorization:"Bearer "+o}})}fetchDataProduct({dataProductId:e}){let n=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-products/v1/${e}`;return this.fetchResource(n)}async authenticate(){try{return await this.fetchAccessToken(),!0}catch{return!1}}};var u=d(require("joi")),tt=require("@snowplow/snowtype-core");var zt=new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$"),rn=u.default.object().required().keys({tracker:u.default.string().required().valid(...tt.trackerTemplates),language:u.default.string().required().valid(...tt.languageIds),outpath:u.default.string().required(),organizationId:u.default.string().when("dataStructures",{is:u.default.array().min(1),then:u.default.required(),otherwise:u.default.optional()}).when("eventSpecificationIds",{is:u.default.array().min(1),then:u.default.required(),otherwise:u.default.optional()}).when("dataProductIds",{is:u.default.array().min(1),then:u.default.required(),otherwise:u.default.optional()}),igluCentralSchemas:u.default.array().optional().items(u.default.string().regex(zt)),dataStructures:u.default.array().optional().items(u.default.string().regex(zt)),eventSpecificationIds:u.default.array().optional().items(u.default.string()),dataProductIds:u.default.array().optional().items(u.default.string())}),$=t=>{let e=rn.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new B(e.error.annotate());return t};var _="snowtype.config",et=".js",nt=".ts",it=".json",Mt=Object.freeze([et,nt,it]),ot=".snowtype-lock.json",Ht="snowplow";var j={"google-tag-manager":[{value:"javascript-gtm",name:"JavaScript"}],"@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"}],"@snowplow/react-native-tracker":[{value:"typescript",name:"TypeScript"}]};var pt=require("process"),k=require("path"),h=require("fs");var xt=d(require("util")),Et=require("tsx/cjs/api");var rt=(()=>{let t="json";return{setFormat:i=>t=i,getFormat:()=>t}})();var ut=require("@snowplow/snowtype-core");var st=require("path"),Wt=require("mkdirp"),It=require("fs"),Jt=require("@snowplow/snowtype-core"),sn="instructions.md",Bt="assets";function Kt(t,e,n,i){Wt.mkdirp.sync((0,st.resolve)(n,Bt));let o=[],r=pn(t,e,i),s=[];for(let a of t)s.push(at(a.eventSpecification.name)),cn(a,n),o.push(an({eventStructureName:a.eventSchema.self.name,entitiesStructureNames:a.entitiesSchemas?.map(p=>p.self.name),name:a.eventSpecification.name,id:a.eventSpecification.id,version:a.version,triggerInstructions:a.instructions?.triggers||[],linkToCode:r[a.eventSpecification.id]}));let c=`
|
|
3
3
|
# Implementation instructions
|
|
4
4
|
|
|
5
5
|
_A guide on how to implement tracking for the generated Event Specifications._
|
|
@@ -10,8 +10,8 @@ ${s.map(a=>`- [${a.instructionsTitle}](#${a.instructionsLink})`).join(`
|
|
|
10
10
|
|
|
11
11
|
${o.join(`
|
|
12
12
|
`)}
|
|
13
|
-
`;(0,
|
|
14
|
-
## ${
|
|
13
|
+
`;(0,It.writeFileSync)((0,st.resolve)(n,sn),c,"utf-8")}function an({eventStructureName:t,entitiesStructureNames:e,name:n,id:i,version:o,triggerInstructions:r,linkToCode:s}){let c="_N/A_";return`
|
|
14
|
+
## ${at(n).instructionsTitle}
|
|
15
15
|
|
|
16
16
|
| | |
|
|
17
17
|
| ----------- | ----------- |
|
|
@@ -38,19 +38,19 @@ ${a.url||c}
|
|
|
38
38
|
#### Notes
|
|
39
39
|
|
|
40
40
|
${a.description||c}
|
|
41
|
-
`).join("")}`}function
|
|
42
|
-
${
|
|
41
|
+
`).join("")}`}function cn(t,e){t.instructions?.triggers.forEach((n,i)=>{n.imageBuffer&&(0,It.writeFileSync)((0,st.resolve)(e,Bt,t.eventSpecification.id+"_"+i+"."+n.imageExtension),n.imageBuffer,"binary")})}function pn(t,e,n){let i=t.reduce((o,{eventSpecification:{id:r}})=>(o[r]="",o),{});return Object.keys(i).forEach(o=>{let r=e.findIndex(s=>s.match((0,Jt.createEventSpecificationInstructionsIdentifier)(o)));i[o]=n+"#L"+r}),i}function at(t){let e=t;return{instructionsTitle:e,instructionsLink:un(e)}}function un(t){return t.toLowerCase().replace(/[^a-z\d\s-]/g," ").replace(/\s+/g," ").trim().replace(/-{2,}|\s/g,"-")}var Xt=d(require("mime-types"));var gn=["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","iglu:com.snowplowanalytics.snowplow/button_click/jsonschema/1-0-0"],qt="iglu:com.snowplowanalytics.snowplow.ecommerce";async function Yt(t,e){return(await Promise.all(e.map(i=>t.fetchDataProduct({dataProductId:i})))).flatMap(({data:[i]})=>i?i.trackingScenarios:[]).map(i=>i?.id).filter(i=>!!i)}function ln(t){let{original:e}=t,[n,i]=e.split("/").reverse();return{imageVariant:n,imageId:i}}async function fn(t,e){let n=[];if(!(e&&e.length))return[];for(let i of e){let{description:o,appIds:r,url:s,variantUrls:c}=i,a={description:o,appIds:r,url:s};if(c){let{imageVariant:p,imageId:g}=ln(c),f=await t.fetchImageVariant({imageId:g,imageVariant:p});a.imageBuffer=f.rawBody,a.imageExtension=Xt.default.extension(f.headers["content-type"])||""}n.push(a)}return n}async function Zt(t,e,n,i){let o=[],r={};for(let s of e){let a=(await t.fetchEventSpecification({eventSpecificationId:s})).data[0];if(typeof a>"u")continue;let p=a.name,g=a.triggers,f=a.event?.schema?.properties?.type?.enum?.[0],O;i&&p&&(O={triggers:await fn(t,g),instructionsHeading:at(p)});let St=a.version,x=a.event;if(typeof x>"u")continue;if(gn.includes(x.source)){n.warn("Currently you cannot generate code for `Standard` events. Skipping...");continue}let M=x.source.match(qt)?{self:w(x.source),isEcomTemplateSchema:f}:await t.fetchSchemaVersion({schema:x.source}),H=[],v=a.entities?.tracked;Array.isArray(v)&&(H=await Promise.all(v.map(async({source:b,minCardinality:S,maxCardinality:F})=>{let Ke=b.match(qt)?{self:w(b),isEcomTemplateSchema:f}:await t.fetchSchemaVersion({schema:b});if(typeof S<"u"||typeof F<"u"){let qe={minCardinality:S,maxCardinality:F};r[s]=r[s]||{},r[s][b]=qe}return Ke}))),o.push({eventSpecification:{name:p||"",id:s,dataProductId:a.dataProductId||"",dataProductName:""},version:St||0,eventSchema:M,entitiesSchemas:H,instructions:O})}return{eventSpecifications:o,cardinalityRules:r}}async function Qt(t){return await Promise.all(t.map(async n=>JSON.parse(await _t({schema:n}))))}async function te(t,e){return await Promise.all(e.map(i=>t.fetchSchemaVersion({schema:i})))}async function ee(t,e){let n=e.flatMap(({eventSpecification:{dataProductId:s}})=>s?[s]:[]),o=(await Promise.all(n.map(async s=>(await t.fetchDataProduct({dataProductId:s})).data[0]))).filter(dn).reduce((s,c)=>(s[c.id]=c.name,s),{});return e.map(s=>({...s,eventSpecification:{...s.eventSpecification,dataProductName:o[s.eventSpecification.dataProductId]||""}}))}function dn(t){return!!t}var ie=require("cli-spinner"),l=d(require("chalk"));function oe(){let t=new ie.Spinner;return t.setSpinnerString(18),t}var mn="https://snowplow.io",hn="https://docs.snowplow.io/docs/collecting-data/code-generation/",U={SUCCESS:"\u2714",LOG:"\u2139",DEBUG:"\u27A4",ERROR:"\u2717",WARN:"\u26A0"},re={LINK:"#9911BB",OPTION:"#9911DD"};function ne(t){return l.default.hex(re.LINK).bold(t)}function C(t){return l.default.hex(re.OPTION).italic(t)}function ct(t,e){switch(t){case"h1":return l.default.bold.underline(e);default:return l.default.bold(e)}}function se(){return`
|
|
42
|
+
${ct("h1","CLI Help")}
|
|
43
43
|
|
|
44
|
-
For more information visit the Snowplow website ${
|
|
44
|
+
For more information visit the Snowplow website ${ne(mn)}
|
|
45
45
|
|
|
46
|
-
For details see the CLI documentation ${
|
|
46
|
+
For details see the CLI documentation ${ne(hn)}
|
|
47
47
|
|
|
48
|
-
${
|
|
48
|
+
${ct("h2","How to get started")}
|
|
49
49
|
1. Use ${l.default.cyanBright("snowtype init")} to initialize the setup.
|
|
50
50
|
2. Use ${l.default.cyanBright("snowtype patch")} to add a Data Structure or Event Specification.
|
|
51
51
|
3. Use ${l.default.cyanBright("snowtype generate")} to generate tracking code.
|
|
52
52
|
|
|
53
|
-
${
|
|
53
|
+
${ct("h2","Available commands")}
|
|
54
54
|
To learn more about each CLI command, use the ${C("--help")} option, for example, ${C("snowtype init --help")}.
|
|
55
55
|
|
|
56
56
|
${C("snowtype init")}
|
|
@@ -65,17 +65,17 @@ To learn more about each CLI command, use the ${C("--help")} option, for example
|
|
|
65
65
|
${C("snowtype update")}
|
|
66
66
|
Checks for latest version updates in Data Structures and Event Specifications.
|
|
67
67
|
|
|
68
|
-
${
|
|
68
|
+
${ct("h2","Debug")}
|
|
69
69
|
Use the ${C("-v")} to output verbose logs
|
|
70
|
-
`}function
|
|
70
|
+
`}function ae(t){let e=`${U.SUCCESS}: `;return l.default.cyanBright(e)+t}function ce(t){let e=`${U.WARN} Warning: `;return l.default.hex("#FFA500")(e)+t}function pe(t){let e=`${U.LOG} ${t}`;return l.default.yellowBright(e)}function ue(t){let e=`${U.DEBUG} Debug: `;return l.default.magenta(e)+t}function ge(t){let e=`${U.ERROR} Error: `;return l.default.redBright(e)+t}function le(t,e){let n=`- ${t}`,i=`+ ${e}`;return`
|
|
71
71
|
${l.default.magenta(n)}
|
|
72
72
|
${l.default.cyanBright(i)}
|
|
73
|
-
`}
|
|
73
|
+
`}function de(t){return t.length!==0}function Ct(t){return JSON.stringify(t,null,2)}function me(t){let e={organizationId:t.organizationId,tracker:t.tracker,language:t.language,outpath:t.outpath};return Object.assign({igluCentralSchemas:[],dataStructures:[],eventSpecificationIds:[],dataProductIds:[]},e)}function vn(t){switch(t){case"typescript":return`${_}${nt}`;case"javascript":return`${_}${et}`;case"json":return`${_}${it}`;default:return""}}var fe=t=>(0,h.existsSync)(t)&&!(0,h.lstatSync)(t).isDirectory(),Sn=t=>_+t,wn=t=>({isTS:t.endsWith(nt),isJSON:t.endsWith(it),isJS:t.endsWith(et)}),Pt=t=>({configPath:t,...wn(t)});function gt(t){let e=(0,k.isAbsolute)(t)?t:(0,k.resolve)(process.cwd(),t);if(fe(e))return Pt(e);if(!(0,h.existsSync)(e))throw new Error(`Can't find a root directory while resolving a config file path.
|
|
74
74
|
Provided path to resolve: ${t}
|
|
75
|
-
cwd: ${process.cwd()}`);let[n]=
|
|
75
|
+
cwd: ${process.cwd()}`);let[n]=Mt.map(i=>(0,k.resolve)(e,Sn(i))).filter(fe);return Pt(typeof n!="string"?e:n)}function lt(t){let e=rt.getFormat(),n=vn(e),i=(0,k.resolve)((0,pt.cwd)(),n),o=`const config = ${xt.default.inspect(t,!1,null)}
|
|
76
76
|
`,r=`type SnowtypeConfig = {
|
|
77
|
-
tracker: "
|
|
78
|
-
language: "
|
|
77
|
+
tracker: "${ut.trackerTemplates.join('" | "')}";
|
|
78
|
+
language: "${ut.languageIds.join('" | "')}";
|
|
79
79
|
outpath: string;
|
|
80
80
|
organizationId?: string;
|
|
81
81
|
igluCentralSchemas?: string[];
|
|
@@ -83,16 +83,16 @@ cwd: ${process.cwd()}`);let[n]=Vt.map(i=>(0,k.resolve)(e,wn(i))).filter(ge);retu
|
|
|
83
83
|
eventSpecificationIds?: string[];
|
|
84
84
|
dataProductIds?: string[];
|
|
85
85
|
}
|
|
86
|
-
`,s=`const config: SnowtypeConfig = ${
|
|
87
|
-
`,c="module.exports = config;",a="export default config;";return e==="json"?(0,h.writeFileSync)(i,
|
|
88
|
-
`))}function
|
|
89
|
-
Find out more ${
|
|
90
|
-
`);let
|
|
86
|
+
`,s=`const config: SnowtypeConfig = ${xt.default.inspect(t,!1,null)}
|
|
87
|
+
`,c="module.exports = config;",a="export default config;";return e==="json"?(0,h.writeFileSync)(i,Ct(t)):(0,h.writeFileSync)(i,(e==="typescript"?[r,s,a]:[o,c]).join(`
|
|
88
|
+
`))}function kt(t){let e=(0,h.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function Ot(t){return(0,h.readFileSync)(t,{encoding:"utf-8"})}var yn=async t=>(await(0,Et.require)(t,__filename)).default;async function ft(){let{configPath:t,isJS:e,isJSON:n,isTS:i}=gt((0,pt.cwd)()),o;return i?o=await yn(t):e?o=(await import(t)).default:n&&(o=JSON.parse(Ot(t))),typeof o=="function"&&(o=await o()),o}function he(t){return JSON.parse(Ot(t))}async function I(t){let{configPath:e,isJS:n,isJSON:i,isTS:o}=gt(process.cwd()),r=i===!0||o===!0||n===!0,s=o===!1&&n===!1&&i===!1,c;if(o?c=(await(0,Et.require)(e,__filename)).default:n?c=(await import(e)).default:i&&(c=JSON.parse(Ot(e))),typeof c=="function"&&(c=await c()),t){if(s)throw new J;$(c)}else if(r)try{throw $(c),new N}catch(a){if(a instanceof N)throw a}}function ve(t){return{javascript:".js","javascript-gtm":".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go"}[t]||""}function Se(t,e){let n={eventSpecifications:{}};t.forEach(o=>{n.eventSpecifications[o.eventSpecification.id]=o.version});let i=(0,k.resolve)((0,pt.cwd)(),e,ot);try{(0,h.writeFileSync)(i,JSON.stringify(n,null,2))}catch{throw new q}}function we(t,e,n){let i=Object.entries(t);i.length>0&&n.success("Available Event Specification Updates"),i.forEach(([o,r])=>{let s=`${o}: version ${r.previous}`,c=`${o}: version ${r.next}`;n.diff(s,c),r.devOnlySchema.length>0&&(n.warn("This Event Specification uses schema that are not in production."),n.warn(r.devOnlySchema.join(" ")))}),e.length>0&&n.success("Available Data Structures Updates"),e.forEach(o=>{let r=`${o.previous}`,s=`${o.next}`;if(n.diff(r,s),o.nextReason==="patch"&&n.warn("The most recent version of this schema has been patched. Possible update required."),o.nextEnv==="DEV"){let c=o.next.split("/").pop();n.warn(`This data structure version (${c}) is not in production.`)}})}function ye(t){let e=t.optsWithGlobals();return{...e,apiKey:e.apiKey||process.env.SNOWPLOW_CONSOLE_API_KEY}}function V(t){return!!(Array.isArray(t)&&!t.length)}function Ie(t){return t.type==="input"}function Pe(t){return t.type==="password"}function bt(t){return t.type==="select"}var In=["javascript","json","typescript"],Pn=["organizationId","tracker","language","format","outpath"];function xe(t){return Pn.includes(t)}function Ee(t){return t in j}function Ce(t,e){let n=j[t];return Array.isArray(n)?n.map(o=>o.value).includes(e):!1}function ke(t){return In.includes(t)}function Oe(){return{withVerbosity:e=>({success:i=>{console.log(ae(i))},warn:i=>{console.log(ce(i))},log:i=>{console.log(pe(i))},diff:(i,o)=>{console.log(le(i,o))},debug:i=>{e===!0&&console.log(ue(JSON.stringify(i)))},error:i=>{console.log(ge(i.message)),e===!0&&console.log(i)}})}}function P(t){return(e,n)=>{let i=ye(n),o=Oe(),r=oe(),s=o.withVerbosity(i.verbose),c=i.apiKey;return t(c,s,r,e).then(()=>be(r)).catch(a=>{xn(a,s,r)})}}function xn(t,e,n){throw be(n),e.error(t),t}function be(t){t.isSpinning()===!0&&t.stop(!0)}var Te=d(require("chalk"));var L=[{type:"password",message:"Enter your Snowplow organization ID:",mask:!0,validate:de},{type:"select",message:"Select the Snowplow Tracker to use:",choices:[{value:"google-tag-manager",name:"Google Tag Manager"},{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"},{value:"@snowplow/react-native-tracker",name:"React Native Tracker"}]},{type:"select",message:"Select the language to use:"},{type:"select",message:"Select the format to use:",choices:[{value:"javascript",name:"JavaScript"},{value:"typescript",name:"TypeScript"},{value:"json",name:"JSON"}]},{type:"input",message:"Enter the directory for Snowtype output:",default:"./snowtype"}];function R(t,e,n=""){if(n)return Promise.resolve(n);if(!xe(t))throw new E("Invalid default options.");if(Ie(e))return(0,D.input)(e);if(Pe(e))return(0,D.password)(e);if(bt(e))return(0,D.select)(e);throw new E("Unknown Prompt inquired.")}function En(t,e){return bt(e)&&(e.choices=t),e}async function Cn(t){t.debug("Checking for existing configuration file.."),await I(!1);let e=await R("organizationId",L[0]),n=await R("tracker",L[1]);if(!Ee(n))throw new T("tracker",n);let i=j[n];if(!Array.isArray(i)||i.length===0)throw new E("Missing language entry.");let o;if(i.length===1){let c=i[0];if(typeof c>"u")throw new E("Missing language.");o=await R("language",L[2],c.value)}else o=await R("language",En(i,L[2]));if(!Ce(n,o))throw new T("language",o);let r=await R("format",L[3]);if(!ke(r))throw new T("format",r);rt.setFormat(r);let s=await R("outpath",L[4]);return t.debug("Assempling initialization options.."),{organizationId:e,tracker:n,language:o,format:r,outpath:s}}async function kn(t,e,n){t||e.warn(`No SNOWPLOW_CONSOLE_API_KEY detected. You might need to set this up before initializing.
|
|
89
|
+
Find out more ${Te.default.underline("https://docs.snowplow.io/docs/collecting-data/code-generation/using-the-cli/#authenticating-with-the-console")}
|
|
90
|
+
`);let i=await Cn(e);n.setSpinnerTitle("Initialising..."),n.isSpinning()===!1&&n.start(),e.debug("Creating configuration with options: ".concat(JSON.stringify(i)));let o=me(i);if($(o),!await new y({apiKey:t,organizationId:o.organizationId}).authenticate())throw new A;e.success("Authentication succeeded"),lt(o),e.success("Configuration created")}var Tt=P(kn);var Me=require("process"),He=require("path");var mt=require("fs"),At=require("path");var dt=d(require("assert"));var Ae="snowtype.config.json";function On(t){(0,mt.writeFileSync)((0,At.resolve)(process.cwd(),`./${Ae}`),Ct(t))}function $e(t,e){try{let n=(0,mt.readFileSync)((0,At.resolve)(process.cwd(),`./${Ae}`),{encoding:"utf-8"}),i=JSON.parse(n);return i[t].some(r=>r===e)||i[t].push(e),On(i),!0}catch(n){return console.error(n),!1}}var bn=(t,e)=>{let[n,i,o]=t.version.split("-").map(a=>parseInt(a)),[r,s,c]=e.version.split("-").map(a=>parseInt(a));return(0,dt.default)(n!==void 0&&i!==void 0&&o!==void 0&&r!==void 0&&s!==void 0&&c!==void 0,`Invalid version number comparing (${t}, ${e})`),n>r?1:n<r?-1:i>s?1:i<s?-1:o>c?1:o<c?-1:t.patchLevel>e.patchLevel&&t.contentHash!==e.contentHash?1:e.patchLevel>t.patchLevel&&t.contentHash!==e.contentHash||t.env==="DEV"&&e.env==="PROD"?-1:t.env==="PROD"&&e.env==="DEV"?1:0};async function Le(t,e){return(await Promise.all(e.map(async i=>{let{version:o}=w(i),{deployments:r}=await t.fetchSchemaHash({schema:i});r.sort(bn);let s=r.pop();return s?s.version!==o?{previous:i,next:yt(i,{version:s.version}),nextEnv:s.env,nextReason:"version"}:s.patchLevel>0&&s.env==="DEV"?{previous:i,next:yt(i,{version:s.version}),nextEnv:s.env,nextReason:"patch"}:null:null}))).flatMap(i=>i===null?[]:[i])}async function Tn(t,e){return Promise.all(e.map(async n=>{try{await t.fetchSchemaVersion({schema:n,env:"PROD"})}catch(i){if(i.response?.statusCode===404)try{return await t.fetchSchemaVersion({schema:n,env:"DEV"}),n}catch(o){if(o.response?.statusCode!==404)throw o}}return null})).then(n=>n.flatMap(i=>i!==null?[i]:[]))}async function Re(t,e,n){let{eventSpecifications:i}=n,o={};return await Promise.all(e.map(async r=>{let s=i[r];if(!s)return r;let c=(await t.fetchEventSpecification({eventSpecificationId:r})).data[0];(0,dt.default)(!!c,`failed to fetch event spec ${r}`),(0,dt.default)(!!c.version,`event spec with no version ${r}`);let a=[c.event?.source,...c.entities?.tracked?.map(g=>g.source)||[]].flatMap(g=>typeof g=="string"?[g]:[]),p=await Tn(t,a);return(c.version||0)>s&&(o[r]={previous:s,next:c.version,devOnlySchema:p}),r})),o}var je=require("process"),ht=require("path"),Ue=require("fs"),Ve=require("mkdirp"),Ge=require("@snowplow/snowtype-core");var ze=d(require("fs-extra"));var De=require("fs"),Fe=require("path"),$t=d(require("util"));function Ne(t,e,n,i){let o=e==="typescript"?"ts":"js";(0,De.writeFileSync)((0,Fe.resolve)(t,`validations.${o}`),`${o==="ts"?`
|
|
91
91
|
import { AnySchema } from "ajv";
|
|
92
92
|
export type CardinalityRule = { minCardinality?: number; maxCardinality?: number };
|
|
93
93
|
`:""}
|
|
94
|
-
export const entityRules${o==="ts"?": Record<string, Record<string, CardinalityRule>>":""} = ${
|
|
94
|
+
export const entityRules${o==="ts"?": Record<string, Record<string, CardinalityRule>>":""} = ${$t.default.inspect(i,!1,null)}
|
|
95
95
|
|
|
96
|
-
export const schemasObject${o==="ts"?": Record<string, AnySchema>":""} = ${
|
|
97
|
-
`),
|
|
98
|
-
`),await t.parseAsync(
|
|
96
|
+
export const schemasObject${o==="ts"?": Record<string, AnySchema>":""} = ${$t.default.inspect(n,!1,null)}`,"utf-8")}function _e(t){return Object.values(t).some(e=>e.properties?Object.values(e.properties).some(n=>Object.hasOwn(n||{},"pattern")):!1)}var G={instructions:!1,validations:!1};async function An(t,e){return e.debug("Checking for existing configuration.."),await I(!0),e.success("Valid configuration found"),{...G,...t}}async function z(t,e,n,i){let o=await An(i,e);n.setSpinnerTitle("Generating..."),n.isSpinning()===!1&&n.start();let r=await ft();V(r.dataStructures)&&V(r.igluCentralSchemas)&&V(r.eventSpecificationIds)&&V(r.dataProductIds)&&e.warn("Data Structures, Schemas and Event Specifications are empty.");let s=new y({apiKey:t,organizationId:r.organizationId});if(!await s.authenticate())throw new A;let p=[...await Yt(s,r.dataProductIds),...r.eventSpecificationIds].sort(),{eventSpecifications:g,cardinalityRules:f}=await Zt(s,p,e,o.instructions),O=await ee(s,g);Vt(g)&&r.tracker==="@snowplow/browser-tracker"&&e.log("You are generating Snowplow Ecommerce events. You would need to install `@snowplow/browser-plugin-snowplow-ecommerce`."),o.validations&&e.log("For validations to work properly you would need to install `ajv@8`, `ajv-formats@2` and `ajv-draft-04@1` on your project.");let St=await Qt(r.igluCentralSchemas),x=await te(s,r.dataStructures),M=!!(r.tracker==="@snowplow/browser-tracker"&&r.language.match(/javascript|typescript/)),H={language:r.language,tracker:r.tracker,schemas:[...St,...x],eventSpecifications:O,validations:M&&o.validations},v=await(0,Ge.generate)(H);if(n.stop(!0),!v)throw new W;e.success("Code generated, writing...");let b=v.lines.join(`
|
|
97
|
+
`),S=(0,ht.resolve)((0,je.cwd)(),r.outpath);ze.default.removeSync((0,ht.resolve)(S)),Ve.mkdirp.sync(S);let F=Ht+ve(r.language);(0,Ue.writeFileSync)((0,ht.resolve)(S,F),b),Se(g,r.outpath),M&&o.validations&&v.validationsSchemaObject&&(Ne(S,r.language,v.validationsSchemaObject,f),_e(v.validationsSchemaObject)&&e.warn("Some schemas appear to have attributes that can have inconsistent validations between the pipeline and client-side validation. Read more at https://docs.snowplow.io/docs/collecting-data/code-generation/client-side-validation/#divergence-with-pipeline-validation")),o.instructions&&Kt(g,v.lines,S,F)}var Lt=P(z);var $n={yes:!1,...G};async function Ln(t,e){let n={...$n,...t};return e.debug("Checking for existing configuration.."),await I(!0),e.success("Valid configuration found"),n}async function Rn(t,e,n,i){let o=await Ln(i,e);e.debug("Starting update process with options: ".concat(JSON.stringify(o)));let r=await ft(),s=(0,He.resolve)((0,Me.cwd)(),r.outpath,ot),c=new y({apiKey:t,organizationId:r.organizationId});n.setSpinnerTitle("Checking for updates..."),n.isSpinning()===!1&&n.start();let a={};if(!kt(s)&&r.eventSpecificationIds.length)throw new X;if(kt(s)&&r.eventSpecificationIds.length){let f=he(s);a=await Re(c,r.eventSpecificationIds,f)}let p=await Le(c,r.dataStructures);if((Object.entries(a).length>0||p.length>0)===!0){if(e.success("Available updates found!"),we(a,p,e),o.yes===!0)return p.length>0&&(p.forEach(f=>{let O=r.dataStructures.indexOf(f.previous);r.dataStructures[O]=f.next}),lt(r)),e.debug("Applying the updates.."),z(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 Rt=P(Rn);var Dn={eventSpecificationIds:[],dataStructures:[],igluCentralSchemas:[],dataProductIds:[],yes:!1,...G};async function Fn(t,e){let n={...Dn,...t};if(Object.values(n).every(i=>typeof i=="boolean"||i.length===0))throw new K;return e.debug("Checking for existing configuration.."),await I(!0),e.success("Valid configuration found"),n}async function Nn(t,e,n,i){let{isJSON:o}=gt(process.cwd());if(o===!1)throw new Y;let r=await Fn(i,e);return e.debug("Starting patch process with options: ".concat(JSON.stringify(r))),Object.entries(r).forEach(([c,a])=>{c!=="yes"&&Array.isArray(a)&&a.length!==0&&a.forEach(p=>{$e(c,p)})}),e.success("Configuration patched"),r.yes===!0?z(t,e,n,r):(e.log("Code is not generated yet for the patched configuration"),Promise.resolve(void 0))}var Dt=P(Nn);var We="0.5.1";async function Be(){await import("dotenv/config");let t=new vt.Command;t.exitOverride(),t.version(We,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(Tt),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).option("-is, --instructions","generate event specification instructions",!1).action(Rt),t.command("generate").option("-is, --instructions","generate event specification instructions",!1).option("-va, --validations","add runtime validation using Ajv",!1).description("Generates tracking code based on configuration on the `snowtype.config.json` file.").action(Lt),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).option("-is, --instructions","generate event specification instructions",!1).action(Dt),t.addHelpText("before",se()).addHelpText("after",`
|
|
98
|
+
`),await t.parseAsync(Je.argv).catch(e=>{_n(e)})}function _n(t){if(!(t instanceof vt.CommanderError&&["commander.help","commander.version","commander.helpDisplayed"].indexOf(t.code)>-1))throw t}Be().then(()=>{}).catch(()=>{process.exitCode=1});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@snowplow/snowtype",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.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.
|
|
16
|
+
"@snowplow/snowtype-core": "^0.5.1",
|
|
17
17
|
"chalk": "^4.1.2",
|
|
18
18
|
"cli-spinner": "^0.2.10",
|
|
19
19
|
"dotenv": "^16.3.1",
|