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