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