@snowplow/snowtype 0.10.2 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +36 -64
- package/package.json +8 -5
- package/types.d.ts +11 -0
package/dist/index.js
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
"use strict";var
|
|
2
|
-
`);super(a),this.response={statusCode:n,body:r}}};function
|
|
1
|
+
"use strict";var Nn=Object.create;var ne=Object.defineProperty;var Mn=Object.getOwnPropertyDescriptor;var Un=Object.getOwnPropertyNames;var _n=Object.getPrototypeOf,Gn=Object.prototype.hasOwnProperty;var Hn=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of Un(e))!Gn.call(t,o)&&o!==n&&ne(t,o,{get:()=>e[o],enumerable:!(i=Mn(e,o))||i.enumerable});return t};var f=(t,e,n)=>(n=t!=null?Nn(_n(t)):{},Hn(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var bn=f(require("process")),b=require("@commander-js/extra-typings");var O=require("@inquirer/prompts");var zn={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.",DevNotAllowed:"Code generation using schemas in DEV environment not allowed. Publish the schemas and retry.",AuthCredentialsMissing:"Required API key credentials not detected. Please refer to https://docs.snowplow.io/docs/collecting-data/code-generation/using-the-cli/#authenticating-with-the-console"},Bn="Please report a bug.",h=class extends Error{code;constructor(e,n=""){let i=zn[e].concat(n);super(i),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=e}},Z=class extends h{constructor(){super("GenerationFailed")}},z=class extends h{constructor(){super("ConfigAlreadyExists")}},Q=class extends h{constructor(){super("ConfigNotExists")}},tt=class extends h{constructor(e){super("ConfigInvalid",e)}},et=class extends h{constructor(e){super("InternalError",e.concat(Bn))}},R=class extends h{constructor(e,n){let i=`Value ${n} is an invalid ${e}.`;super("InvalidOption",i)}},nt=class extends h{constructor(){super("MissingOptions")}},L=class extends h{constructor(){super("AuthError")}},it=class extends h{constructor(){super("WriteLockFile")}},ot=class extends h{constructor(){super("MissingLockFile")}},rt=class extends h{constructor(){super("PatchingNotSupported")}},at=class extends h{constructor(){super("DevNotAllowed")}},st=class extends h{constructor(){super("AuthCredentialsMissing")}};var ie=f(require("got"));async function oe({schema:t}){return(await(0,ie.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${t.replace("iglu:","")}`)).body}var ht=f(require("got"));var de=require("js-sha256"),Ft=f(require("assert"));var u=f(require("joi")),dt=require("@snowplow/snowtype-core");var kt=f(require("assert"));var B="snowtype.config",ct=".js",pt=".ts",ut=".json",re=Object.freeze([ct,pt,ut]),lt=".snowtype-lock.json",ae="snowplow";var J={"google-tag-manager":[{value:"javascript-gtm",name:"JavaScript"}],"@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"}],"snowplow-flutter-tracker":[{value:"dart",name:"Dart"}],"snowplow-java-tracker":[{value:"java",name:"Java"}]},se={commands:{generate:{instructions:!1,validations:!1,disallowDevSchemas:!1,deprecateOnlyOnProdAvailableUpdates:!1},update:{maximumBump:"major",regenerateOnUpdate:!1,showOnlyProdUpdates:!1},patch:{regenerateOnPatch:!1}}},ce=["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","iglu:com.snowplowanalytics.snowplow/application_background/jsonschema/1-0-0","iglu:com.snowplowanalytics.snowplow/application_foreground/jsonschema/1-0-0","iglu:com.snowplowanalytics.mobile/application_install/jsonschema/1-0-0","iglu:com.snowplowanalytics.mobile/screen_end/jsonschema/1-0-0","iglu:com.snowplowanalytics.snowplow/custom_event/jsonschema/1-0-0"],pe="iglu:com.snowplowanalytics.snowplow.ecommerce";var gt=require("lodash");function le(t){let e=t.split("-");(0,kt.default)(e.length===3,"invalid SchemaVer"),(0,kt.default)(e.filter(n=>isNaN(parseInt(n))).length===0,"invalid SchemaVer")}function $(t){t.options=(0,gt.merge)((0,gt.cloneDeep)(se),t.options||{})}var ue=new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$"),Jn=u.default.object().required().keys({tracker:u.default.string().required().valid(...dt.trackerTemplates),language:u.default.string().required().valid(...dt.languageIds),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(ue)),repositories:u.default.array().optional().items(u.default.string()),dataStructures:u.default.array().optional().items(u.default.string().regex(ue)),eventSpecificationIds:u.default.array().optional().items(u.default.string()),dataProductIds:u.default.array().optional().items(u.default.string()),options:u.default.object().optional().keys({commands:u.default.object().optional().keys({generate:u.default.object().optional().keys({instructions:u.default.boolean().optional(),validations:u.default.boolean().optional(),disallowDevSchemas:u.default.boolean().optional(),deprecateOnlyOnProdAvailableUpdates:u.default.boolean().optional()}),patch:u.default.object().optional().keys({regenerateOnPatch:u.default.boolean().optional()}),update:u.default.object().optional().keys({maximumBump:u.default.string().valid("major","minor","patch").optional(),regenerateOnUpdate:u.default.boolean().optional(),showOnlyProdUpdates:u.default.boolean().optional()})})})}),j=t=>{let e=Jn.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new tt(e.error.annotate());return t};function Kn(t){let e=de.sha256.create();return e.update(t),e.hex()}function mt(t,e){let{vendor:n,name:i,format:o}=I(t);return Kn(`${e}-${n}-${i}-${o}`)}function I(t){let e=t.replace("iglu:",""),[n,i,o,r]=e.split("/");return(0,Ft.default)(typeof n=="string"&&typeof i=="string"&&typeof o=="string"&&typeof r=="string",`invalid iglu uri ${t}`),le(r),{vendor:n,name:i,format:o,version:r}}function ge(t,{vendor:e,name:n,format:i,version:o}){let r=t.replace("iglu:",""),[a,s,p,c]=r.split("/");return`iglu:${e||a}/${n||s}/${i||p}/${o||c}`}function me(t){return t.some(e=>e.eventSchema.isEcomTemplateSchema)}function K(t){let[e,n,i]=t.split("-").map(o=>parseInt(o));return{model:e,revision:n,addition:i}}function fe(t,e,n=0){if(t===e&&n!==0)return"patch";let{model:i,revision:o,addition:r}=K(t),{model:a,revision:s,addition:p}=K(e);if(i!==a)return"major";if(o!==s)return"minor";if(r!==p)return"patch";(0,Ft.default)(!1,"SchemaVer checking went wrong")}var ft=class extends Error{response;constructor(e){let n=e.response?.statusCode||0,{method:i,url:o}=e.options,r=e.response?.body||e.message,a=[[n,i,o].filter(Boolean).join(" "),r].filter(Boolean).join(`
|
|
2
|
+
`);super(a),this.response={statusCode:n,body:r}}};function he(t){return!!Object.hasOwn(t||{},"response")}var V="0.11.0";var P=class{apiKeyId;apiKey;organizationId;accessToken;apiUrl=process.env.SNOWPLOW_CONSOLE_API_URL||"https://console.snowplowanalytics.com/api/msc";constructor({apiKeyId:e,apiKey:n,organizationId:i}){this.apiKeyId=e,this.apiKey=n,this.organizationId=i}async fetchAccessToken(){if(this.accessToken)return this.accessToken;let e=`${this.apiUrl}/v1/organizations/${this.organizationId}/credentials/v3/token`,{accessToken:n}=await(0,ht.default)(e,{headers:{"X-API-Key-Id":this.apiKeyId,"X-API-Key":this.apiKey,"X-Snowtype":V}}).json();return this.accessToken=n,n}async fetchResource(e){let n=await this.fetchAccessToken();try{return await(0,ht.default)(e,{headers:{Authorization:"Bearer "+n,"X-Snowtype":V}}).json()}catch(i){throw he(i)?new ft(i):i}}fetchSchemaVersion({schema:e,env:n="DEV"}){let{version:i}=I(e),o=mt(e,this.organizationId),r=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/${o}/versions/${i}?env=${n}`;return this.fetchResource(r)}fetchSchemaHash({schema:e}){let n=mt(e,this.organizationId),i=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/${n}`;return this.fetchResource(i)}async fetchDeployments({schema:e,deploymentEnv:n}){let i=mt(e,this.organizationId),o=25,r=[],a=!0,s=0,p=c=>`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/${i}/deployments?size=${o}&from=${c}${n?`&env=${n}`:""}`;for(;a;){let c=await this.fetchResource(p(s));s+=o,r=r.concat(c),c.length===0&&(a=!1)}return r}fetchEventSpecification({eventSpecificationId:e}){let n=`${this.apiUrl}/v1/organizations/${this.organizationId}/event-specs/v1/${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,ht.default)(i,{headers:{Authorization:"Bearer "+o,"X-Snowtype":V}})}fetchDataProduct({dataProductId:e}){let n=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-products/v2/${e}`;return this.fetchResource(n)}async authenticate(){try{return await this.fetchAccessToken(),!0}catch{return!1}}};var E=require("path"),y=require("fs");var Wt=f(require("util")),Nt=require("tsx/cjs/api");var T=(()=>{let t="json";return{setFormat:i=>t=i,getFormat:()=>t}})();var Et=require("@snowplow/snowtype-core");var vt=require("fs");var St=f(require("assert"));var Se=require("semver");function ve(t,e,n){try{let i=(0,vt.readFileSync)(n,{encoding:"utf-8"}),o=JSON.parse(i);return o[t].some(a=>a===e)||o[t].push(e),(0,vt.writeFileSync)(n,$t(o)),!0}catch(i){return console.error(i),!1}}var qn=(t,e)=>{let{model:n,revision:i,addition:o}=K(t.version),{model:r,revision:a,addition:s}=K(e.version);return(0,St.default)(n!==void 0&&i!==void 0&&o!==void 0&&r!==void 0&&a!==void 0&&s!==void 0,`Invalid version number comparing (${t}, ${e})`),n>r?1:n<r?-1:i>a?1:i<a?-1:o>s?1:o<s?-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 ye(t,e,n,i){return(await Promise.all(e.map(async r=>{let{version:a}=I(r),s=await t.fetchDeployments({schema:r,...i&&{deploymentEnv:"PROD"}}),p=Xn(s,a,n);p.sort(qn);let c=p.pop();if(!c)return null;let l={previous:r,next:ge(r,{version:c.version}),nextEnv:c.env};return c.version!==a?{...l,nextReason:"version"}:c.patchLevel>0&&c.env==="DEV"?{...l,nextReason:"patch"}:null}))).flatMap(r=>r===null?[]:[r])}async function Rt(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 we(t,e,n){let{eventSpecifications:i}=n,o={};return await Promise.all(e.map(async r=>{let a=i[r];if(!a)return r;let s=(await t.fetchEventSpecification({eventSpecificationId:r})).data[0];(0,St.default)(!!s,`failed to fetch event spec ${r}`),(0,St.default)(!!s.version,`event spec with no version ${r}`);let p=[s.event?.source,...s.entities?.tracked?.map(l=>l.source)||[]].flatMap(l=>typeof l=="string"?[l]:[]),c=await Rt(t,p);return(s.version||0)>a&&(o[r]={previous:a,next:s.version,devOnlySchema:c}),r})),o}function Xn(t,e,n){return t.filter(i=>Lt(e,i.version)!==1).filter(i=>i.version!==e||i.patchLevel).map(i=>({...i,updateType:fe(i.version,e,i.patchLevel)})).filter(Yn(n))}function Yn(t){return({updateType:e})=>{switch(t){case"major":return!0;case"minor":return e==="patch"||e==="minor";case"patch":return e==="patch"}}}function Lt(t,e){let n=t.replaceAll("-","."),i=e.replaceAll("-",".");return(0,Se.compare)(n,i)}var Ee=require("cli-spinner"),S=f(require("chalk"));function xe(){let t=new Ee.Spinner;return t.setSpinnerString(18),t}var Zn="https://snowplow.io",Qn="https://docs.snowplow.io/docs/collecting-data/code-generation/",q={SUCCESS:"\u2714",LOG:"\u2139",DEBUG:"\u27A4",ERROR:"\u2717",WARN:"\u26A0"},Pe={LINK:"#9911BB",OPTION:"#9911DD"};function Ie(t){return S.default.hex(Pe.LINK).bold(t)}function D(t){return S.default.hex(Pe.OPTION).italic(t)}function yt(t,e){switch(t){case"h1":return S.default.bold.underline(e);default:return S.default.bold(e)}}function Ce(){return`
|
|
3
3
|
${yt("h1","CLI Help")}
|
|
4
4
|
|
|
5
|
-
For more information visit the Snowplow website ${
|
|
5
|
+
For more information visit the Snowplow website ${Ie(Zn)}
|
|
6
6
|
|
|
7
|
-
For details see the CLI documentation ${
|
|
7
|
+
For details see the CLI documentation ${Ie(Qn)}
|
|
8
8
|
|
|
9
9
|
${yt("h2","How to get started")}
|
|
10
10
|
1. Use ${S.default.cyanBright("snowtype init")} to initialize the setup.
|
|
@@ -12,68 +12,39 @@ ${yt("h2","How to get started")}
|
|
|
12
12
|
3. Use ${S.default.cyanBright("snowtype generate")} to generate tracking code.
|
|
13
13
|
|
|
14
14
|
${yt("h2","Available commands")}
|
|
15
|
-
To learn more about each CLI command, use the ${
|
|
15
|
+
To learn more about each CLI command, use the ${D("--help")} option, for example, ${D("snowtype init --help")}.
|
|
16
16
|
|
|
17
|
-
${
|
|
17
|
+
${D("snowtype init")}
|
|
18
18
|
Initialize the setup of Snowtype code generation in a project. Creates the \`snowtype.config.json\` file.
|
|
19
19
|
|
|
20
|
-
${
|
|
20
|
+
${D("snowtype patch")}
|
|
21
21
|
Adds new Data Structures and Event Specifications in the \`snowtype.config.json\` file.
|
|
22
22
|
|
|
23
|
-
${
|
|
23
|
+
${D("snowtype generate")}
|
|
24
24
|
Generates tracking code based on configuration on the \`snowtype.config.json\` file.
|
|
25
25
|
|
|
26
|
-
${
|
|
26
|
+
${D("snowtype update")}
|
|
27
27
|
Checks for latest version updates in Data Structures and Event Specifications.
|
|
28
28
|
|
|
29
29
|
${yt("h2","Debug")}
|
|
30
|
-
Use the ${
|
|
31
|
-
`}function
|
|
30
|
+
Use the ${D("-v")} to output verbose logs
|
|
31
|
+
`}function Ae(t){let e=`${q.SUCCESS}: `;return S.default.cyanBright(e)+t}function wt(t){let e=`${q.WARN} Warning: `;return S.default.hex("#FFA500")(e)+t}function Oe(t){let e=`${q.LOG} ${t}`;return S.default.yellowBright(e)}function be(t){let e=`${q.DEBUG} Debug: `;return S.default.magenta(e)+t}function Te(t){let e=`${q.ERROR} Error: `;return S.default.redBright(e)+t}function De(t,e){let n=`- ${t}`,i=`+ ${e}`;return`
|
|
32
32
|
${S.default.magenta(n)}
|
|
33
33
|
${S.default.cyanBright(i)}
|
|
34
|
-
`}var
|
|
34
|
+
`}var $e=f(require("mime-types"));var ke=t=>{let e={outdatedDsWarnings:[],hiddenDsWarnings:[],metrics:[]};return t.reduce((n,i)=>ti({currentMetadata:n,eventSpecificationId:i.eventSpecification.id,newMetadata:i.metadata||e}),{})};function ti({currentMetadata:t,eventSpecificationId:e,newMetadata:n}){let i=(o,r)=>o.id>r.id?1:-1;return{...t,[e]:{hiddenDsWarnings:n.hiddenDsWarnings.sort(i).map(o=>({sources:o.sources})),outdatedDsWarnings:n.outdatedDsWarnings.sort(i).map(o=>({sources:o.sources}))}}}var Fe=t=>(e,n)=>{ei(e,n||"").forEach(t.warn)};function ei(t,e){let n=ni(t.outdatedDsWarnings,e),i=ii(t.hiddenDsWarnings,e);return n.concat(i)}function ni(t,e){return t.reduce((n,i)=>{let o=i.sources.map(r=>[`Source: ${r.source}`,`Latest Version: ${r.latestVersion}`].join(`
|
|
35
35
|
`));return[...n,`${["Outdated Data Structures detected:",`Data Product Id: ${e}`,`Event Specification Id: ${i.id}`,...o].join(`
|
|
36
|
-
`)}`]},[])}function
|
|
36
|
+
`)}`]},[])}function ii(t,e){return t.reduce((n,i)=>{let o=i.sources.map(r=>`Source: ${r.source}`).join(`
|
|
37
37
|
`);return[...n,`${["Hidden Data Structures detected:",`Data Product Id: ${e}`,`Event Specification Id: ${i.id}`,o].join(`
|
|
38
|
-
`)}`]},[])}async function
|
|
38
|
+
`)}`]},[])}async function Re(t,e){let n=ri(t),i=await Promise.all(n.map(async r=>({schema:r,deployments:await e.fetchDeployments({schema:r,deploymentEnv:"PROD"})}))),o=oi(i);return ai(t,o)}var oi=t=>t.flatMap(({schema:e,deployments:n})=>{let{version:i}=I(e);return n.filter(r=>Lt(i,r.version)===-1).length===0?[]:[e]}),ri=t=>W(Object.entries(t).filter(([,e])=>e.outdatedDsWarnings.length!==0).flatMap(([,e])=>e.outdatedDsWarnings.flatMap(n=>n.sources.map(i=>i.source)))),ai=(t,e)=>Object.keys(t).reduce((n,i)=>{let o=t[i];if(o){let r=o.outdatedDsWarnings.flatMap(({sources:a})=>{let s=a.filter(p=>e.includes(p.source));return s.length>0?[{sources:s}]:[]});n[i]={...o,outdatedDsWarnings:r}}return n},{});async function It(t,e){return(await Promise.all(e.map(i=>t.fetchDataProduct({dataProductId:i})))).flatMap(({data:[i]})=>i?i.eventSpecs:[]).map(i=>i.id)}function si(t){let{original:e}=t,[n,i]=e.split("/").reverse();return{imageVariant:n,imageId:i}}async function je(t,e){let n=[];if(!(e&&e.length))return[];for(let i of e){let{description:o,appIds:r,url:a,variantUrls:s}=i,p={description:o,appIds:r,url:a};if(s){let{imageVariant:c,imageId:l}=si(s),m=await t.fetchImageVariant({imageId:l,imageVariant:c});p.imageBuffer=m.rawBody,p.imageExtension=$e.default.extension(m.headers["content-type"])||""}n.push(p)}return n}async function Ve(t,e,n){return{eventSpecificationsWithId:(await Promise.all(e.map(async o=>{let r=await t.fetchEventSpecification({eventSpecificationId:o}),a=r.data[0];if(typeof a>"u"||typeof a.event>"u")return[];!!r.metadata&&Fe(n)(r.metadata,a.dataProductId);let p=jt(a.event.source);p&&n.warn("Currently code will not be generated for `Standard` events. Skipping...");let c=a.triggers,l=a.name,m=a.version,v=a.sourceApplications||[],d=a.event.schema,w=p?pi(a.event.source):await Le(t,a,a.event.source),g=a.entities?.tracked||[],_=await Promise.all(g.map(async({source:x,schema:G})=>({original:await Le(t,a,x),propertyRule:G})));return{eventSpecification:{name:l||"",id:o,dataProductId:a.dataProductId||"",dataProductName:""},version:m||0,eventSchema:w,entitiesSchemas:_,entities:g,triggers:c,propertyRules:d,sourceApplicationIds:v,metadata:r.metadata}}))).flat()}}async function We(t){return await Promise.all(t.map(async n=>JSON.parse(await oe({schema:n}))))}async function Ne(t,e){return await Promise.all(e.map(i=>t.fetchSchemaVersion({schema:i})))}async function Me(t,e){let n=e.flatMap(({eventSpecification:{dataProductId:r}})=>r?[r]:[]);return(await Promise.all(n.map(r=>t.fetchDataProduct({dataProductId:r})))).map(r=>r.data[0]&&{...r.data[0],sourceApplications:r.includes.sourceApplications||[]}).filter(ci)}function Ue(t,e){let n=t.reduce((o,r)=>(o[r.id]={...r},o),{});return e.map(o=>{let r=n[o.eventSpecification.dataProductId],a=o.sourceApplicationIds.flatMap(s=>r?.sourceApplications.find(p=>p.id===s)||[]);return{...o,eventSpecification:{...o.eventSpecification,dataProductName:r?.name||""},sourceApplications:a}})}function ci(t){return!!t}async function Le(t,e,n){let i=e.event?.schema?.properties?.type?.enum?.[0];return n.match(pe)?{self:I(n),isEcomTemplateSchema:i}:await t.fetchSchemaVersion({schema:n})}function _e(t){return t.reduce((n,i)=>{let o=i.eventSpecification.id;return i.entities.forEach(({source:r,minCardinality:a,maxCardinality:s})=>{if(typeof a<"u"||typeof s<"u"){let p={minCardinality:a,maxCardinality:s};n[o]=n[o]||{},n[o][r]=p}}),n},{})}function pi(t){return{self:{...I(t)}}}var ui="SNOWPLOW_CONSOLE_API_KEY_ID",li="SNOWPLOW_CONSOLE_API_KEY";function ze(t){return t.length!==0}function $t(t){return JSON.stringify(t,null,2)}function Be(t){let e={organizationId:t.organizationId,tracker:t.tracker,language:t.language,outpath:t.outpath};return Object.assign({igluCentralSchemas:[],dataStructures:[],repositories:[],eventSpecificationIds:[],dataProductIds:[]},e)}function di(t){switch(t){case"typescript":return`${B}${pt}`;case"javascript":return`${B}${ct}`;case"json":return`${B}${ut}`;default:return""}}var Ge=t=>(0,y.existsSync)(t)&&!(0,y.lstatSync)(t).isDirectory(),gi=t=>B+t,mi=t=>({isTS:t.endsWith(pt),isJSON:t.endsWith(ut),isJS:t.endsWith(ct)}),Vt=t=>({configDir:(0,E.dirname)(t),configPath:t,...mi(t)});function C(t){let e=(0,E.isAbsolute)(t)?t:(0,E.resolve)(process.cwd(),t);if(Ge(e))return Vt(e);if(!(0,y.existsSync)(e))throw new Error(`Can't find a root directory while resolving a config file path.
|
|
39
39
|
Provided path to resolve: ${t}
|
|
40
|
-
cwd: ${process.cwd()}`);let[n]=
|
|
41
|
-
`,a=`
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
outpath: string;
|
|
45
|
-
organizationId?: string;
|
|
46
|
-
igluCentralSchemas?: string[];
|
|
47
|
-
repositories?: string[];
|
|
48
|
-
dataStructures?: string[];
|
|
49
|
-
eventSpecificationIds?: string[];
|
|
50
|
-
dataProductIds?: string[];
|
|
51
|
-
options?: {
|
|
52
|
-
commands: {
|
|
53
|
-
generate?: {
|
|
54
|
-
instructions?: boolean;
|
|
55
|
-
validations?: boolean;
|
|
56
|
-
disallowDevSchemas?: boolean;
|
|
57
|
-
deprecateOnlyOnProdAvailableUpdates?: boolean
|
|
58
|
-
}
|
|
59
|
-
update?: {
|
|
60
|
-
regenerateOnUpdate?: boolean;
|
|
61
|
-
maximumBump?: "major" | "minor" | "patch";
|
|
62
|
-
showOnlyProdUpdates?: boolean;
|
|
63
|
-
}
|
|
64
|
-
patch?: {
|
|
65
|
-
regenerateOnPatch?: boolean;
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
`,s=`const config: SnowtypeConfig = ${Wt.default.inspect(t,!1,null)}
|
|
71
|
-
`,p="module.exports = config;",c="export default config;";return n==="json"?(0,y.writeFileSync)(o,Lt(t)):(0,y.writeFileSync)(o,(n==="typescript"?[a,s,c]:[r,p]).join(`
|
|
72
|
-
`))}function Ut(t){let e=(0,y.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function Mt(t){return(0,y.readFileSync)(t,{encoding:"utf-8"})}var li=async t=>(await(0,Nt.require)(t,__filename)).default;async function M(t){let{configPath:e,isJS:n,isJSON:i,isTS:o}=A(t),r;return o?(r=await li(e),T.setFormat("typescript")):n?(r=(await import(e)).default,T.setFormat("javascript")):i&&(r=JSON.parse(Mt(e)),T.setFormat("json")),typeof r=="function"&&(r=await r()),r}function He(t){return JSON.parse(Mt(t))}async function ze(t,e){t.debug("Checking for existing configuration.."),await _t(!0,e),t.success("Valid configuration found")}async function _t(t,e){let{configPath:n,isJS:i,isJSON:o,isTS:r}=A(e),a=o===!0||r===!0||i===!0,s=r===!1&&i===!1&&o===!1,p;if(r?p=(await(0,Nt.require)(n,__filename)).default:i?p=(await import(n)).default:o&&(p=JSON.parse(Mt(n))),typeof p=="function"&&(p=await p()),t){if(s)throw new Q;W(p)}else if(a)try{throw W(p),new z}catch(c){if(c instanceof z)throw c}}function Be(t){return{javascript:".js","javascript-gtm":".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go",dart:".dart"}[t]||""}function Je(t,e){let n={eventSpecifications:{}};t.forEach(o=>{n.eventSpecifications[o.eventSpecification.id]=o.version});let i=(0,E.resolve)(e,dt);try{(0,y.writeFileSync)(i,JSON.stringify(n,null,2))}catch{throw new it}}function Ke(t,e,n){let i=Object.entries(t);i.length>0&&n.success("Available Event Specification Updates"),i.forEach(([o,r])=>{let a=`${o}: version ${r.previous}`,s=`${o}: version ${r.next}`;n.diff(a,s),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}`,a=`${o.next}`;if(n.diff(r,a),o.nextReason==="patch"&&n.warn("The most recent version of this schema has been patched. Possible update required."),o.nextEnv==="DEV"){let s=o.next.split("/").pop();n.warn(`This data structure version (${s}) is not in production.`)}})}function qe(t){let e=t.optsWithGlobals();return{...e,apiKeyId:e.apiKeyId||process.env[si],apiKey:e.apiKey||process.env[ci]}}function _(t){return!!(Array.isArray(t)&&!t.length)}function U(t){return[...new Set(t)]}function Xe(t){let e=U(t);return e.sort(),e}function gi(t){return t.flatMap(e=>{let n=(0,C.joinIgluSchemaUrlParts)(e.eventSchema.self),i=e.entities.map(o=>o.source);return[n,...i]})}async function Ye(t,e,n,i){let o=t.map(s=>(0,C.joinIgluSchemaUrlParts)(s.self)),r=gi(e),a=await $t(n,U([...o,...r]));if(a.length>0&&(console.log(`
|
|
40
|
+
cwd: ${process.cwd()}`);let[n]=re.map(i=>(0,E.resolve)(e,gi(i))).filter(Ge);return Vt(typeof n!="string"?e:n)}function xt(t,e){let n=T.getFormat(),i=di(n),o=(0,E.resolve)(e,i),r=`const config = ${Wt.default.inspect(t,!1,null)}
|
|
41
|
+
`,a='import { SnowtypeConfig } from "@snowplow/snowtype/types";',s=`const config: SnowtypeConfig = ${Wt.default.inspect(t,!1,null)}
|
|
42
|
+
`,p="module.exports = config;",c="export default config;";return n==="json"?(0,y.writeFileSync)(o,$t(t)):(0,y.writeFileSync)(o,(n==="typescript"?[a,s,c]:[r,p]).join(`
|
|
43
|
+
`))}function Mt(t){let e=(0,y.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function Ut(t){return(0,y.readFileSync)(t,{encoding:"utf-8"})}var fi=async t=>(await(0,Nt.require)(t,__filename)).default;async function N(t){let{configPath:e,isJS:n,isJSON:i,isTS:o}=C(t),r;return o?(r=await fi(e),T.setFormat("typescript")):n?(r=(await import(e)).default,T.setFormat("javascript")):i&&(r=JSON.parse(Ut(e)),T.setFormat("json")),typeof r=="function"&&(r=await r()),r}function Je(t){return JSON.parse(Ut(t))}async function Ke(t,e){t.debug("Checking for existing configuration.."),await _t(!0,e),t.success("Valid configuration found")}async function _t(t,e){let{configPath:n,isJS:i,isJSON:o,isTS:r}=C(e),a=o===!0||r===!0||i===!0,s=r===!1&&i===!1&&o===!1,p;if(r?p=(await(0,Nt.require)(n,__filename)).default:i?p=(await import(n)).default:o&&(p=JSON.parse(Ut(n))),typeof p=="function"&&(p=await p()),t){if(s)throw new Q;j(p)}else if(a)try{throw j(p),new z}catch(c){if(c instanceof z)throw c}}function qe(t){return{javascript:".js","javascript-gtm":".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go",dart:".dart",java:".java"}[t]||""}function Xe(t,e){let n={eventSpecifications:{}};t.forEach(o=>{n.eventSpecifications[o.eventSpecification.id]=o.version});let i=(0,E.resolve)(e,lt);try{(0,y.writeFileSync)(i,JSON.stringify(n,null,2))}catch{throw new it}}function Ye(t,e,n){let i=Object.entries(t);i.length>0&&n.success("Available Event Specification Updates"),i.forEach(([o,r])=>{let a=`${o}: version ${r.previous}`,s=`${o}: version ${r.next}`;n.diff(a,s),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}`,a=`${o.next}`;if(n.diff(r,a),o.nextReason==="patch"&&n.warn("The most recent version of this schema has been patched. Possible update required."),o.nextEnv==="DEV"){let s=o.next.split("/").pop();n.warn(`This data structure version (${s}) is not in production.`)}})}function Ze(t){let e=t.optsWithGlobals();return{...e,apiKeyId:e.apiKeyId||process.env[ui],apiKey:e.apiKey||process.env[li]}}function M(t){return!!(Array.isArray(t)&&!t.length)}function W(t){return[...new Set(t)]}function Qe(t){let e=W(t);return e.sort(),e}function hi(t){return t.flatMap(e=>{let n=(0,Et.joinIgluSchemaUrlParts)(e.eventSchema.self),i=e.entities.map(o=>o.source);return[n,...i]})}async function tn(t,e,n,i){let o=t.map(s=>(0,Et.joinIgluSchemaUrlParts)(s.self)),r=hi(e),a=await Rt(n,W([...o,...r]));if(a.length>0&&(console.log(`
|
|
73
44
|
`,wt(`Generating code using schemas in DEV environment, tracking against those will result in failed events. Schemas in DEV:
|
|
74
45
|
`+a.join(`
|
|
75
46
|
`)),`
|
|
76
|
-
`),i))throw new at}function jt(t){return
|
|
47
|
+
`),i))throw new at}function jt(t){return ce.includes(t)}function He({self:t}){let e=(0,Et.joinIgluSchemaUrlParts)(t);return jt(e)}function en(t){return{standardEventSpecs:t.filter(e=>He(e.eventSchema)),customEventSpecs:t.filter(e=>!He(e.eventSchema))}}function nn(t,e,n){if(typeof t=="string"&&typeof e=="string"&&t&&e)return{apiKeyId:t,apiKey:e};throw n.error(new st),new Error}var Si=["javascript","json","typescript"];function on(t){return t in J}function rn(t,e){let n=J[t];return Array.isArray(n)?n.map(o=>o.value).includes(e):!1}function an(t){return Si.includes(t)}function sn(){return{withVerbosity:e=>({success:i=>{console.log(Ae(i))},warn:i=>{console.log(wt(i))},log:i=>{console.log(Oe(i))},diff:(i,o)=>{console.log(De(i,o))},debug:i=>{e===!0&&console.log(be(JSON.stringify(i)))},error:i=>{console.log(Te(i.message)),e===!0&&console.log(i)}})}}function A(t,e){return async(n,i)=>{let o=Ze(i),r=sn(),a=xe(),s=r.withVerbosity(o.verbose),{apiKeyId:p,apiKey:c}=nn(o.apiKeyId,o.apiKey,s);if(e!=="init")try{let l=n.config||process.cwd();await Ke(s,l)}catch(l){cn(l,s,a)}return t({apiKeyId:p,apiKey:c},s,a,n).then(()=>pn(a)).catch(l=>{cn(l,s,a)})}}function cn(t,e,n){throw pn(n),e.error(t),t}function pn(t){t.isSpinning()===!0&&t.stop(!0)}var vi={type:"password",message:"Enter your Snowplow organization ID:",mask:!0,validate:ze},yi={type:"select",message:"Select the Snowplow Tracker to use:",choices:[{value:"google-tag-manager",name:"Google Tag Manager"},{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"},{value:"snowplow-flutter-tracker",name:"Flutter Tracker"},{value:"snowplow-java-tracker",name:"Java Tracker"}]},wi={type:"select",message:"Select the format to use:",choices:[{value:"javascript",name:"JavaScript"},{value:"typescript",name:"TypeScript"},{value:"json",name:"JSON"}]},Ii={type:"input",message:"Enter the directory for Snowtype output:",default:"./snowtype"},Ei=t=>({type:"select",message:"Select the language to use:",choices:t});async function xi(t,e){e.debug("Checking for existing configuration file.."),await _t(!1,process.cwd());let n=t.organizationId||await(0,O.password)(vi),i=t.tracker||await(0,O.select)(yi);if(!on(i))throw new R("tracker",i);let o=J[i],r;if(o.length===1){let p=o[0];if(typeof p>"u")throw new et("Missing language entry.");r=p.value}else r=t.language||await(0,O.select)(Ei(o));if(!rn(i,r))throw new R("language",r);let a=await(0,O.select)(wi);if(!an(a))throw new R("format",a);T.setFormat(a);let s=t.outpath||await(0,O.input)(Ii);return e.debug("Assembling initialization options.."),{organizationId:n,tracker:i,language:r,format:a,outpath:s}}async function Pi(t,e,n,i){let o=await xi(i,e);n.setSpinnerTitle("Initialising..."),n.isSpinning()===!1&&n.start(),e.debug("Creating configuration with options: ".concat(JSON.stringify(o)));let r=Be(o);if(j(r),!await new P({...t,organizationId:r.organizationId}).authenticate())throw new L;e.success("Authentication succeeded"),xt(r,process.cwd()),e.success("Configuration created")}var Gt=A(Pi,"init");var On=require("path");var An=require("@snowplow/snowtype-core");var Pt=require("path"),un=require("mkdirp"),zt=require("fs"),Ct=require("@snowplow/snowtype-core");var Ci="instructions.md",ln="assets";async function dn(t,e,n,i,o){un.mkdirp.sync((0,Pt.resolve)(i,ln));let r=[],a=Ti(e,n,o),s=[];await Promise.all(e.map(async c=>{let l={triggers:await je(t,c.triggers),instructionsHeading:Ht(c.eventSpecification.name)};s.push(Ht(c.eventSpecification.name));let m=ki(c.propertyRules),v=Fi(c.entities);Oi(c.eventSpecification.id,l,i),r.push(Ai({eventStructure:c.eventSchema.self,entitiesStructures:c.entitiesSchemas?.map(d=>d.original.self)||[],name:c.eventSpecification.name,id:c.eventSpecification.id,dataProductId:c.eventSpecification.dataProductId,version:c.version,triggerInstructions:l.triggers,linkToCode:a[c.eventSpecification.id],formattedPropertyRules:m,formattedCardinalityRules:v,organizationId:t.organizationId,sourceApplications:c.sourceApplications}))}));let p=`
|
|
77
48
|
# Implementation instructions
|
|
78
49
|
|
|
79
50
|
_A guide on how to implement tracking for the generated Event Specifications._
|
|
@@ -84,17 +55,17 @@ ${s.map(c=>`- [${c.instructionsTitle}](#${c.instructionsLink})`).join(`
|
|
|
84
55
|
|
|
85
56
|
${r.join(`
|
|
86
57
|
`)}
|
|
87
|
-
`;(0,zt.writeFileSync)((0,
|
|
88
|
-
## [${Ht(n).instructionsTitle}](${
|
|
58
|
+
`;(0,zt.writeFileSync)((0,Pt.resolve)(i,Ci),p,"utf-8")}function Ai({eventStructure:t,entitiesStructures:e,name:n,id:i,dataProductId:o,version:r,triggerInstructions:a,linkToCode:s,formattedPropertyRules:p,formattedCardinalityRules:c,organizationId:l,sourceApplications:m}){let v="_N/A_";return`
|
|
59
|
+
## [${Ht(n).instructionsTitle}](${bi(l,o,i)})
|
|
89
60
|
|
|
90
61
|
| | |
|
|
91
62
|
| ----------- | ----------- |
|
|
92
63
|
| **Id** | ${i} |
|
|
93
64
|
| **Version** | ${r} |
|
|
94
65
|
| **Data Product Id** | ${o} |
|
|
95
|
-
| **Source Application/s** | ${m.length?m.map(
|
|
66
|
+
| **Source Application/s** | ${m.length?m.map(d=>d.name).join(", "):"None selected"} |
|
|
96
67
|
| **Event Data Structure** | ${t.name}/${t.version} |
|
|
97
|
-
| **Entity Data Structures** | ${e.map(
|
|
68
|
+
| **Entity Data Structures** | ${e.map(d=>`${d.name}/${d.version}`).sort().join(", ")} |
|
|
98
69
|
| **Code** | ${s} |
|
|
99
70
|
|
|
100
71
|
${p.length>0?`### Implementation Instructions for ${t.name} event properties
|
|
@@ -102,41 +73,42 @@ ${p.length>0?`### Implementation Instructions for ${t.name} event properties
|
|
|
102
73
|
#### Property Rules
|
|
103
74
|
| Name | Required | Description | Exact value(s) expected |
|
|
104
75
|
| ----------- | ----------- | ----------- | ----------- |
|
|
105
|
-
${p.map(
|
|
76
|
+
${p.map(d=>Object.values(d).join(" | ")).join(`
|
|
106
77
|
`)}
|
|
107
78
|
`:""}
|
|
108
79
|
${c.length>0?`
|
|
109
80
|
#### Entity Cardinality Rules
|
|
110
81
|
| Name | Required | Number of entities |
|
|
111
82
|
| ----------- | ----------- | ----------- |
|
|
112
|
-
${c.map(
|
|
83
|
+
${c.map(d=>Object.values(d).join(" | ")).join(`
|
|
113
84
|
`)}
|
|
114
85
|
`:""}
|
|
115
86
|
|
|
116
|
-
${a.map((
|
|
87
|
+
${a.map((d,w,g)=>`
|
|
117
88
|
### Trigger ${g.length!==1?w+1:""}
|
|
118
89
|
|
|
119
90
|
#### Screenshot
|
|
120
|
-
${
|
|
91
|
+
${d.imageBuffer?`[<img src="./assets/${i}_${w}.${d.imageExtension}" width="550"/>](./assets/${i}_${w}.${d.imageExtension})`:v}
|
|
121
92
|
|
|
122
93
|
#### In which application(s) does this trigger apply?
|
|
123
94
|
|
|
124
|
-
${
|
|
95
|
+
${d.appIds&&d.appIds.length?d.appIds.map(_=>"`"+_+"` "):v}
|
|
125
96
|
|
|
126
97
|
#### The URL of the page on which this event specification triggers:
|
|
127
98
|
|
|
128
|
-
${
|
|
99
|
+
${d.url||v}
|
|
129
100
|
|
|
130
101
|
#### Notes
|
|
131
102
|
|
|
132
|
-
${
|
|
133
|
-
`).join("")}`}function
|
|
103
|
+
${d.description||v}
|
|
104
|
+
`).join("")}`}function Oi(t,e,n){e.triggers.forEach((i,o)=>{i.imageBuffer&&(0,zt.writeFileSync)((0,Pt.resolve)(n,ln,t+"_"+o+"."+i.imageExtension),i.imageBuffer,"binary")})}function bi(t,e,n){return`https://console.snowplowanalytics.com/${t}/data-products/${e}/event-specifications/${n}`}function Ti(t,e,n){let i=t.reduce((o,{eventSpecification:{id:r}})=>(o[r]="",o),{});return Object.keys(i).forEach(o=>{let r=e.findIndex(a=>a.match((0,Ct.createEventSpecificationInstructionsIdentifier)(o)));i[o]=r!==-1?`[Link](./${n+"#L"+r})`:"N/A"}),i}function Ht(t){let e=t;return{instructionsTitle:e,instructionsLink:Di(e)}}function Di(t){return t.toLowerCase().replace(/[^a-z\d\s-]/g," ").replace(/\s+/g," ").trim().replace(/-{2,}|\s/g,"-")}function ki(t){return t?Object.entries(t.properties||{}).map(e=>{let[n,i]=e,o=t.required?.includes(n)?"\u2705":"\u274C",r=i.description||"-",a=i.enum?i.enum.map(s=>`\`${s}\``).join(" or "):"-";return{name:n,isRequired:o,description:r,expectedValues:a}}):[]}function Fi(t){return t?t.map(({source:e,minCardinality:n,maxCardinality:i})=>{let{name:o}=(0,Ct.splitIgluSchemaUrlParts)(e),r=typeof n<"u"&&n>0?"\u2705":"\u274C",a=Ri(n,i);return{name:o,isRequired:r,formattedCardinalityValues:a}}):[]}function Ri(t,e){return typeof t>"u"?"`any`":typeof e<"u"?t===e?`Exactly \`${t}\``:`Between \`${t}\` and \`${e}\``:`At least \`${t}\``}var mn=require("fs"),fn=require("path"),hn=f(require("util"));function Sn(t,e,n,i){let o=e==="typescript"?"ts":"js";(0,mn.writeFileSync)((0,fn.resolve)(t,`validations.${o}`),`${o==="ts"?`
|
|
134
105
|
import { AnySchema } from "ajv";
|
|
135
106
|
export type CardinalityRule = { minCardinality?: number; maxCardinality?: number };
|
|
136
107
|
type IgluUrl = string;
|
|
137
108
|
type EventSpecificationId = string;
|
|
138
109
|
`:""}
|
|
139
|
-
export const entityRules${o==="ts"?": Record<EventSpecificationId, Record<IgluUrl, CardinalityRule>>":""} = ${
|
|
140
|
-
export const schemasObject${o==="ts"?": Record<IgluUrl | EventSpecificationId, AnySchema | Record<IgluUrl, AnySchema>>":""} = ${
|
|
141
|
-
`),
|
|
142
|
-
`),await t.
|
|
110
|
+
export const entityRules${o==="ts"?": Record<EventSpecificationId, Record<IgluUrl, CardinalityRule>>":""} = ${gn(i)}
|
|
111
|
+
export const schemasObject${o==="ts"?": Record<IgluUrl | EventSpecificationId, AnySchema | Record<IgluUrl, AnySchema>>":""} = ${gn(n)}`,"utf-8")}function gn(t){return hn.default.inspect(t,{showHidden:!1,depth:null,maxArrayLength:null})}function Bt(t){return Object.values(t).some(e=>Li(e)?$i(e):Bt(e))}function Li(t){return typeof t=="object"&&t!==null&&Object.hasOwn(t,"$schema")}function $i(t){return t.properties?Object.values(t.properties).some(e=>Object.hasOwn(e||{},"pattern")):!1}function vn(t,e){let n=Vi(t);ji(n,e)}function ji(t,e){Object.entries(t).map(([n,i])=>e.warn(`Event Specification ${n} includes entities that are also present in it's application context: ${i.join(", ")}`))}function Vi(t){let e={};return t.forEach(n=>{let i=n.entities.map(r=>r.source),o=n.sourceApplications.flatMap(r=>[...r.entities.enriched.map(a=>a.source),...r.entities.tracked.map(a=>a.source)]);i.forEach(r=>{o.includes(r)&&(e[n.eventSpecification.id]?e[n.eventSpecification.id]?.push(r):e[n.eventSpecification.id]=[r])})}),e}var At=f(require("fs/promises")),Ot=f(require("path")),yn=require("yaml");async function wn(t,e=[]){let n=[];for(let i of e){let o=Ot.default.resolve(t,i),r=await In(o),a=await Wi(r);n.push(...a)}return n}async function Wi(t){let e=[];for(let n of t){let{isJson:i}=En(n),o=await At.default.readFile(n,{encoding:"utf-8"}),r=i?JSON.parse(o):(0,yn.parse)(o);Ni(r)&&e.push(r.data)}return e}async function In(t,e=[]){let n=await At.default.readdir(t);for(let i of n){let o=Ot.default.join(t,i),r=await At.default.stat(o),{isJson:a,isYaml:s}=En(i);r.isDirectory()?e=await In(o,e):(a||s)&&e.push(o)}return e}function Ni(t){return typeof t=="object"&&t!==null&&"apiVersion"in t&&typeof t.apiVersion=="string"&&"resourceType"in t&&t.resourceType==="data-structure"}function En(t){let e=Ot.default.extname(t);return e.match(/\.yml|\.yaml/)?{isYaml:!0,isJson:!1}:e.match(".json")?{isYaml:!1,isJson:!0}:{isYaml:!1,isJson:!1}}var U=require("path"),Jt=require("fs"),Kt=require("mkdirp"),xn=f(require("fs-extra"));function Pn({codeLines:t,outFilePath:e,language:n}){if(n==="java"){let i="// SNOWTYPE START: ",o="// SNOWTYPE END: ",r=(0,U.resolve)((0,U.dirname)(e),"com","snowplowanalytics","snowplow","snowtype");Kt.mkdirp.sync(r);let a="",s=!1,p="";for(let c of t)c===o+a&&((0,Jt.writeFileSync)((0,U.resolve)(r,a),p),p="",s=!1),s&&(p+=c+`
|
|
112
|
+
`),c.startsWith(i)&&(a=c.slice(i.length),s=!0)}else{let i=t.join(`
|
|
113
|
+
`);(0,Jt.writeFileSync)(e,i)}}function Cn(t){xn.default.removeSync((0,U.resolve)(t)),Kt.mkdirp.sync(t)}var qt=require("path");async function Mi(t){let{config:e,...n}=t,i=await N(e||process.cwd());return $(i),i.options.commands.generate={...i.options.commands.generate,...n},i}async function X(t,e,n,i){let{dataProductIds:o,dataStructures:r,igluCentralSchemas:a,eventSpecificationIds:s,repositories:p,language:c,tracker:l,outpath:m,organizationId:v,options:{commands:{generate:d}}}=await Mi(i),{configDir:w}=C(i.config||process.cwd());n.setSpinnerTitle("Generating..."),n.isSpinning()===!1&&n.start(),M(r)&&M(a)&&M(s)&&M(o)&&M(p)&&e.warn("Data Structures, Schemas and Event Specifications are empty.");let g=new P({...t,organizationId:v});if(!await g.authenticate())throw new L;let x=await It(g,o),G=Qe([...x,...s]),{eventSpecificationsWithId:k}=await Ve(g,G,e),Tt=ke(k);d.deprecateOnlyOnProdAvailableUpdates&&(Tt=await Re(Tt,g));let Dn=await Me(g,k),Y=Ue(Dn,k);vn(Y,e);let{customEventSpecs:kn,standardEventSpecs:Fn}=en(Y),Rn=Fn.flatMap(Dt=>Dt.entities.map(Wn=>Wn.source));me(k)&&l==="@snowplow/browser-tracker"&&e.log("You are generating Snowplow Ecommerce events. You would need to install `@snowplow/browser-plugin-snowplow-ecommerce`."),d.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 Ln=await We(a),Qt=await Ne(g,[...r,...Rn]),$n=await wn(w,p),te=!!(l==="@snowplow/browser-tracker"&&c.match(/javascript|typescript/));await tn(Qt,Y,g,d.disallowDevSchemas);let jn={language:c,tracker:l,schemas:[...$n,...Ln,...Qt],eventSpecifications:kn,validations:te&&d.validations,eventSpecificationsInputMetadata:Tt},F=await(0,An.generate)(jn);if(n.stop(!0),!F)throw new Z;e.success("Code generated, writing...");let H=(0,qt.resolve)(w,m),ee=ae+qe(c),Vn=(0,qt.resolve)(H,ee);if(Cn(H),Pn({codeLines:F.lines,outFilePath:Vn,language:c}),Xe(k,H),te&&d.validations&&F.validationsSchemaObject){let Dt=_e(k);Sn(H,c,F.validationsSchemaObject,Dt),Bt(F.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")}d.instructions&&await dn(g,Y,F.lines,H,ee)}var Xt=A(X,"generate");async function Ui(t){let e=await N(t||process.cwd());return $(e),e}async function _i(t,e,n,i){let o=await Ui(i.config),{options:{commands:{update:{maximumBump:r,regenerateOnUpdate:a,showOnlyProdUpdates:s},generate:p}}}=o;e.debug("Starting update process with options: ".concat(JSON.stringify(i)));let{configDir:c}=C(i.config||process.cwd()),l=(0,On.resolve)(c,o.outpath,lt),m=new P({...t,organizationId:o.organizationId});n.setSpinnerTitle("Checking for updates..."),n.isSpinning()===!1&&n.start();let v=await It(m,o.dataProductIds),d=W([...o.eventSpecificationIds,...v]),w={};if(!Mt(l)&&d.length>0)throw new ot;if(Mt(l)&&d.length>0){let x=Je(l);w=await we(m,d,x)}let g=await ye(m,o.dataStructures,i.maximumBump||r,s);if((Object.entries(w).length>0||g.length>0)===!0){if(e.success("Available updates found!"),Ye(w,g,e),i.yes||a)return g.length>0&&(g.forEach(x=>{let G=o.dataStructures.indexOf(x.previous);o.dataStructures[G]=x.next}),xt(o,i.config||process.cwd())),e.debug("Applying the updates.."),X(t,e,n,{...p,...i.config&&{config:i.config}});e.log("No updates applied"),e.log("To apply the available updates automatically run `update` with the --yes flag"),e.log("(caution: will ovewrite the configuration file)")}else e.success("No updates found. Everything is up-to-date!");return Promise.resolve(void 0)}var Yt=A(_i,"update");async function Gi(t){let{config:e,...n}=t;if(Object.values(n).every(o=>Array.isArray(o)&&o.length===0))throw new nt;let i=await N(e||process.cwd());return $(i),{patchOptions:n,generateOptions:i.options.commands.generate,regenerateOnPatch:i.options.commands.patch.regenerateOnPatch}}async function Hi(t,e,n,i){let{isJSON:o,configPath:r}=C(i.config||process.cwd());if(o===!1)throw new rt;let{patchOptions:a,generateOptions:s,regenerateOnPatch:p}=await Gi(i);return e.debug("Starting patch process with options: ".concat(JSON.stringify(a))),Object.entries(a).forEach(([l,m])=>{m.forEach(v=>{ve(l,v,r)})}),e.success("Configuration patched"),p?X(t,e,n,s):(e.log("Code is not generated yet for the patched configuration"),Promise.resolve(void 0))}var Zt=A(Hi,"patch");var bt=require("@snowplow/snowtype-core");async function Tn(){await import("dotenv/config");let t=new b.Command;t.exitOverride(),t.version(V,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("-s, --apiKeyId <string>","Snowplow Console API key ID").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").addOption(new b.Option("-t, --tracker <availableTrackers>","tracker to use").choices(bt.trackerTemplates)).addOption(new b.Option("-l, --language <availableLanguages>","language to use").choices(bt.languageIds)).option("-o, --outpath <string>","output path").action(Gt),t.command("update").description("Checks for latest version updates in Data Structures and Event Specifications.").option("-c, --config <string>","config file path").option("-y, --yes","updates all to latest without asking (caution: will ovewrite the configuration file)").addOption(new b.Option("-m, --maximumBump <'patch' | 'minor' | 'major'>","the maximum SchemaVer update to show an available update notification. Defaults to 'major'").choices(["patch","minor","major"])).action(Yt),t.command("generate").option("-c, --config <string>","config file path").option("--instructions","generate event specification instructions").option("--no-instructions","generate without instructions").option("--validations","add runtime validation using Ajv").option("--no-validations","generate without runtime validations").option("--disallowDevSchemas","disallow generation of code using schemas only deployed on DEV environment").option("--deprecateOnlyOnProdAvailableUpdates","show deprecation warnings only when there are PROD available schema updates").description("Generates tracking code based on configuration on the `snowtype.config.json` file.").action(Xt),t.command("patch").option("-c, --config <string>","config file path").description("Adds new Data Structures and Event Specifications in the `snowtype.config.json` file.").option("-p, --dataProductIds <dataProductIds...>","data product ID").option("-e, --eventSpecificationIds <eventSpecificationIds...>","tracking eventSpecification ID").option("-d, --dataStructures <dataStructures...>","data structure URI").option("-i, --igluCentralSchemas <igluCentralSchemas...>","iglu central URI").option("-r, --repositories <repositories...>","repository path").action(Zt),t.addHelpText("before",Ce()).addHelpText("after",`
|
|
114
|
+
`),await t.parseAsync(bn.argv).catch(e=>{zi(e)})}function zi(t){if(!(t instanceof b.CommanderError&&["commander.help","commander.version","commander.helpDisplayed"].indexOf(t.code)>-1))throw t}Tn().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.11.0",
|
|
4
4
|
"description": "A code generator CLI for faster and type-safe Snowplow tracking code",
|
|
5
5
|
"author": "Peter Perlepes <peter@snowplowanalytics.com>",
|
|
6
6
|
"homepage": "https://snowplow.io/",
|
|
@@ -8,12 +8,13 @@
|
|
|
8
8
|
"main": "dist/index.js",
|
|
9
9
|
"files": [
|
|
10
10
|
"dist",
|
|
11
|
-
"bin"
|
|
11
|
+
"bin",
|
|
12
|
+
"types.d.ts"
|
|
12
13
|
],
|
|
13
14
|
"dependencies": {
|
|
14
15
|
"@commander-js/extra-typings": "^11.1.0",
|
|
15
16
|
"@inquirer/prompts": "^3.3.0",
|
|
16
|
-
"@snowplow/snowtype-core": "^0.
|
|
17
|
+
"@snowplow/snowtype-core": "^0.11.0",
|
|
17
18
|
"chalk": "^4.1.2",
|
|
18
19
|
"cli-spinner": "^0.2.10",
|
|
19
20
|
"dotenv": "^16.3.1",
|
|
@@ -42,19 +43,21 @@
|
|
|
42
43
|
"jest": "^29.7.0",
|
|
43
44
|
"rimraf": "^5.0.5",
|
|
44
45
|
"ts-jest": "^29.1.1",
|
|
46
|
+
"ts-morph": "^24.0.0",
|
|
45
47
|
"ts-node": "^10.9.2",
|
|
46
48
|
"tslib": "^2.4",
|
|
47
49
|
"typescript": "5.2.2"
|
|
48
50
|
},
|
|
49
51
|
"scripts": {
|
|
50
52
|
"snowtype": "ts-node src/index.ts",
|
|
53
|
+
"build:types": "ts-node-transpile-only ./scripts/extract-snowtype-types.ts && eslint types.d.ts",
|
|
51
54
|
"build:production": "esbuild --bundle --packages=external --platform=node --target=es2022 --outdir=dist --minify src/index.ts",
|
|
52
55
|
"build": "tsc",
|
|
53
56
|
"fix-version": "node ./scripts/version.js",
|
|
54
57
|
"lint:fix": "eslint src --fix",
|
|
55
58
|
"lint": "eslint src",
|
|
56
|
-
"prebuild:production": "npm run fix-version && rimraf ./dist",
|
|
57
|
-
"prebuild": "npm run fix-version",
|
|
59
|
+
"prebuild:production": "npm run fix-version && npm run build:types && rimraf ./dist",
|
|
60
|
+
"prebuild": "npm run fix-version && npm run build:types",
|
|
58
61
|
"test": "jest --testPathIgnorePatterns e2e/",
|
|
59
62
|
"test:e2e": "npm run build:production && jest e2e/"
|
|
60
63
|
},
|
package/types.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export type SnowTypeConfig = {
|
|
2
|
+
tracker: "@snowplow/browser-tracker" | "@snowplow/javascript-tracker" | "snowplow-android-tracker" | "snowplow-ios-tracker" | "@snowplow/node-tracker" | "snowplow-golang-tracker" | "@snowplow/react-native-tracker" | "google-tag-manager" | "snowplow-flutter-tracker" | "snowplow-java-tracker"
|
|
3
|
+
language: "typescript" | "javascript" | "javascript-gtm" | "kotlin" | "swift" | "go" | "dart" | "java"
|
|
4
|
+
outpath: string
|
|
5
|
+
organizationId?: string
|
|
6
|
+
igluCentralSchemas?: string[]
|
|
7
|
+
repositories?: string[]
|
|
8
|
+
dataStructures?: string[]
|
|
9
|
+
eventSpecificationIds?: string[]
|
|
10
|
+
dataProductIds?: string[]
|
|
11
|
+
}
|