@snowplow/snowtype 0.2.8 → 0.3.0
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 +18 -18
- package/package.json +2 -2
package/dist/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"use strict";var
|
|
1
|
+
"use strict";var Te=Object.create;var vt=Object.defineProperty;var Le=Object.getOwnPropertyDescriptor;var $e=Object.getOwnPropertyNames;var Ue=Object.getPrototypeOf,Ne=Object.prototype.hasOwnProperty;var De=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of $e(e))!Ne.call(t,o)&&o!==n&&vt(t,o,{get:()=>e[o],enumerable:!(i=Le(e,o))||i.enumerable});return t};var S=(t,e,n)=>(n=t!=null?Te(Ue(t)):{},De(e||!t||!t.__esModule?vt(n,"default",{value:t,enumerable:!0}):n,t));var be=S(require("process")),ct=require("@commander-js/extra-typings");var $=require("@inquirer/prompts");var Re={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."},Fe="Please report a bug.",f=class extends Error{code;constructor(e,n=""){let i=Re[e].concat(n);super(i),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=e}},H=class extends f{constructor(){super("GenerationFailed")}},U=class extends f{constructor(){super("ConfigAlreadyExists")}},W=class extends f{constructor(){super("ConfigNotExists")}},K=class extends f{constructor(e){super("ConfigInvalid",e)}},x=class extends f{constructor(e){super("InternalError",e.concat(Fe))}},N=class extends f{constructor(e,n){let i=`Value ${n} is an invalid ${e}.`;super("InvalidOption",i)}},B=class extends f{constructor(){super("MissingOptions")}},C=class extends f{constructor(){super("AuthError")}},J=class extends f{constructor(){super("WriteLockFile")}},Y=class extends f{constructor(){super("MissingLockFile")}};var wt=S(require("got"));async function yt({schema:t}){return(await(0,wt.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${t.replace("iglu:","")}`)).body}var q=S(require("got"));var It=require("js-sha256");function pt(t){let e=It.sha256.create();return e.update(t),e.hex()}function w(t){let e=t.replace("iglu:",""),[n,i,o,r]=e.split("/");return{vendor:n,name:i,format:o,version:r}}function Pt(t,{vendor:e,name:n,format:i,version:o}){let r=t.replace("iglu:",""),[s,a,c,g]=r.split("/");return`iglu:${e||s}/${n||a}/${i||c}/${o||g}`}function xt(t){return t.some(e=>e.eventSchema.isEcomTemplateSchema)}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();return(0,q.default)(e,{headers:{Authorization:"Bearer "+n}}).json()}fetchSchemaVersion({schema:e}){let{vendor:n,name:i,format:o,version:r}=w(e),s=pt(`${this.organizationId}-${n}-${i}-${o}`),a=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/${s}/versions/${r}`;return this.fetchResource(a)}fetchSchemaHash({schema:e}){let{vendor:n,name:i,format:o}=w(e),r=pt(`${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 p=S(require("joi"));var Et=new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$"),_e=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","@snowplow/react-native-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("eventSpecificationIds",{is:p.default.array().min(1),then:p.default.required(),otherwise:p.default.optional()}).when("dataProductIds",{is:p.default.array().min(1),then:p.default.required(),otherwise:p.default.optional()}),igluCentralSchemas:p.default.array().optional().items(p.default.string().regex(Et)),dataStructures:p.default.array().optional().items(p.default.string().regex(Et)),eventSpecificationIds:p.default.array().optional().items(p.default.string()),dataProductIds:p.default.array().optional().items(p.default.string())}),b=t=>{let e=_e.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new K(e.error.annotate());return t};var kt="snowtype.config.json",Z=".snowtype-lock.json",At="snowplow";var X={"@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 O=require("process"),T=require("path"),k=require("fs");var Q=require("path"),Ct=require("mkdirp"),ut=require("fs"),bt=require("@snowplow/snowtype-core"),Ge="instructions.md",Ot="assets";function Tt(t,e,n,i){Ct.mkdirp.sync((0,Q.resolve)(n,Ot));let o=[],r=Ve(t,e,i),s=[];for(let c of t)s.push(tt(c.eventSpecification.name)),ze(c,n),o.push(je({eventStructureName:c.eventSchema.self.name,entitiesStructureNames:c.entitiesSchemas?.map(g=>g.self.name),name:c.eventSpecification.name,id:c.eventSpecification.id,version:c.version,triggerInstructions:c.instructions?.triggers||[],linkToCode:r[c.eventSpecification.id]}));let a=`
|
|
2
2
|
# Implementation instructions
|
|
3
3
|
|
|
4
4
|
_A guide on how to implement tracking for the generated Event Specifications._
|
|
@@ -9,8 +9,8 @@ ${s.map(c=>`- [${c.instructionsTitle}](#${c.instructionsLink})`).join(`
|
|
|
9
9
|
|
|
10
10
|
${o.join(`
|
|
11
11
|
`)}
|
|
12
|
-
`;(0,ut.writeFileSync)((0,
|
|
13
|
-
## ${
|
|
12
|
+
`;(0,ut.writeFileSync)((0,Q.resolve)(n,Ge),a,"utf-8")}function je({eventStructureName:t,entitiesStructureNames:e,name:n,id:i,version:o,triggerInstructions:r,linkToCode:s}){let a="_N/A_";return`
|
|
13
|
+
## ${tt(n).instructionsTitle}
|
|
14
14
|
|
|
15
15
|
| | |
|
|
16
16
|
| ----------- | ----------- |
|
|
@@ -37,19 +37,19 @@ ${c.url||a}
|
|
|
37
37
|
#### Notes
|
|
38
38
|
|
|
39
39
|
${c.description||a}
|
|
40
|
-
`).join("")}`}function
|
|
41
|
-
${
|
|
40
|
+
`).join("")}`}function ze(t,e){t.instructions?.triggers.forEach((n,i)=>{n.imageBuffer&&(0,ut.writeFileSync)((0,Q.resolve)(e,Ot,t.eventSpecification.id+"_"+i+"."+n.imageExtension),n.imageBuffer,"binary")})}function Ve(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,bt.createEventSpecificationInstructionsIdentifier)(o)));i[o]=n+"#L"+r}),i}function tt(t){let e=t;return{instructionsTitle:e,instructionsLink:Me(e)}}function Me(t){return t.toLowerCase().replace(/[^a-z\d\s-]/g," ").replace(/\s+/g," ").trim().replace(/-{2,}|\s/g,"-")}var $t=S(require("mime-types"));var He=["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"],Lt="iglu:com.snowplowanalytics.snowplow.ecommerce";async function Ut(t,e){let n=[];for(let o of e)n.push(t.fetchDataProduct({dataProductId:o}));return(await Promise.all(n)).map(({data:o})=>o[0].trackingScenarios).flat().map(o=>o?.id).filter(o=>!!o)}function We(t){let{original:e}=t,[n,i]=e.split("/").reverse();return{imageVariant:n,imageId:i}}async function Ke(t,e){let n=[];if(!(e&&e.length))return[];for(let i of e){let{description:o,appIds:r,url:s,variantUrls:a}=i,c={description:o,appIds:r,url:s};if(a){let{imageVariant:g,imageId:u}=We(a),m=await t.fetchImageVariant({imageId:u,imageVariant:g});c.imageBuffer=m.rawBody,c.imageExtension=$t.default.extension(m.headers["content-type"])||""}n.push(c)}return n}async function Nt(t,e,n,i){let o=[];for(let r of e){let a=(await t.fetchEventSpecification({eventSpecificationId:r})).data[0];if(typeof a>"u")continue;let c=a.name,g=a.triggers,u=a?.event?.schema?.properties?.type?.enum?.[0],m;i&&c&&(m={triggers:await Ke(t,g),instructionsHeading:tt(c)});let l=a?.version,h=a?.event;if(typeof h>"u")continue;if(He.includes(h.source)){n.warn("Currently you cannot generate code for `Standard` events. Skipping...");continue}let V=h.source.match(Lt)?{self:w(h.source),isEcomTemplateSchema:u}:await t.fetchSchemaVersion({schema:h.source}),M=[],v=a.entities?.tracked?.map(A=>A.source)||[];await Promise.all(v.map(async A=>{let P=A.match(Lt)?{self:w(h.source),isEcomTemplateSchema:u}:await t.fetchSchemaVersion({schema:A});M.push(P)})),o.push({eventSpecification:{name:c||"",id:r,dataProductId:a.dataProductId||"",dataProductName:""},version:l||0,eventSchema:V,entitiesSchemas:M,instructions:m})}return o}async function Dt(t){return await Promise.all(t.map(async n=>JSON.parse(await yt({schema:n}))))}async function Rt(t,e){return await Promise.all(e.map(i=>t.fetchSchemaVersion({schema:i})))}async function Ft(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(Be).reduce((s,a)=>(s[a.id]=a.name,s),{});return e.map(s=>({...s,eventSpecification:{...s.eventSpecification,dataProductName:o[s.eventSpecification.dataProductId]||""}}))}function Be(t){return!!t}var Gt=require("cli-spinner"),d=S(require("chalk"));function jt(){let t=new Gt.Spinner;return t.setSpinnerString(18),t}var Je="https://snowplow.io",Ye="https://docs.snowplow.io/docs/collecting-data/code-generation/",D={SUCCESS:"\u2714",LOG:"\u2139",DEBUG:"\u27A4",ERROR:"\u2717",WARN:"\u26A0"},zt={LINK:"#9911BB",OPTION:"#9911DD"};function _t(t){return d.default.hex(zt.LINK).bold(t)}function E(t){return d.default.hex(zt.OPTION).italic(t)}function et(t,e){switch(t){case"h1":return d.default.bold.underline(e);default:return d.default.bold(e)}}function Vt(){return`
|
|
41
|
+
${et("h1","CLI Help")}
|
|
42
42
|
|
|
43
|
-
For more information visit the Snowplow website ${
|
|
43
|
+
For more information visit the Snowplow website ${_t(Je)}
|
|
44
44
|
|
|
45
|
-
For details see the CLI documentation ${
|
|
45
|
+
For details see the CLI documentation ${_t(Ye)}
|
|
46
46
|
|
|
47
|
-
${
|
|
47
|
+
${et("h2","How to get started")}
|
|
48
48
|
1. Use ${d.default.cyanBright("snowtype init")} to initialize the setup.
|
|
49
49
|
2. Use ${d.default.cyanBright("snowtype patch")} to add a Data Structure or Event Specification.
|
|
50
50
|
3. Use ${d.default.cyanBright("snowtype generate")} to generate tracking code.
|
|
51
51
|
|
|
52
|
-
${
|
|
52
|
+
${et("h2","Available commands")}
|
|
53
53
|
To learn more about each CLI command, use the ${E("--help")} option, for example, ${E("snowtype init --help")}.
|
|
54
54
|
|
|
55
55
|
${E("snowtype init")}
|
|
@@ -64,15 +64,15 @@ To learn more about each CLI command, use the ${E("--help")} option, for example
|
|
|
64
64
|
${E("snowtype update")}
|
|
65
65
|
Checks for latest version updates in Data Structures and Event Specifications.
|
|
66
66
|
|
|
67
|
-
${
|
|
67
|
+
${et("h2","Debug")}
|
|
68
68
|
Use the ${E("-v")} to output verbose logs
|
|
69
|
-
`}function
|
|
69
|
+
`}function Mt(t){let e=`${D.SUCCESS}: `;return d.default.cyanBright(e)+t}function Ht(t){let e=`${D.WARN} Warning: `;return d.default.hex("#FFA500")(e)+t}function Wt(t){let e=`${D.LOG} ${t}`;return d.default.yellowBright(e)}function Kt(t){let e=`${D.DEBUG} Debug: `;return d.default.magenta(e)+t}function Bt(t){let e=`${D.ERROR} Error: `;return d.default.redBright(e)+t}function Jt(t,e){let n=`- ${t}`,i=`+ ${e}`;return`
|
|
70
70
|
${d.default.magenta(n)}
|
|
71
71
|
${d.default.cyanBright(i)}
|
|
72
|
-
`}var
|
|
73
|
-
Find out more ${
|
|
74
|
-
`);let o=await
|
|
75
|
-
|
|
76
|
-
export const schemasObject: Record<string, AnySchema> = ${
|
|
77
|
-
`),
|
|
78
|
-
`),await t.parseAsync(
|
|
72
|
+
`}var Yt={...X},nt=`./${kt}`;function qt(t){return t.length!==0}function Zt(t){return Array.isArray(Yt[t])}function Xt(t,e){let n=Yt[t];return Array.isArray(n)?!!n.map(o=>o.value).includes(e):!1}function Qt(t){let e={organizationId:t.organizationId,tracker:t.tracker,language:t.language,outpath:t.outpath};return Object.assign({igluCentralSchemas:[],dataStructures:[],eventSpecificationIds:[],dataProductIds:[]},e)}function it(t){let e=(0,T.resolve)((0,O.cwd)(),nt);return(0,k.writeFileSync)(e,JSON.stringify(t,null,2))}function R(t){let e=(0,k.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function ot(t){return(0,k.readFileSync)(t,{encoding:"utf-8"})}function rt(){let t=(0,T.resolve)((0,O.cwd)(),nt);return JSON.parse(ot(t))}function te(t){return JSON.parse(ot(t))}function L(){let t=(0,T.resolve)((0,O.cwd)(),nt);if(R(t)===!1)throw new W;let e=JSON.parse(ot(t));return b(e)}function ee(){let t=(0,T.resolve)((0,O.cwd)(),nt);if(R(t)===!0){let e=ot(t);try{throw b(JSON.parse(e)),new U}catch(n){if(n instanceof U)throw n}}}function ne(t){return{javascript:".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go"}[t]||""}function ie(t,e){let n={eventSpecifications:{}};t.forEach(o=>{n.eventSpecifications[o.eventSpecification.id]=o.version});let i=(0,T.resolve)((0,O.cwd)(),e,Z);try{(0,k.writeFileSync)(i,JSON.stringify(n,null,2))}catch{throw new J}}function oe(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}`,a=`${o}: version ${r.next}`;n.diff(s,a)}),e.length>0&&n.success("Available Data Structures Updates"),e.forEach(o=>{let r=`${o.previous}`,s=`${o.next}`;n.diff(r,s)})}function re(t){let e=t.optsWithGlobals();return{...e,apiKey:e.apiKey||process.env.SNOWPLOW_CONSOLE_API_KEY}}function F(t){return!!(Array.isArray(t)&&!t.length)}function se(t){return t.type==="input"}function ae(t){return t.type==="password"}function gt(t){return t.type==="select"}function ce(){return{withVerbosity:e=>({success:i=>{console.log(Mt(i))},warn:i=>{console.log(Ht(i))},log:i=>{console.log(Wt(i))},diff:(i,o)=>{console.log(Jt(i,o))},debug:i=>{e===!0&&console.log(Kt(JSON.stringify(i)))},error:i=>{console.log(Bt(i.message)),e===!0&&console.log(i)}})}}function I(t){return(e,n)=>{let i=re(n),o=ce(),r=jt(),s=o.withVerbosity(i.verbose),a=i.apiKey;return t(a,s,r,e).then(()=>pe(r)).catch(c=>{qe(c,s,r)})}}function qe(t,e,n){throw pe(n),e.error(t),t}function pe(t){t.isSpinning()===!0&&t.stop(!0)}var ue=S(require("chalk")),_=[{type:"password",message:"Enter your Snowplow organization ID:",mask:!0,validate:qt},{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"},{value:"@snowplow/react-native-tracker",name:"React Native Tracker"}]},{type:"select",message:"Select the language to use:"},{type:"input",message:"Enter the directory for Snowtype output:",default:"./snowtype"}],Ze={organizationId:"",tracker:"",language:"",outpath:""};function G(t,e,n,i=""){if(i)return Promise.resolve(i);if(Object.prototype.hasOwnProperty.call(e,t)&&e[t]!=null){let o=e[t];if(typeof o=="string")return Promise.resolve(o);throw new x("Invalid default options.")}if(se(n))return(0,$.input)(n);if(ae(n))return(0,$.password)(n);if(gt(n))return(0,$.select)(n);throw new x("Unknown Prompt inquired.")}function Xe(t,e){return gt(e)&&(e.choices=t),e}async function Qe(t,e){let n={...Ze};e.debug("Checking for existing configuration file.."),ee();let i=await G("organizationId",t,_[0]);n.organizationId=i;let o=await G("tracker",t,_[1]);if(!Zt(o))throw new N("tracker",o);n.tracker=o;let r=X[o];if(!Array.isArray(r)||r.length===0)throw new x("Missing language entry.");let s;if(r.length===1){let c=r[0];if(typeof c>"u")throw new x("Missing language.");s=await G("language",t,_[2],c.value)}else s=await G("language",t,Xe(r,_[2]));if(!Xt(n.tracker,s))throw new N("language",s);n.language=s;let a=await G("outpath",t,_[3]);return n.outpath=a,e.debug("Assempling initialization options.."),n}async function tn(t,e,n,i){t||e.warn(`No SNOWPLOW_CONSOLE_API_KEY detected. You might need to set this up before initializing.
|
|
73
|
+
Find out more ${ue.default.underline("https://docs.snowplow.io/docs/collecting-data/code-generation/using-the-cli/#authenticating-with-the-console")}
|
|
74
|
+
`);let o=await Qe(i,e);n.setSpinnerTitle("Initialising..."),n.isSpinning()===!1&&n.start(),e.debug("Creating configuration with options: ".concat(JSON.stringify(o)));let r=Qt(o);if(b(r),!await new y({apiKey:t,organizationId:r.organizationId}).authenticate())throw new C;e.success("Authentication succeeded"),it(r),e.success("Configuration created")}var dt=I(tn);var ke=require("process"),Ae=require("path");var st=require("fs"),ft=require("path");var ge="snowtype.config.json";function en(t){(0,st.writeFileSync)((0,ft.resolve)(process.cwd(),`./${ge}`),JSON.stringify(t,null,2))}function de(t,e){try{let n=(0,st.readFileSync)((0,ft.resolve)(process.cwd(),`./${ge}`),{encoding:"utf-8"}),i=JSON.parse(n);return i[t].some(r=>r===e)||i[t].push(e),en(i),!0}catch(n){return console.error(n),!1}}async function fe(t,e){return await Promise.all(e.map(async i=>{let{version:o}=w(i),{deployments:r}=await t.fetchSchemaHash({schema:i}),s=r.reduce((a,c)=>new Date(c.ts)>new Date(a.ts)?c:a,r[0]);return s.version===o?{previous:i,next:i}:{previous:i,next:Pt(i,{version:s.version})}}))}async function le(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 a=(await t.fetchEventSpecification({eventSpecificationId:r})).data[0];return(a.version||0)>s&&(o[r]={previous:s,next:a.version}),r})),o}var ye=require("process"),at=require("path"),Ie=require("fs"),Pe=require("mkdirp"),xe=require("@snowplow/snowtype-core");var Ee=S(require("fs-extra"));var me=require("fs"),he=require("path"),Se=S(require("util"));function ve(t,e,n){let i=e==="typescript"?"ts":"js";(0,me.writeFileSync)((0,he.resolve)(t,`validations.${i}`),`${i==="ts"?'import { AnySchema } from "ajv";':""}
|
|
75
|
+
|
|
76
|
+
export const schemasObject${i==="ts"?": Record<string, AnySchema>":""} = ${Se.default.inspect(n,!1,null)}`,"utf-8")}function we(t){return Object.values(t).some(e=>e.properties?Object.values(e.properties).some(n=>Object.hasOwn(n||{},"pattern")):!1)}var j={instructions:!1,validations:!1};function nn(t,e){return e.debug("Checking for existing configuration.."),L(),e.success("Valid configuration found"),{...j,...t}}async function z(t,e,n,i){let o=nn(i,e);n.setSpinnerTitle("Generating..."),n.isSpinning()===!1&&n.start();let r=rt();F(r.dataStructures)&&F(r.igluCentralSchemas)&&F(r.eventSpecificationIds)&&F(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 C;let g=[...await Ut(s,r.dataProductIds),...r.eventSpecificationIds],u=await Nt(s,g,e,o.instructions),m=await Ft(s,u);xt(u)&&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 l=await Dt(r.igluCentralSchemas),h=await Rt(s,r.dataStructures),V=!!(r.tracker==="@snowplow/browser-tracker"&&r.language.match(/javascript|typescript/)),M={language:r.language,tracker:r.tracker,schemas:[...l,...h],eventSpecifications:m,validations:V&&o.validations},v=await(0,xe.generate)(M);if(!v)throw new H;e.success("Code generated, writing...");let A=v.lines.join(`
|
|
77
|
+
`),P=(0,at.resolve)((0,ye.cwd)(),r.outpath);Ee.default.removeSync((0,at.resolve)(P)),Pe.mkdirp.sync(P);let St=At+ne(r.language);(0,Ie.writeFileSync)((0,at.resolve)(P,St),A),ie(u,r.outpath),V&&o.validations&&v.validationsSchemaObject&&(ve(P,r.language,v.validationsSchemaObject),we(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&&Tt(u,v.lines,P,St)}var lt=I(z);var on={yes:!1,...j};function rn(t,e){let n={...on,...t};return e.debug("Checking for existing configuration.."),L(),e.success("Valid configuration found"),n}async function sn(t,e,n,i){let o=rn(i,e);e.debug("Starting update process with options: ".concat(JSON.stringify(o)));let r=rt(),s=(0,Ae.resolve)((0,ke.cwd)(),r.outpath,Z),a=new y({apiKey:t,organizationId:r.organizationId});n.setSpinnerTitle("Checking for updates..."),n.isSpinning()===!1&&n.start();let c={};if(!R(s)&&r.eventSpecificationIds.length)throw new Y;if(R(s)&&r.eventSpecificationIds.length){let l=te(s);c=await le(a,r.eventSpecificationIds,l)}let u=(await fe(a,r.dataStructures)).filter(l=>l.previous!==l.next);if((Object.entries(c).length>0||u.length>0)===!0){if(e.success("Available updates found!"),oe(c,u,e),o.yes===!0)return u.length>0&&(u.forEach(l=>{let h=r.dataStructures.indexOf(l.previous);r.dataStructures[h]=l.next}),it(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 mt=I(sn);var an={eventSpecificationIds:[],dataStructures:[],igluCentralSchemas:[],dataProductIds:[],yes:!1,...j};function cn(t,e){let n={...an,...t};if(Object.values(n).every(i=>typeof i=="boolean"||i.length===0))throw new B;return e.debug("Checking for existing configuration.."),L(),e.success("Valid configuration found"),n}async function pn(t,e,n,i){let o=cn(i,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=>{de(s,c)})}),e.success("Configuration patched"),o.yes===!0?z(t,e,n,o):(e.log("Code is not generated yet for the patched configuration"),Promise.resolve(void 0))}var ht=I(pn);var Ce="0.3.0";async function Oe(){await import("dotenv/config");let t=new ct.Command;t.exitOverride(),t.version(Ce,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(dt),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(mt),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(ht),t.addHelpText("before",Vt()).addHelpText("after",`
|
|
78
|
+
`),await t.parseAsync(be.argv).catch(e=>{un(e)})}function un(t){if(!(t instanceof ct.CommanderError&&["commander.help","commander.version","commander.helpDisplayed"].indexOf(t.code)>-1))throw t}Oe().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.3.0",
|
|
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.3.0",
|
|
17
17
|
"chalk": "^4.1.2",
|
|
18
18
|
"cli-spinner": "^0.2.10",
|
|
19
19
|
"dotenv": "^16.3.1",
|