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