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