@snowplow/snowtype 0.9.0 → 0.10.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 +46 -44
- package/package.json +2 -2
package/dist/index.js
CHANGED
|
@@ -1,46 +1,46 @@
|
|
|
1
|
-
"use strict";var
|
|
2
|
-
`);super(
|
|
3
|
-
${
|
|
1
|
+
"use strict";var $n=Object.create;var Yt=Object.defineProperty;var Ln=Object.getOwnPropertyDescriptor;var Fn=Object.getOwnPropertyNames;var Rn=Object.getPrototypeOf,jn=Object.prototype.hasOwnProperty;var Un=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of Fn(e))!jn.call(t,o)&&o!==n&&Yt(t,o,{get:()=>e[o],enumerable:!(i=Ln(e,o))||i.enumerable});return t};var S=(t,e,n)=>(n=t!=null?$n(Rn(t)):{},Un(e||!t||!t.__esModule?Yt(n,"default",{value:t,enumerable:!0}):n,t));var En=S(require("process")),O=require("@commander-js/extra-typings");var A=require("@inquirer/prompts");var Vn={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"},Wn="Please report a bug.",f=class extends Error{code;constructor(e,n=""){let i=Vn[e].concat(n);super(i),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=e}},X=class extends f{constructor(){super("GenerationFailed")}},_=class extends f{constructor(){super("ConfigAlreadyExists")}},Y=class extends f{constructor(){super("ConfigNotExists")}},Z=class extends f{constructor(e){super("ConfigInvalid",e)}},Q=class extends f{constructor(e){super("InternalError",e.concat(Wn))}},L=class extends f{constructor(e,n){let i=`Value ${n} is an invalid ${e}.`;super("InvalidOption",i)}},tt=class extends f{constructor(){super("MissingOptions")}},F=class extends f{constructor(){super("AuthError")}},et=class extends f{constructor(){super("WriteLockFile")}},nt=class extends f{constructor(){super("MissingLockFile")}},it=class extends f{constructor(){super("PatchingNotSupported")}},ot=class extends f{constructor(){super("DevNotAllowed")}},rt=class extends f{constructor(){super("AuthCredentialsMissing")}};var Zt=S(require("got"));async function Qt({schema:t}){return(await(0,Zt.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${t.replace("iglu:","")}`)).body}var gt=S(require("got"));var se=require("js-sha256"),Tt=S(require("assert"));var u=S(require("joi")),ut=require("@snowplow/snowtype-core");var bt=S(require("assert"));var G="snowtype.config",at=".js",st=".ts",ct=".json",te=Object.freeze([at,st,ct]),pt=".snowtype-lock.json",ee="snowplow";var H={"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"}]},ne={commands:{generate:{instructions:!1,validations:!1,disallowDevSchemas:!1,deprecateOnlyOnProdAvailableUpdates:!1},update:{maximumBump:"major",regenerateOnUpdate:!1,showOnlyProdUpdates:!1},patch:{regenerateOnPatch:!1}}},ie=["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"],oe="iglu:com.snowplowanalytics.snowplow.ecommerce";var dt=require("lodash");function ae(t){let e=t.split("-");(0,bt.default)(e.length===3,"invalid SchemaVer"),(0,bt.default)(e.filter(n=>isNaN(parseInt(n))).length===0,"invalid SchemaVer")}function R(t){t.options=(0,dt.merge)((0,dt.cloneDeep)(ne),t.options||{})}var re=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(...ut.trackerTemplates),language:u.default.string().required().valid(...ut.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(re)),dataStructures:u.default.array().optional().items(u.default.string().regex(re)),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=Nn.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new Z(e.error.annotate());return t};function Mn(t){let e=se.sha256.create();return e.update(t),e.hex()}function lt(t,e){let{vendor:n,name:i,format:o}=E(t);return Mn(`${e}-${n}-${i}-${o}`)}function E(t){let e=t.replace("iglu:",""),[n,i,o,r]=e.split("/");return(0,Tt.default)(typeof n=="string"&&typeof i=="string"&&typeof o=="string"&&typeof r=="string",`invalid iglu uri ${t}`),ae(r),{vendor:n,name:i,format:o,version:r}}function ce(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 pe(t){return t.some(e=>e.eventSchema.isEcomTemplateSchema)}function z(t){let[e,n,i]=t.split("-").map(o=>parseInt(o));return{model:e,revision:n,addition:i}}function ue(t,e,n=0){if(t===e&&n!==0)return"patch";let{model:i,revision:o,addition:r}=z(t),{model:a,revision:s,addition:p}=z(e);if(i!==a)return"major";if(o!==s)return"minor";if(r!==p)return"patch";(0,Tt.default)(!1,"SchemaVer checking went wrong")}var mt=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 de(t){return!!Object.hasOwn(t||{},"response")}var U="0.10.1";var x=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,gt.default)(e,{headers:{"X-API-Key-Id":this.apiKeyId,"X-API-Key":this.apiKey,"X-Snowtype":U}}).json();return this.accessToken=n,n}async fetchResource(e){let n=await this.fetchAccessToken();try{return await(0,gt.default)(e,{headers:{Authorization:"Bearer "+n,"X-Snowtype":U}}).json()}catch(i){throw de(i)?new mt(i):i}}fetchSchemaVersion({schema:e,env:n="DEV"}){let{version:i}=E(e),o=lt(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=lt(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=lt(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,gt.default)(i,{headers:{Authorization:"Bearer "+o,"X-Snowtype":U}})}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 wt=require("process"),k=require("path"),v=require("fs");var jt=S(require("util")),Ut=require("tsx/cjs/api");var T=(()=>{let t="json";return{setFormat:i=>t=i,getFormat:()=>t}})();var P=require("@snowplow/snowtype-core");var ht=require("fs"),Dt=require("path");var ft=S(require("assert"));var le=require("semver"),me="snowtype.config.json";function _n(t){(0,ht.writeFileSync)((0,Dt.resolve)(process.cwd(),`./${me}`),Lt(t))}function ge(t,e){try{let n=(0,ht.readFileSync)((0,Dt.resolve)(process.cwd(),`./${me}`),{encoding:"utf-8"}),i=JSON.parse(n);return i[t].some(r=>r===e)||i[t].push(e),_n(i),!0}catch(n){return console.error(n),!1}}var Gn=(t,e)=>{let{model:n,revision:i,addition:o}=z(t.version),{model:r,revision:a,addition:s}=z(e.version);return(0,ft.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 fe(t,e,n,i){return(await Promise.all(e.map(async r=>{let{version:a}=E(r),s=await t.fetchDeployments({schema:r,...i&&{deploymentEnv:"PROD"}}),p=Hn(s,a,n);p.sort(Gn);let c=p.pop();if(!c)return null;let l={previous:r,next:ce(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 kt(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 he(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,ft.default)(!!s,`failed to fetch event spec ${r}`),(0,ft.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 kt(t,p);return(s.version||0)>a&&(o[r]={previous:a,next:s.version,devOnlySchema:c}),r})),o}function Hn(t,e,n){return t.filter(i=>$t(e,i.version)!==1).filter(i=>i.version!==e||i.patchLevel).map(i=>({...i,updateType:ue(i.version,e,i.patchLevel)})).filter(zn(n))}function zn(t){return({updateType:e})=>{switch(t){case"major":return!0;case"minor":return e==="patch"||e==="minor";case"patch":return e==="patch"}}}function $t(t,e){let n=t.replaceAll("-","."),i=e.replaceAll("-",".");return(0,le.compare)(n,i)}var ve=require("cli-spinner"),h=S(require("chalk"));function ye(){let t=new ve.Spinner;return t.setSpinnerString(18),t}var Bn="https://snowplow.io",Jn="https://docs.snowplow.io/docs/collecting-data/code-generation/",B={SUCCESS:"\u2714",LOG:"\u2139",DEBUG:"\u27A4",ERROR:"\u2717",WARN:"\u26A0"},we={LINK:"#9911BB",OPTION:"#9911DD"};function Se(t){return h.default.hex(we.LINK).bold(t)}function D(t){return h.default.hex(we.OPTION).italic(t)}function St(t,e){switch(t){case"h1":return h.default.bold.underline(e);default:return h.default.bold(e)}}function Ie(){return`
|
|
3
|
+
${St("h1","CLI Help")}
|
|
4
4
|
|
|
5
|
-
For more information visit the Snowplow website ${
|
|
5
|
+
For more information visit the Snowplow website ${Se(Bn)}
|
|
6
6
|
|
|
7
|
-
For details see the CLI documentation ${
|
|
7
|
+
For details see the CLI documentation ${Se(Jn)}
|
|
8
8
|
|
|
9
|
-
${
|
|
9
|
+
${St("h2","How to get started")}
|
|
10
10
|
1. Use ${h.default.cyanBright("snowtype init")} to initialize the setup.
|
|
11
11
|
2. Use ${h.default.cyanBright("snowtype patch")} to add a Data Structure or Event Specification.
|
|
12
12
|
3. Use ${h.default.cyanBright("snowtype generate")} to generate tracking code.
|
|
13
13
|
|
|
14
|
-
${
|
|
15
|
-
To learn more about each CLI command, use the ${
|
|
14
|
+
${St("h2","Available commands")}
|
|
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
|
-
${
|
|
30
|
-
Use the ${
|
|
31
|
-
`}function
|
|
29
|
+
${St("h2","Debug")}
|
|
30
|
+
Use the ${D("-v")} to output verbose logs
|
|
31
|
+
`}function Ee(t){let e=`${B.SUCCESS}: `;return h.default.cyanBright(e)+t}function vt(t){let e=`${B.WARN} Warning: `;return h.default.hex("#FFA500")(e)+t}function xe(t){let e=`${B.LOG} ${t}`;return h.default.yellowBright(e)}function Pe(t){let e=`${B.DEBUG} Debug: `;return h.default.magenta(e)+t}function Ce(t){let e=`${B.ERROR} Error: `;return h.default.redBright(e)+t}function Ae(t,e){let n=`- ${t}`,i=`+ ${e}`;return`
|
|
32
32
|
${h.default.magenta(n)}
|
|
33
33
|
${h.default.cyanBright(i)}
|
|
34
|
-
`}var ke=S(require("mime-types"));var
|
|
34
|
+
`}var ke=S(require("mime-types"));var Oe=t=>{let e={outdatedDsWarnings:[],hiddenDsWarnings:[],metrics:[]};return t.reduce((n,i)=>Kn({currentMetadata:n,eventSpecificationId:i.eventSpecification.id,newMetadata:i.metadata||e}),{})};function Kn({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 be=t=>(e,n)=>{qn(e,n||"").forEach(t.warn)};function qn(t,e){let n=Xn(t.outdatedDsWarnings,e),i=Yn(t.hiddenDsWarnings,e);return n.concat(i)}function Xn(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 Yn(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
|
-
`)}`]},[])}
|
|
38
|
+
`)}`]},[])}async function Te(t,e){let n=Qn(t),i=await Promise.all(n.map(async r=>({schema:r,deployments:await e.fetchDeployments({schema:r,deploymentEnv:"PROD"})}))),o=Zn(i);return ti(t,o)}var Zn=t=>t.flatMap(({schema:e,deployments:n})=>{let{version:i}=E(e);return n.filter(r=>$t(i,r.version)===-1).length===0?[]:[e]}),Qn=t=>V(Object.entries(t).filter(([,e])=>e.outdatedDsWarnings.length!==0).flatMap(([,e])=>e.outdatedDsWarnings.flatMap(n=>n.sources.map(i=>i.source)))),ti=(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 yt(t,e){return(await Promise.all(e.map(i=>t.fetchDataProduct({dataProductId:i})))).flatMap(({data:[i]})=>i?i.eventSpecs:[]).map(i=>i.id)}function ei(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:o,appIds:r,url:a,variantUrls:s}=i,p={description:o,appIds:r,url:a};if(s){let{imageVariant:c,imageId:l}=ei(s),g=await t.fetchImageVariant({imageId:l,imageVariant:c});p.imageBuffer=g.rawBody,p.imageExtension=ke.default.extension(g.headers["content-type"])||""}n.push(p)}return n}async function Le(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&&be(n)(r.metadata,a.dataProductId);let p=Ft(a.event.source);p&&n.warn("Currently code will not be generated for `Standard` events. Skipping...");let c=a.triggers,l=a.name,g=a.version,m=a.sourceApplications||[],d=a.event.schema,y=p?ii(a.event.source):await De(t,a,a.event.source),b=a.entities?.tracked||[],w=await Promise.all(b.map(async({source:I,schema:N})=>({original:await De(t,a,I),propertyRule:N})));return{eventSpecification:{name:l||"",id:o,dataProductId:a.dataProductId||"",dataProductName:""},version:g||0,eventSchema:y,entitiesSchemas:w,entities:b,triggers:c,propertyRules:d,sourceApplicationIds:m,metadata:r.metadata}}))).flat()}}async function Fe(t){return await Promise.all(t.map(async n=>JSON.parse(await Qt({schema:n}))))}async function Re(t,e){return await Promise.all(e.map(i=>t.fetchSchemaVersion({schema:i})))}async function je(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(ni)}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 ni(t){return!!t}async function De(t,e,n){let i=e.event?.schema?.properties?.type?.enum?.[0];return n.match(oe)?{self:E(n),isEcomTemplateSchema:i}:await t.fetchSchemaVersion({schema:n})}function Ve(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 ii(t){return{self:{...E(t)}}}var oi="SNOWPLOW_CONSOLE_API_KEY_ID",ri="SNOWPLOW_CONSOLE_API_KEY";function Me(t){return t.length!==0}function Lt(t){return JSON.stringify(t,null,2)}function _e(t){let e={organizationId:t.organizationId,tracker:t.tracker,language:t.language,outpath:t.outpath};return Object.assign({igluCentralSchemas:[],dataStructures:[],eventSpecificationIds:[],dataProductIds:[]},e)}function ai(t){switch(t){case"typescript":return`${G}${st}`;case"javascript":return`${G}${at}`;case"json":return`${G}${ct}`;default:return""}}var We=t=>(0,v.existsSync)(t)&&!(0,v.lstatSync)(t).isDirectory(),si=t=>G+t,ci=t=>({isTS:t.endsWith(st),isJSON:t.endsWith(ct),isJS:t.endsWith(at)}),Rt=t=>({configPath:t,...ci(t)});function It(t){let e=(0,k.isAbsolute)(t)?t:(0,k.resolve)(process.cwd(),t);if(We(e))return Rt(e);if(!(0,v.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]=
|
|
40
|
+
cwd: ${process.cwd()}`);let[n]=te.map(i=>(0,k.resolve)(e,si(i))).filter(We);return Rt(typeof n!="string"?e:n)}function Et(t){let e=T.getFormat(),n=ai(e),i=(0,k.resolve)((0,wt.cwd)(),n),o=`const config = ${jt.default.inspect(t,!1,null)}
|
|
41
41
|
`,r=`type SnowtypeConfig = {
|
|
42
|
-
tracker: "${
|
|
43
|
-
language: "${
|
|
42
|
+
tracker: "${P.trackerTemplates.join('" | "')}";
|
|
43
|
+
language: "${P.languageIds.join('" | "')}";
|
|
44
44
|
outpath: string;
|
|
45
45
|
organizationId?: string;
|
|
46
46
|
igluCentralSchemas?: string[];
|
|
@@ -53,6 +53,7 @@ cwd: ${process.cwd()}`);let[n]=Qt.map(i=>(0,b.resolve)(e,ii(i))).filter(Ne);retu
|
|
|
53
53
|
instructions?: boolean;
|
|
54
54
|
validations?: boolean;
|
|
55
55
|
disallowDevSchemas?: boolean;
|
|
56
|
+
deprecateOnlyOnProdAvailableUpdates?: boolean
|
|
56
57
|
}
|
|
57
58
|
update?: {
|
|
58
59
|
regenerateOnUpdate?: boolean;
|
|
@@ -65,35 +66,35 @@ cwd: ${process.cwd()}`);let[n]=Qt.map(i=>(0,b.resolve)(e,ii(i))).filter(Ne);retu
|
|
|
65
66
|
}
|
|
66
67
|
}
|
|
67
68
|
}
|
|
68
|
-
`,
|
|
69
|
-
`,
|
|
70
|
-
`))}function Vt(t){let e=(0,v.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function
|
|
71
|
-
`,
|
|
72
|
-
`+
|
|
69
|
+
`,a=`const config: SnowtypeConfig = ${jt.default.inspect(t,!1,null)}
|
|
70
|
+
`,s="module.exports = config;",p="export default config;";return e==="json"?(0,v.writeFileSync)(i,Lt(t)):(0,v.writeFileSync)(i,(e==="typescript"?[r,a,p]:[o,s]).join(`
|
|
71
|
+
`))}function Vt(t){let e=(0,v.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function Wt(t){return(0,v.readFileSync)(t,{encoding:"utf-8"})}var pi=async t=>(await(0,Ut.require)(t,__filename)).default;async function W(){let{configPath:t,isJS:e,isJSON:n,isTS:i}=It((0,wt.cwd)()),o;return i?(o=await pi(t),T.setFormat("typescript")):e?(o=(await import(t)).default,T.setFormat("javascript")):n&&(o=JSON.parse(Wt(t)),T.setFormat("json")),typeof o=="function"&&(o=await o()),o}function Ge(t){return JSON.parse(Wt(t))}async function He(t){t.debug("Checking for existing configuration.."),await Nt(!0),t.success("Valid configuration found")}async function Nt(t){let{configPath:e,isJS:n,isJSON:i,isTS:o}=It(process.cwd()),r=i===!0||o===!0||n===!0,a=o===!1&&n===!1&&i===!1,s;if(o?s=(await(0,Ut.require)(e,__filename)).default:n?s=(await import(e)).default:i&&(s=JSON.parse(Wt(e))),typeof s=="function"&&(s=await s()),t){if(a)throw new Y;j(s)}else if(r)try{throw j(s),new _}catch(p){if(p instanceof _)throw p}}function ze(t){return{javascript:".js","javascript-gtm":".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go"}[t]||""}function Be(t,e){let n={eventSpecifications:{}};t.forEach(o=>{n.eventSpecifications[o.eventSpecification.id]=o.version});let i=(0,k.resolve)((0,wt.cwd)(),e,pt);try{(0,v.writeFileSync)(i,JSON.stringify(n,null,2))}catch{throw new et}}function Je(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 Ke(t){let e=t.optsWithGlobals();return{...e,apiKeyId:e.apiKeyId||process.env[oi],apiKey:e.apiKey||process.env[ri]}}function J(t){return!!(Array.isArray(t)&&!t.length)}function V(t){return[...new Set(t)]}function qe(t){let e=V(t);return e.sort(),e}function ui(t){return t.flatMap(e=>{let n=(0,P.joinIgluSchemaUrlParts)(e.eventSchema.self),i=e.entities.map(o=>o.source);return[n,...i]})}async function Xe(t,e,n,i){let o=t.map(s=>(0,P.joinIgluSchemaUrlParts)(s.self)),r=ui(e),a=await kt(n,V([...o,...r]));if(a.length>0&&(console.log(`
|
|
72
|
+
`,vt(`Generating code using schemas in DEV environment, tracking against those will result in failed events. Schemas in DEV:
|
|
73
|
+
`+a.join(`
|
|
73
74
|
`)),`
|
|
74
|
-
`),i))throw new
|
|
75
|
+
`),i))throw new ot}function Ft(t){return ie.includes(t)}function Ne({self:t}){let e=(0,P.joinIgluSchemaUrlParts)(t);return Ft(e)}function Ye(t){return{standardEventSpecs:t.filter(e=>Ne(e.eventSchema)),customEventSpecs:t.filter(e=>!Ne(e.eventSchema))}}function Ze(t,e,n){if(typeof t=="string"&&typeof e=="string"&&t&&e)return{apiKeyId:t,apiKey:e};throw n.error(new rt),new Error}var di=["javascript","json","typescript"];function Qe(t){return t in H}function tn(t,e){let n=H[t];return Array.isArray(n)?n.map(o=>o.value).includes(e):!1}function en(t){return di.includes(t)}function nn(){return{withVerbosity:e=>({success:i=>{console.log(Ee(i))},warn:i=>{console.log(vt(i))},log:i=>{console.log(xe(i))},diff:(i,o)=>{console.log(Ae(i,o))},debug:i=>{e===!0&&console.log(Pe(JSON.stringify(i)))},error:i=>{console.log(Ce(i.message)),e===!0&&console.log(i)}})}}function C(t,e){return async(n,i)=>{let o=Ke(i),r=nn(),a=ye(),s=r.withVerbosity(o.verbose),{apiKeyId:p,apiKey:c}=Ze(o.apiKeyId,o.apiKey,s);if(e!=="init")try{await He(s)}catch(l){on(l,s,a)}return t({apiKeyId:p,apiKey:c},s,a,n).then(()=>rn(a)).catch(l=>{on(l,s,a)})}}function on(t,e,n){throw rn(n),e.error(t),t}function rn(t){t.isSpinning()===!0&&t.stop(!0)}var li={type:"password",message:"Enter your Snowplow organization ID:",mask:!0,validate:Me},mi={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"}]},gi={type:"select",message:"Select the format to use:",choices:[{value:"javascript",name:"JavaScript"},{value:"typescript",name:"TypeScript"},{value:"json",name:"JSON"}]},fi={type:"input",message:"Enter the directory for Snowtype output:",default:"./snowtype"},hi=t=>({type:"select",message:"Select the language to use:",choices:t});async function Si(t,e){e.debug("Checking for existing configuration file.."),await Nt(!1);let n=t.organizationId||await(0,A.password)(li),i=t.tracker||await(0,A.select)(mi);if(!Qe(i))throw new L("tracker",i);let o=H[i],r;if(o.length===1){let p=o[0];if(typeof p>"u")throw new Q("Missing language entry.");r=p.value}else r=t.language||await(0,A.select)(hi(o));if(!tn(i,r))throw new L("language",r);let a=await(0,A.select)(gi);if(!en(a))throw new L("format",a);T.setFormat(a);let s=t.outpath||await(0,A.input)(fi);return e.debug("Assembling initialization options.."),{organizationId:n,tracker:i,language:r,format:a,outpath:s}}async function vi(t,e,n,i){let o=await Si(i,e);n.setSpinnerTitle("Initialising..."),n.isSpinning()===!1&&n.start(),e.debug("Creating configuration with options: ".concat(JSON.stringify(o)));let r=_e(o);if(j(r),!await new x({...t,organizationId:r.organizationId}).authenticate())throw new F;e.success("Authentication succeeded"),Et(r),e.success("Configuration created")}var Mt=C(vi,"init");var wn=require("process"),In=require("path");var fn=require("process"),Ct=require("path"),hn=require("fs"),Sn=require("mkdirp"),vn=require("@snowplow/snowtype-core");var xt=require("path"),an=require("mkdirp"),Gt=require("fs"),Pt=require("@snowplow/snowtype-core");var yi="instructions.md",sn="assets";async function cn(t,e,n,i,o){an.mkdirp.sync((0,xt.resolve)(i,sn));let r=[],a=xi(e,n,o),s=[];await Promise.all(e.map(async c=>{let l={triggers:await $e(t,c.triggers),instructionsHeading:_t(c.eventSpecification.name)};s.push(_t(c.eventSpecification.name));let g=Ci(c.propertyRules),m=Ai(c.entities);Ii(c.eventSpecification.id,l,i),r.push(wi({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:g,formattedCardinalityRules:m,organizationId:t.organizationId,sourceApplications:c.sourceApplications}))}));let p=`
|
|
75
76
|
# Implementation instructions
|
|
76
77
|
|
|
77
78
|
_A guide on how to implement tracking for the generated Event Specifications._
|
|
78
79
|
|
|
79
80
|
**Table of contents:**
|
|
80
|
-
${
|
|
81
|
+
${s.map(c=>`- [${c.instructionsTitle}](#${c.instructionsLink})`).join(`
|
|
81
82
|
`)}
|
|
82
83
|
|
|
83
84
|
${r.join(`
|
|
84
85
|
`)}
|
|
85
|
-
`;(0,Gt.writeFileSync)((0,
|
|
86
|
-
## [${
|
|
86
|
+
`;(0,Gt.writeFileSync)((0,xt.resolve)(i,yi),p,"utf-8")}function wi({eventStructure:t,entitiesStructures:e,name:n,id:i,dataProductId:o,version:r,triggerInstructions:a,linkToCode:s,formattedPropertyRules:p,formattedCardinalityRules:c,organizationId:l,sourceApplications:g}){let m="_N/A_";return`
|
|
87
|
+
## [${_t(n).instructionsTitle}](${Ei(l,o,i)})
|
|
87
88
|
|
|
88
89
|
| | |
|
|
89
90
|
| ----------- | ----------- |
|
|
90
91
|
| **Id** | ${i} |
|
|
91
92
|
| **Version** | ${r} |
|
|
92
93
|
| **Data Product Id** | ${o} |
|
|
93
|
-
| **Source Application/s** | ${
|
|
94
|
+
| **Source Application/s** | ${g.length?g.map(d=>d.name).join(", "):"None selected"} |
|
|
94
95
|
| **Event Data Structure** | ${t.name}/${t.version} |
|
|
95
96
|
| **Entity Data Structures** | ${e.map(d=>`${d.name}/${d.version}`).sort().join(", ")} |
|
|
96
|
-
| **Code** | ${
|
|
97
|
+
| **Code** | ${s} |
|
|
97
98
|
|
|
98
99
|
${p.length>0?`### Implementation Instructions for ${t.name} event properties
|
|
99
100
|
|
|
@@ -111,29 +112,30 @@ ${c.map(d=>Object.values(d).join(" | ")).join(`
|
|
|
111
112
|
`)}
|
|
112
113
|
`:""}
|
|
113
114
|
|
|
114
|
-
${
|
|
115
|
-
### Trigger ${
|
|
115
|
+
${a.map((d,y,b)=>`
|
|
116
|
+
### Trigger ${b.length!==1?y+1:""}
|
|
116
117
|
|
|
117
118
|
#### Screenshot
|
|
118
|
-
${d.imageBuffer?`[<img src="./assets/${i}_${y}.${d.imageExtension}" width="550"/>](./assets/${i}_${y}.${d.imageExtension})`:
|
|
119
|
+
${d.imageBuffer?`[<img src="./assets/${i}_${y}.${d.imageExtension}" width="550"/>](./assets/${i}_${y}.${d.imageExtension})`:m}
|
|
119
120
|
|
|
120
121
|
#### In which application(s) does this trigger apply?
|
|
121
122
|
|
|
122
|
-
${d.appIds&&d.appIds.length?d.appIds.map(w=>"`"+w+"` "):
|
|
123
|
+
${d.appIds&&d.appIds.length?d.appIds.map(w=>"`"+w+"` "):m}
|
|
123
124
|
|
|
124
125
|
#### The URL of the page on which this event specification triggers:
|
|
125
126
|
|
|
126
|
-
${d.url||
|
|
127
|
+
${d.url||m}
|
|
127
128
|
|
|
128
129
|
#### Notes
|
|
129
130
|
|
|
130
|
-
${d.description||
|
|
131
|
-
`).join("")}`}function
|
|
131
|
+
${d.description||m}
|
|
132
|
+
`).join("")}`}function Ii(t,e,n){e.triggers.forEach((i,o)=>{i.imageBuffer&&(0,Gt.writeFileSync)((0,xt.resolve)(n,sn,t+"_"+o+"."+i.imageExtension),i.imageBuffer,"binary")})}function Ei(t,e,n){return`https://console.snowplowanalytics.com/${t}/data-products/${e}/event-specifications/${n}`}function xi(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,Pt.createEventSpecificationInstructionsIdentifier)(o)));i[o]=r!==-1?`[Link](./${n+"#L"+r})`:"N/A"}),i}function _t(t){let e=t;return{instructionsTitle:e,instructionsLink:Pi(e)}}function Pi(t){return t.toLowerCase().replace(/[^a-z\d\s-]/g," ").replace(/\s+/g," ").trim().replace(/-{2,}|\s/g,"-")}function Ci(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 Ai(t){return t?t.map(({source:e,minCardinality:n,maxCardinality:i})=>{let{name:o}=(0,Pt.splitIgluSchemaUrlParts)(e),r=typeof n<"u"&&n>0?"\u2705":"\u274C",a=Oi(n,i);return{name:o,isRequired:r,formattedCardinalityValues:a}}):[]}function Oi(t,e){return typeof t>"u"?"`any`":typeof e<"u"?t===e?`Exactly \`${t}\``:`Between \`${t}\` and \`${e}\``:`At least \`${t}\``}var yn=S(require("fs-extra"));var un=require("fs"),dn=require("path"),ln=S(require("util"));function mn(t,e,n,i){let o=e==="typescript"?"ts":"js";(0,un.writeFileSync)((0,dn.resolve)(t,`validations.${o}`),`${o==="ts"?`
|
|
132
133
|
import { AnySchema } from "ajv";
|
|
133
134
|
export type CardinalityRule = { minCardinality?: number; maxCardinality?: number };
|
|
135
|
+
type IgluUrl = string;
|
|
136
|
+
type EventSpecificationId = string;
|
|
134
137
|
`:""}
|
|
135
|
-
export const entityRules${o==="ts"?": Record<
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
`),
|
|
139
|
-
`),await t.parseAsync(In.argv).catch(e=>{Di(e)})}function Di(t){if(!(t instanceof O.CommanderError&&["commander.help","commander.version","commander.helpDisplayed"].indexOf(t.code)>-1))throw t}En().then(()=>{}).catch(()=>{process.exitCode=1});
|
|
138
|
+
export const entityRules${o==="ts"?": Record<EventSpecificationId, Record<IgluUrl, CardinalityRule>>":""} = ${pn(i)}
|
|
139
|
+
export const schemasObject${o==="ts"?": Record<IgluUrl | EventSpecificationId, AnySchema | Record<IgluUrl, AnySchema>>":""} = ${pn(n)}`,"utf-8")}function pn(t){return ln.default.inspect(t,{showHidden:!1,depth:null,maxArrayLength:null})}function Ht(t){return Object.values(t).some(e=>bi(e)?Ti(e):Ht(e))}function bi(t){return typeof t=="object"&&t!==null&&Object.hasOwn(t,"$schema")}function Ti(t){return t.properties?Object.values(t.properties).some(e=>Object.hasOwn(e||{},"pattern")):!1}function gn(t,e){let n=ki(t);Di(n,e)}function Di(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 ki(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}async function $i(t){let e=await W();return R(e),e.options.commands.generate={...e.options.commands.generate,...t},e}async function K(t,e,n,i){let{dataProductIds:o,dataStructures:r,igluCentralSchemas:a,eventSpecificationIds:s,language:p,tracker:c,outpath:l,organizationId:g,options:{commands:{generate:m}}}=await $i(i);n.setSpinnerTitle("Generating..."),n.isSpinning()===!1&&n.start(),J(r)&&J(a)&&J(s)&&J(o)&&e.warn("Data Structures, Schemas and Event Specifications are empty.");let d=new x({...t,organizationId:g});if(!await d.authenticate())throw new F;let b=await yt(d,o),w=qe([...b,...s]),{eventSpecificationsWithId:I}=await Le(d,w,e),N=Oe(I);m.deprecateOnlyOnProdAvailableUpdates&&(N=await Te(N,d));let Pn=await je(d,I),q=Ue(Pn,I);gn(q,e);let{customEventSpecs:Cn,standardEventSpecs:An}=Ye(q),On=An.flatMap(Ot=>Ot.entities.map(kn=>kn.source));pe(I)&&c==="@snowplow/browser-tracker"&&e.log("You are generating Snowplow Ecommerce events. You would need to install `@snowplow/browser-plugin-snowplow-ecommerce`."),m.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 bn=await Fe(a),Kt=await Re(d,[...r,...On]),qt=!!(c==="@snowplow/browser-tracker"&&p.match(/javascript|typescript/));await Xe(Kt,q,d,m.disallowDevSchemas);let Tn={language:p,tracker:c,schemas:[...bn,...Kt],eventSpecifications:Cn,validations:qt&&m.validations,eventSpecificationsInputMetadata:N},$=await(0,vn.generate)(Tn);if(n.stop(!0),!$)throw new X;e.success("Code generated, writing...");let Dn=$.lines.join(`
|
|
140
|
+
`),M=(0,Ct.resolve)((0,fn.cwd)(),l);yn.default.removeSync((0,Ct.resolve)(M)),Sn.mkdirp.sync(M);let Xt=ee+ze(p);if((0,hn.writeFileSync)((0,Ct.resolve)(M,Xt),Dn),Be(I,l),qt&&m.validations&&$.validationsSchemaObject){let Ot=Ve(I);mn(M,p,$.validationsSchemaObject,Ot),Ht($.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")}m.instructions&&await cn(d,q,$.lines,M,Xt)}var zt=C(K,"generate");async function Li(){let t=await W();return R(t),t}async function Fi(t,e,n,i){let o=await Li(),{options:{commands:{update:{maximumBump:r,regenerateOnUpdate:a,showOnlyProdUpdates:s},generate:p}}}=o;e.debug("Starting update process with options: ".concat(JSON.stringify(i)));let c=(0,In.resolve)((0,wn.cwd)(),o.outpath,pt),l=new x({...t,organizationId:o.organizationId});n.setSpinnerTitle("Checking for updates..."),n.isSpinning()===!1&&n.start();let g=await yt(l,o.dataProductIds),m=V([...o.eventSpecificationIds,...g]),d={};if(!Vt(c)&&m.length>0)throw new nt;if(Vt(c)&&m.length>0){let w=Ge(c);d=await he(l,m,w)}let y=await fe(l,o.dataStructures,i.maximumBump||r,s);if((Object.entries(d).length>0||y.length>0)===!0){if(e.success("Available updates found!"),Je(d,y,e),i.yes||a)return y.length>0&&(y.forEach(w=>{let I=o.dataStructures.indexOf(w.previous);o.dataStructures[I]=w.next}),Et(o)),e.debug("Applying the updates.."),K(t,e,n,p);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 Bt=C(Fi,"update");async function Ri(t){if(Object.values(t).every(n=>Array.isArray(n)&&n.length===0))throw new tt;let e=await W();return R(e),{patchOptions:t,generateOptions:e.options.commands.generate,regenerateOnPatch:e.options.commands.patch.regenerateOnPatch}}async function ji(t,e,n,i){let{isJSON:o}=It(process.cwd());if(o===!1)throw new it;let{patchOptions:r,generateOptions:a,regenerateOnPatch:s}=await Ri(i);return e.debug("Starting patch process with options: ".concat(JSON.stringify(r))),Object.entries(r).forEach(([c,l])=>{l.forEach(g=>{ge(c,g)})}),e.success("Configuration patched"),s?K(t,e,n,a):(e.log("Code is not generated yet for the patched configuration"),Promise.resolve(void 0))}var Jt=C(ji,"patch");var At=require("@snowplow/snowtype-core");async function xn(){await import("dotenv/config");let t=new O.Command;t.exitOverride(),t.version(U,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 O.Option("-t, --tracker <availableTrackers>","tracker to use").choices(At.trackerTemplates)).addOption(new O.Option("-l, --language <availableLanguages>","language to use").choices(At.languageIds)).option("-o, --outpath <string>","output path").action(Mt),t.command("update").description("Checks for latest version updates in Data Structures and Event Specifications.").option("-y, --yes","updates all to latest without asking (caution: will ovewrite the configuration file)").addOption(new O.Option("-m, --maximumBump <'patch' | 'minor' | 'major'>","the maximum SchemaVer update to show an available update notification. Defaults to 'major'").choices(["patch","minor","major"])).action(Bt),t.command("generate").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(zt),t.command("patch").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").action(Jt),t.addHelpText("before",Ie()).addHelpText("after",`
|
|
141
|
+
`),await t.parseAsync(En.argv).catch(e=>{Ui(e)})}function Ui(t){if(!(t instanceof O.CommanderError&&["commander.help","commander.version","commander.helpDisplayed"].indexOf(t.code)>-1))throw t}xn().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.10.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.10.1",
|
|
17
17
|
"chalk": "^4.1.2",
|
|
18
18
|
"cli-spinner": "^0.2.10",
|
|
19
19
|
"dotenv": "^16.3.1",
|