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