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