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