@snowplow/snowtype 0.2.3 → 0.2.5
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 +52 -0
- package/dist/index.js +30 -30
- package/package.json +11 -9
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# CLI
|
|
2
|
+
|
|
3
|
+
This package is responsible for our CLI tools, which will be used directly by our users.
|
|
4
|
+
|
|
5
|
+
## For developers
|
|
6
|
+
|
|
7
|
+
Useful scripts:
|
|
8
|
+
|
|
9
|
+
| Script | Description |
|
|
10
|
+
| ------------------- | ------------------------------------ |
|
|
11
|
+
| start | Run cli for development |
|
|
12
|
+
| build:production | Builds project for deployment |
|
|
13
|
+
| build | Builds project for local development |
|
|
14
|
+
| fix-version | Fix version |
|
|
15
|
+
| format:fix | Fix formatting issues |
|
|
16
|
+
| format | Check for any formatting issues |
|
|
17
|
+
| lint:fix | Fix for any lint issues |
|
|
18
|
+
| lint | Check for any lint issues |
|
|
19
|
+
| prebuild:production | Remove dist folder |
|
|
20
|
+
| test | Runs test |
|
|
21
|
+
|
|
22
|
+
### Running the application
|
|
23
|
+
|
|
24
|
+
Add a `.env` file in the `package/cli` folder with the following content:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
SNOWPLOW_CONSOLE_API_KEY=YOUR_KEY_HERE
|
|
28
|
+
SNOWPLOW_CONSOLE_API_URL=https://next.console.snowplowanalytics.com/api/msc
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Then use:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm run snowtype generate
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
This will run the app using ts-node.
|
|
38
|
+
|
|
39
|
+
Alternatively, you can directly use the JavaScript file by running:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm run build
|
|
43
|
+
node dist/index.js
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Notes:
|
|
47
|
+
|
|
48
|
+
- To see the type in the generated code (visible under the snowtype folder), you need to install a related tracker, for instance:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm i -D @snowplow/browser-tracker -w @snowplow/snowtype
|
|
52
|
+
```
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"use strict";var
|
|
1
|
+
"use strict";var Ie=Object.create;var mt=Object.defineProperty;var xe=Object.getOwnPropertyDescriptor;var Ee=Object.getOwnPropertyNames;var Pe=Object.getPrototypeOf,ke=Object.prototype.hasOwnProperty;var Ce=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of Ee(e))!ke.call(t,r)&&r!==n&&mt(t,r,{get:()=>e[r],enumerable:!(i=xe(e,r))||i.enumerable});return t};var S=(t,e,n)=>(n=t!=null?Ie(Pe(t)):{},Ce(e||!t||!t.__esModule?mt(n,"default",{value:t,enumerable:!0}):n,t));var ve=S(require("process")),st=require("@commander-js/extra-typings");var b=require("@inquirer/prompts");var Ae={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."},Te="Please report a bug.",l=class extends Error{code;constructor(e,n=""){let i=Ae[e].concat(n);super(i),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=e}},$=class extends l{constructor(){super("ConfigAlreadyExists")}},H=class extends l{constructor(){super("ConfigNotExists")}},M=class extends l{constructor(e){super("ConfigInvalid",e)}},I=class extends l{constructor(e){super("InternalError",e.concat(Te))}},U=class extends l{constructor(e,n){let i=`Value ${n} is an invalid ${e}.`;super("InvalidOption",i)}},K=class extends l{constructor(){super("MissingOptions")}},k=class extends l{constructor(){super("AuthError")}},W=class extends l{constructor(){super("WriteLockFile")}},B=class extends l{constructor(){super("MissingLockFile")}};var ht=S(require("got"));async function St({schema:t}){return(await(0,ht.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${t.replace("iglu:","")}`)).body}var J=S(require("got"));var wt=require("js-sha256");function at(t){let e=wt.sha256.create();return e.update(t),e.hex()}function w(t){let e=t.replace("iglu:",""),[n,i,r,o]=e.split("/");return{vendor:n,name:i,format:r,version:o}}function vt(t,{vendor:e,name:n,format:i,version:r}){let o=t.replace("iglu:",""),[s,c,a,g]=o.split("/");return`iglu:${e||s}/${n||c}/${i||a}/${r||g}`}function yt(t){return t.some(e=>e.eventSchema.isEcomTemplateSchema)}var v=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:r,version:o}=w(e),s=at(`${this.organizationId}-${n}-${i}-${r}`),c=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/${s}/versions/${o}`;return this.fetchResource(c)}fetchSchemaHash({schema:e}){let{vendor:n,name:i,format:r}=w(e),o=at(`${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,J.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=S(require("joi"));var It=new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$"),Oe=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(It)),dataStructures:p.default.array().optional().items(p.default.string().regex(It)),eventSpecificationIds:p.default.array().optional().items(p.default.string()),dataProductIds:p.default.array().optional().items(p.default.string())}),C=t=>{let e=Oe.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new M(e.error.annotate());return t};var xt="snowtype.config.json",Y=".snowtype-lock.json",Et="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 A=require("process"),T=require("path"),E=require("fs");var Z=require("path"),Pt=require("mkdirp"),ct=require("fs"),kt=require("@snowplow/snowtype-core"),be="instructions.md",Ct="assets";function At(t,e,n,i){Pt.mkdirp.sync((0,Z.resolve)(n,Ct));let r=[],o=Ue(t,e,i),s=[];for(let a of t)s.push(X(a.eventSpecification.name)),$e(a,n),r.push(Le({eventStructureName:a.eventSchema.self.name,entitiesStructureNames:a.entitiesSchemas?.map(g=>g.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._
|
|
@@ -9,8 +9,8 @@ ${s.map(a=>`- [${a.instructionsTitle}](#${a.instructionsLink})`).join(`
|
|
|
9
9
|
|
|
10
10
|
${r.join(`
|
|
11
11
|
`)}
|
|
12
|
-
`;(0,
|
|
13
|
-
## ${
|
|
12
|
+
`;(0,ct.writeFileSync)((0,Z.resolve)(n,be),c,"utf-8")}function Le({eventStructureName:t,entitiesStructureNames:e,name:n,id:i,version:r,triggerInstructions:o,linkToCode:s}){let c="_N/A_";return`
|
|
13
|
+
## ${X(n).instructionsTitle}
|
|
14
14
|
|
|
15
15
|
| | |
|
|
16
16
|
| ----------- | ----------- |
|
|
@@ -20,15 +20,15 @@ ${r.join(`
|
|
|
20
20
|
| **Entity Data Structures** | ${e?.sort().join(", ")} |
|
|
21
21
|
| **Code** | [Link](./${s}) |
|
|
22
22
|
|
|
23
|
-
${o.map((a,g,
|
|
24
|
-
### Trigger ${
|
|
23
|
+
${o.map((a,g,u)=>`
|
|
24
|
+
### Trigger ${u.length!==1?g+1:""}
|
|
25
25
|
|
|
26
26
|
#### Screenshot
|
|
27
27
|
${a.imageBuffer?`[<img src="./assets/${i}_${g}.${a.imageExtension}" width="550"/>](./assets/${i}_${g}.${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(m=>"`"+m+"` "):c}
|
|
32
32
|
|
|
33
33
|
#### The URL of the page on which this event specification triggers:
|
|
34
34
|
|
|
@@ -37,40 +37,40 @@ ${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,ct.writeFileSync)((0,Z.resolve)(e,Ct,t.eventSpecification.id+"_"+i+"."+n.imageExtension),n.imageBuffer,"binary")})}function Ue(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,kt.createEventSpecificationInstructionsIdentifier)(r)));i[r]=n+"#L"+o}),i}function X(t){let e=t;return{instructionsTitle:e,instructionsLink:Ne(e)}}function Ne(t){return t.toLowerCase().replace(/[^a-z\d\s-]/g," ").replace(/\s+/g," ").trim().replace(/-{2,}|\s/g,"-")}var Ot=S(require("mime-types"));var Re=["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 bt(t,e){let n=[];for(let r of e)n.push(t.fetchDataProduct({dataProductId:r}));return(await Promise.all(n)).map(({data:r})=>r[0].trackingScenarios).flat().map(r=>r?.id).filter(r=>!!r)}function De(t){let{original:e}=t,[n,i]=e.split("/").reverse();return{imageVariant:n,imageId:i}}async function _e(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:g,imageId:u}=De(c),m=await t.fetchImageVariant({imageId:u,imageVariant:g});a.imageBuffer=m.rawBody,a.imageExtension=Ot.default.extension(m.headers["content-type"])||""}n.push(a)}return n}async function Lt(t,e,n,i){let r=[];for(let o of e){let s=await t.fetchEventSpecification({eventSpecificationId:o}),c=s.data[0]?.name,a=s.data[0]?.triggers,g=s.data[0]?.event?.schema?.properties?.type?.enum?.[0],u;i&&c&&(u={triggers:await _e(t,a),instructionsHeading:X(c)});let m=s.data[0]?.version,f=s.data[0]?.event;if(typeof f>"u")continue;if(Re.includes(f.source)){n.warn("Currently you cannot generate code for `Standard` events. Skipping...");continue}let L=f.source.match(Tt)?{self:w(f.source),isEcomTemplateSchema:g}:await t.fetchSchemaVersion({schema:f.source}),P=[],V=[];s.data[0]?.entities?.tracked?.forEach(h=>V.push(h.source)),await Promise.all(V.map(async h=>{let j=h.match(Tt)?{self:w(f.source),isEcomTemplateSchema:g}:await t.fetchSchemaVersion({schema:h});P.push(j)})),r.push({eventSpecification:{name:c||"",id:o},version:m||0,eventSchema:L,entitiesSchemas:P,instructions:u})}return r}async function $t(t){return await Promise.all(t.map(async n=>JSON.parse(await St({schema:n}))))}async function Ut(t,e){return await Promise.all(e.map(i=>t.fetchSchemaVersion({schema:i})))}var Rt=require("cli-spinner"),d=S(require("chalk"));function Dt(){let t=new Rt.Spinner;return t.setSpinnerString(18),t}var Fe="https://snowplow.io",Ge="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 Nt(t){return d.default.hex(_t.LINK).bold(t)}function x(t){return d.default.hex(_t.OPTION).italic(t)}function Q(t,e){switch(t){case"h1":return d.default.bold.underline(e);default:return d.default.bold(e)}}function Ft(){return`
|
|
41
|
+
${Q("h1","CLI Help")}
|
|
42
42
|
|
|
43
|
-
For more information visit the Snowplow website ${
|
|
43
|
+
For more information visit the Snowplow website ${Nt(Fe)}
|
|
44
44
|
|
|
45
|
-
For details see the CLI documentation ${
|
|
45
|
+
For details see the CLI documentation ${Nt(Ge)}
|
|
46
46
|
|
|
47
|
-
${
|
|
48
|
-
1. Use ${
|
|
49
|
-
2. Use ${
|
|
50
|
-
3. Use ${
|
|
47
|
+
${Q("h2","How to get started")}
|
|
48
|
+
1. Use ${d.default.cyanBright("snowtype init")} to initialize the setup.
|
|
49
|
+
2. Use ${d.default.cyanBright("snowtype patch")} to add a Data Structure or Event Specification.
|
|
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
|
+
${Q("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
|
|
70
|
-
${
|
|
71
|
-
${
|
|
72
|
-
`}var
|
|
73
|
-
Find out more ${
|
|
74
|
-
`);let r=await
|
|
75
|
-
`),
|
|
76
|
-
`),await t.parseAsync(
|
|
67
|
+
${Q("h2","Debug")}
|
|
68
|
+
Use the ${x("-v")} to output verbose logs
|
|
69
|
+
`}function Gt(t){let e=`${N.SUCCESS}: `;return d.default.cyanBright(e)+t}function zt(t){let e=`${N.WARN} Warning: `;return d.default.hex("#FFA500")(e)+t}function Vt(t){let e=`${N.LOG} ${t}`;return d.default.yellowBright(e)}function jt(t){let e=`${N.DEBUG} Debug: `;return d.default.magenta(e)+t}function Ht(t){let e=`${N.ERROR} Error: `;return d.default.redBright(e)+t}function Mt(t,e){let n=`- ${t}`,i=`+ ${e}`;return`
|
|
70
|
+
${d.default.magenta(n)}
|
|
71
|
+
${d.default.cyanBright(i)}
|
|
72
|
+
`}var Kt={...q},tt=`./${xt}`;function Wt(t){return t.length!==0}function Bt(t){return Array.isArray(Kt[t])}function Jt(t,e){let n=Kt[t];return Array.isArray(n)?!!n.map(r=>r.value).includes(e):!1}function Yt(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,T.resolve)((0,A.cwd)(),tt);return(0,E.writeFileSync)(e,JSON.stringify(t,null,2))}function R(t){let e=(0,E.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function nt(t){return(0,E.readFileSync)(t,{encoding:"utf-8"})}function it(){let t=(0,T.resolve)((0,A.cwd)(),tt);return JSON.parse(nt(t))}function qt(t){return JSON.parse(nt(t))}function O(){let t=(0,T.resolve)((0,A.cwd)(),tt);if(R(t)===!1)throw new H;let e=JSON.parse(nt(t));return C(e)}function Zt(){let t=(0,T.resolve)((0,A.cwd)(),tt);if(R(t)===!0){let e=nt(t);try{throw C(JSON.parse(e)),new $}catch(n){if(n instanceof $)throw n}}}function Xt(t){return{javascript:".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go"}[t]||""}function Qt(t,e){let n={eventSpecifications:{}};t.forEach(r=>{n.eventSpecifications[r.eventSpecification.id]=r.version});let i=(0,T.resolve)((0,A.cwd)(),e,Y);try{(0,E.writeFileSync)(i,JSON.stringify(n,null,2))}catch{throw new W}}function te(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)}),e.length>0&&n.success("Available Data Structures Updates"),e.forEach(r=>{let o=`${r.previous}`,s=`${r.next}`;n.diff(o,s)})}function ee(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 ne(t){return t.type==="input"}function ie(t){return t.type==="password"}function pt(t){return t.type==="select"}function re(){return{withVerbosity:e=>({success:i=>{console.log(Gt(i))},warn:i=>{console.log(zt(i))},log:i=>{console.log(Vt(i))},diff:(i,r)=>{console.log(Mt(i,r))},debug:i=>{e===!0&&console.log(jt(JSON.stringify(i)))},error:i=>{console.log(Ht(i.message)),e===!0&&console.log(i)}})}}function y(t){return(e,n)=>{let i=ee(n),r=re(),o=Dt(),s=r.withVerbosity(i.verbose),c=i.apiKey;return t(c,s,o,e).then(()=>oe(o)).catch(a=>{ze(a,s,o)})}}function ze(t,e,n){throw oe(n),e.error(t),t}function oe(t){t.isSpinning()===!0&&t.stop(!0)}var se=S(require("chalk")),_=[{type:"password",message:"Enter your Snowplow organization ID:",mask:!0,validate:Wt},{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"}],Ve={organizationId:"",tracker:"",language:"",outpath:""};function F(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 I("Invalid default options.")}if(ne(n))return(0,b.input)(n);if(ie(n))return(0,b.password)(n);if(pt(n))return(0,b.select)(n);throw new I("Unknown Prompt inquired.")}function je(t,e){return pt(e)&&(e.choices=t),e}async function He(t,e){let n={...Ve};e.debug("Checking for existing configuration file.."),Zt();let i=await F("organizationId",t,_[0]);n.organizationId=i;let r=await F("tracker",t,_[1]);if(!Bt(r))throw new U("tracker",r);n.tracker=r;let o=q[r];if(!Array.isArray(o)||o.length===0)throw new I("Missing language entry.");let s;if(o.length===1){let a=o[0];if(typeof a>"u")throw new I("Missing language.");s=await F("language",t,_[2],a.value)}else s=await F("language",t,je(o,_[2]));if(!Jt(n.tracker,s))throw new U("language",s);n.language=s;let c=await F("outpath",t,_[3]);return n.outpath=c,e.debug("Assempling initialization options.."),n}async function Me(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 ${se.default.underline("https://docs.snowplow.io/docs/collecting-data/code-generation/using-the-cli/#authenticating-with-the-console")}
|
|
74
|
+
`);let r=await He(i,e);n.setSpinnerTitle("Initialising..."),n.isSpinning()===!1&&n.start(),e.debug("Creating configuration with options: ".concat(JSON.stringify(r)));let o=Yt(r);if(C(o),!await new v({apiKey:t,organizationId:o.organizationId}).authenticate())throw new k;e.success("Authentication succeeded"),et(o),e.success("Configuration created")}var gt=y(Me);var he=require("process"),Se=require("path");var rt=require("fs"),ut=require("path");var ae="snowtype.config.json";function Ke(t){(0,rt.writeFileSync)((0,ut.resolve)(process.cwd(),`./${ae}`),JSON.stringify(t,null,2))}function ce(t,e){try{let n=(0,rt.readFileSync)((0,ut.resolve)(process.cwd(),`./${ae}`),{encoding:"utf-8"}),i=JSON.parse(n);return i[t].some(o=>o===e)||i[t].push(e),Ke(i),!0}catch(n){return console.error(n),!1}}async function pe(t,e){return await Promise.all(e.map(async i=>{let{version:r}=w(i),{deployments:o}=await t.fetchSchemaHash({schema:i}),s=o.reduce((c,a)=>new Date(a.ts)>new Date(c.ts)?a:c,o[0]);return s.version===r?{previous:i,next:i}:{previous:i,next:vt(i,{version:s.version})}}))}async function ge(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];return(c.version||0)>s&&(r[o]={previous:s,next:c.version}),o})),r}var ue=require("process"),ot=require("path"),fe=require("fs"),de=require("mkdirp"),le=require("@snowplow/snowtype-core");var me=S(require("fs-extra"));var G={instructions:!1};function We(t,e){return e.debug("Checking for existing configuration.."),O(),e.success("Valid configuration found"),{...G,...t}}async function z(t,e,n,i){let r=We(i,e);n.setSpinnerTitle("Generating..."),n.isSpinning()===!1&&n.start();let o=it();D(o.dataStructures)&&D(o.igluCentralSchemas)&&D(o.eventSpecificationIds)&&D(o.dataProductIds)&&e.warn("Data Structures, Schemas and Event Specifications are empty.");let s=new v({apiKey:t,organizationId:o.organizationId});if(!await s.authenticate())throw new k;let g=[...await bt(s,o.dataProductIds),...o.eventSpecificationIds],u=await Lt(s,g,e,r.instructions);yt(u)&&o.tracker==="@snowplow/browser-tracker"&&e.log("You are generating Snowplow Ecommerce events. You would need to install `@snowplow/browser-plugin-snowplow-ecommerce`.");let m=await $t(o.igluCentralSchemas),f=await Ut(s,o.dataStructures),L={language:o.language,tracker:o.tracker,schemas:[...m,...f],eventSpecifications:u},P=await(0,le.generate)(L);e.success("Code generated, writing...");let V=P?.lines.join(`
|
|
75
|
+
`),h=(0,ot.resolve)((0,ue.cwd)(),o.outpath);me.default.removeSync((0,ot.resolve)(h)),de.mkdirp.sync(h);let j=Et+Xt(o.language);(0,fe.writeFileSync)((0,ot.resolve)(h,j),V),Qt(u,o.outpath),P&&r.instructions&&At(u,P.lines,h,j)}var ft=y(z);var Be={yes:!1,...G};function Je(t,e){let n={...Be,...t};return e.debug("Checking for existing configuration.."),O(),e.success("Valid configuration found"),n}async function Ye(t,e,n,i){let r=Je(i,e);e.debug("Starting update process with options: ".concat(JSON.stringify(r)));let o=it(),s=(0,Se.resolve)((0,he.cwd)(),o.outpath,Y),c=new v({apiKey:t,organizationId:o.organizationId});n.setSpinnerTitle("Checking for updates..."),n.isSpinning()===!1&&n.start();let a={};if(!R(s)&&o.eventSpecificationIds.length)throw new B;if(R(s)&&o.eventSpecificationIds.length){let f=qt(s);a=await ge(c,o.eventSpecificationIds,f)}let u=(await pe(c,o.dataStructures)).filter(f=>f.previous!==f.next);if((Object.entries(a).length>0||u.length>0)===!0){if(e.success("Available updates found!"),te(a,u,e),r.yes===!0)return u.length>0&&(u.forEach(f=>{let L=o.dataStructures.indexOf(f.previous);o.dataStructures[L]=f.next}),et(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 dt=y(Ye);var qe={eventSpecificationIds:[],dataStructures:[],igluCentralSchemas:[],dataProductIds:[],yes:!1,...G};function Ze(t,e){let n={...qe,...t};if(Object.values(n).every(i=>typeof i=="boolean"||i.length===0))throw new K;return e.debug("Checking for existing configuration.."),O(),e.success("Valid configuration found"),n}async function Xe(t,e,n,i){let r=Ze(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=>{ce(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 lt=y(Xe);var we="0.2.5";async function ye(){await import("dotenv/config");let t=new st.Command;t.exitOverride(),t.version(we,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).description("Generates tracking code based on configuration on the `snowtype.config.json` file.").action(ft),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(lt),t.addHelpText("before",Ft()).addHelpText("after",`
|
|
76
|
+
`),await t.parseAsync(ve.argv).catch(e=>{Qe(e)})}function Qe(t){if(!(t instanceof st.CommanderError&&["commander.help","commander.version","commander.helpDisplayed"].indexOf(t.code)>-1))throw t}ye().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.5",
|
|
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.5",
|
|
17
17
|
"chalk": "^4.1.2",
|
|
18
18
|
"cli-spinner": "^0.2.10",
|
|
19
19
|
"dotenv": "^16.3.1",
|
|
@@ -36,20 +36,22 @@
|
|
|
36
36
|
"jest": "^29.7.0",
|
|
37
37
|
"rimraf": "^5.0.5",
|
|
38
38
|
"ts-jest": "^29.1.1",
|
|
39
|
-
"ts-node": "^10.
|
|
39
|
+
"ts-node": "^10.9.2",
|
|
40
40
|
"tslib": "^2.4",
|
|
41
41
|
"typescript": "5.2.2"
|
|
42
42
|
},
|
|
43
43
|
"scripts": {
|
|
44
|
-
"
|
|
45
|
-
"
|
|
44
|
+
"snowtype": "ts-node src/index.ts",
|
|
45
|
+
"build:production": "esbuild --bundle --packages=external --platform=node --target=es2022 --outdir=dist --minify src/index.ts",
|
|
46
46
|
"build": "tsc",
|
|
47
|
-
"
|
|
47
|
+
"fix-version": "node ./scripts/version.js",
|
|
48
|
+
"format:fix": "prettier --write src",
|
|
49
|
+
"format": "prettier --check src",
|
|
48
50
|
"lint:fix": "eslint src --fix",
|
|
49
|
-
"
|
|
50
|
-
"test": "jest --passWithNoTests",
|
|
51
|
+
"lint": "eslint src",
|
|
51
52
|
"prebuild:production": "npm run fix-version && rimraf ./dist",
|
|
52
|
-
"
|
|
53
|
+
"prebuild": "npm run fix-version",
|
|
54
|
+
"test": "jest --passWithNoTests"
|
|
53
55
|
},
|
|
54
56
|
"engines": {
|
|
55
57
|
"node": ">=18"
|