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