@snowplow/snowtype 0.15.0 → 0.15.2
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 +35 -35
- package/package.json +6 -6
package/dist/index.js
CHANGED
|
@@ -1,50 +1,50 @@
|
|
|
1
|
-
"use strict";var
|
|
2
|
-
`);super(a),this.response={statusCode:n,body:r}}};function
|
|
3
|
-
${
|
|
1
|
+
"use strict";var ni=Object.create;var re=Object.defineProperty;var ii=Object.getOwnPropertyDescriptor;var oi=Object.getOwnPropertyNames;var ri=Object.getPrototypeOf,ai=Object.prototype.hasOwnProperty;var si=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of oi(e))!ai.call(t,o)&&o!==n&&re(t,o,{get:()=>e[o],enumerable:!(i=ii(e,o))||i.enumerable});return t};var g=(t,e,n)=>(n=t!=null?ni(ri(t)):{},si(e||!t||!t.__esModule?re(n,"default",{value:t,enumerable:!0}):n,t));var jn=g(require("process")),b=require("@commander-js/extra-typings");var ci={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"},pi="Please report a bug.",h=class extends Error{code;constructor(e,n=""){let i=ci[e].concat(n);super(i),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=e}},Q=class extends h{constructor(){super("GenerationFailed")}},B=class extends h{constructor(){super("ConfigAlreadyExists")}},tt=class extends h{constructor(){super("ConfigNotExists")}},et=class extends h{constructor(e){super("ConfigInvalid",e)}},nt=class extends h{constructor(e){super("InternalError",e.concat(pi))}},V=class extends h{constructor(e,n){let i=`Value ${n} is an invalid ${e}.`;super("InvalidOption",i)}},it=class extends h{constructor(){super("MissingOptions")}},j=class extends h{constructor(){super("AuthError")}},ot=class extends h{constructor(){super("WriteLockFile")}},rt=class extends h{constructor(){super("MissingLockFile")}},at=class extends h{constructor(){super("PatchingNotSupported")}},st=class extends h{constructor(){super("DevNotAllowed")}},ct=class extends h{constructor(){super("AuthCredentialsMissing")}};var ae=g(require("got"));async function se({schema:t}){return(await(0,ae.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${t.replace("iglu:","")}`)).body}var ht=g(require("got"));var ge=require("js-sha256"),$t=g(require("node:assert"));var u=g(require("joi")),mt=require("@snowplow/snowtype-core");var Lt=g(require("node:assert"));var J="snowtype.config",pt=".js",ut=".ts",dt=".json",ce=Object.freeze([pt,ut,dt]),lt=".snowtype-lock.json",Ft="snowplow";var K={"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"}]},pe={commands:{generate:{instructions:!1,validations:!1,disallowDevSchemas:!1,deprecateOnlyOnProdAvailableUpdates:!1},update:{maximumBump:"major",regenerateOnUpdate:!1,showOnlyProdUpdates:!1},patch:{regenerateOnPatch:!1}}},ue=["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","iglu:com.snowplowanalytics.snowplow/expose_element/jsonschema/1-0-0","iglu:com.snowplowanalytics.snowplow/create_element/jsonschema/1-0-0"],de="iglu:com.snowplowanalytics.snowplow.ecommerce";var gt=require("lodash");function me(t){let e=t.split("-");(0,Lt.default)(e.length===3,"invalid SchemaVer"),(0,Lt.default)(e.filter(n=>isNaN(parseInt(n))).length===0,"invalid SchemaVer")}function M(t){t.options=(0,gt.merge)((0,gt.cloneDeep)(pe),t.options||{})}var le=new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$"),ui=new RegExp("^[A-Z][a-zA-Z0-9]*$"),di=u.default.object().required().keys({tracker:u.default.string().required().valid(...mt.trackerTemplates),language:u.default.string().required().valid(...mt.languageIds),outpath:u.default.string().required(),namespace:u.default.when("language",{is:"swift",then:u.default.string().regex(ui).optional(),otherwise:u.default.forbidden().messages({"any.unknown":"namespace is only supported for 'swift' language"})}),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(le)),repositories:u.default.array().optional().items(u.default.string()),dataStructures:u.default.array().optional().items(u.default.string().regex(le)),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()})})})}),N=t=>{let e=di.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new et(e.error.annotate());return t};function li(t){let e=ge.sha256.create();return e.update(t),e.hex()}function fe(t,e){let{vendor:n,name:i,format:o}=x(t);return li(`${e}-${n}-${i}-${o}`)}function x(t){let e=t.replace("iglu:",""),[n,i,o,r]=e.split("/");return(0,$t.default)(typeof n=="string"&&typeof i=="string"&&typeof o=="string"&&typeof r=="string",`invalid iglu uri ${t}`),me(r),{vendor:n,name:i,format:o,version:r}}function he(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 Se(t){return t.some(e=>e.eventSchema.isEcomTemplateSchema)}function q(t){let[e,n,i]=t.split("-").map(o=>parseInt(o));return{model:e,revision:n,addition:i}}function ve(t,e,n=0){if(t===e&&n!==0)return"patch";let{model:i,revision:o,addition:r}=q(t),{model:a,revision:s,addition:p}=q(e);if(i!==a)return"major";if(o!==s)return"minor";if(r!==p)return"patch";(0,$t.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 ye(t){return!!Object.hasOwn(t||{},"response")}var W="0.15.2";var we=g(require("p-limit")),A=class t{apiKeyId;apiKey;organizationId;accessToken;pLimit;dataProductsCache=new Map;eventSpecsCache=new Map;schemaVersionsDraftsCache=new Map;schemaVersionsDevCache=new Map;schemaVersionsProdCache=new Map;sourceApplicationsCache=new Map;apiUrl=process.env.SNOWPLOW_CONSOLE_API_URL||"https://console.snowplowanalytics.com/api/msc";constructor({apiKeyId:e,apiKey:n,organizationId:i,requestLimit:o=20}){this.apiKeyId=e,this.apiKey=n,this.organizationId=i,this.pLimit=(0,we.default)(o)}static async create(e){let n=new t(e);return await n.initialize(e),n}static createLazy(e){return new t(e)}async initialize(e){await this.fetchAccessToken(),e.enableSupportForNonDataProductsTier?await Promise.all([this.bulkFetchAllSchemaDraftsVersions(),this.bulkFetchAllSchemaVersions("DEV"),this.bulkFetchAllSchemaVersions("PROD")]):await Promise.all([this.bulkFetchAllDataProducts(),this.bulkFetchAllEventSpecifications(),this.bulkFetchAllSchemaDraftsVersions(),this.bulkFetchAllSchemaVersions("DEV"),this.bulkFetchAllSchemaVersions("PROD")])}async bulkFetchAllDataProducts(){let e=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-products/v2`,n=await this.fetchResource(e);n.data.forEach(i=>this.dataProductsCache.set(i.id,i)),n.includes.sourceApplications?.forEach(i=>{this.sourceApplicationsCache.set(i.id,i)})}async bulkFetchAllEventSpecifications(){let e=`${this.apiUrl}/v1/organizations/${this.organizationId}/event-specs/v1`,n=await this.fetchResource(e);n.data.forEach(i=>{let o={...n.metadata,outdatedDsWarnings:n.metadata?.outdatedDsWarnings.filter(a=>a.id===i.id)||[],hiddenDsWarnings:n.metadata?.hiddenDsWarnings.filter(a=>a.id===i.id)||[],metrics:n.metadata?.metrics.filter(a=>a.id===i.id)||[]},r={data:i,metadata:o};this.eventSpecsCache.set(i.id,r)})}async bulkFetchAllSchemaVersions(e){let n=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/schemas/versions?env=${e}`,i=await this.fetchResource(n),o=e==="DEV"?this.schemaVersionsDevCache:this.schemaVersionsProdCache;i.forEach(r=>{let a=`iglu:${r.self.vendor}/${r.self.name}/${r.self.format}/${r.self.version}`;o.set(a,r)})}async bulkFetchAllSchemaDraftsVersions(){let e=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structure-drafts/v1/schemas`,n=await this.fetchResource(e),i=this.schemaVersionsDraftsCache;n.forEach(o=>{let r=`iglu:${o.self.vendor}/${o.self.name}/${o.self.format}/${o.self.version}`;i.set(r,o)})}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":W}}).json();return this.accessToken=n,n}fetchResource(e){return this.pLimit(async()=>{try{let n=await this.fetchAccessToken();return await(0,ht.default)(e,{headers:{Authorization:"Bearer "+n,"X-Snowtype":W}}).json()}catch(n){throw ye(n)?new ft(n):n}})}getSchemaVersion({schema:e,env:n="DEV"}){return(n==="DEV"?this.schemaVersionsDevCache:this.schemaVersionsProdCache).get(e)??(()=>{throw new Error(`Schema ${e} not found in ${n} environment`)})()}getAllSchemaDraftVersion(){return this.schemaVersionsDraftsCache}async fetchDeployments({schema:e,deploymentEnv:n}){let i=fe(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}getEventSpecificationById(e){let n=this.eventSpecsCache.get(e)??(()=>{throw new Error(`Event specification ${e} not found`)})();return{data:n.data,metadata:n.metadata}}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":W}})}getDataProductById(e){let n=this.dataProductsCache.get(e)??(()=>{throw new Error(`Data product ${e} not found`)})(),i=(n.sourceApplications||[]).map(o=>this.sourceApplicationsCache.get(o)).filter(Boolean);return{data:[n],includes:{sourceApplications:i}}}async authenticate(){try{return await this.fetchAccessToken(),!0}catch{return!1}}};var C=require("path"),w=require("fs");var Wt=g(require("util")),_t=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=g(require("node:assert"));var Ie=require("semver");function Ee(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,jt(o)),!0}catch(i){return console.error(i),!1}}var mi=(t,e)=>{let{model:n,revision:i,addition:o}=q(t.version),{model:r,revision:a,addition:s}=q(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 Pe(t,e,n,i){return(await Promise.all(e.map(async r=>{let{version:a}=x(r),s=await t.fetchDeployments({schema:r,...i&&{deploymentEnv:"PROD"}}),p=gi(s,a,n);p.sort(mi);let c=p.pop();if(!c)return null;let d={previous:r,next:he(r,{version:c.version}),nextEnv:c.env};return c.version!==a?{...d,nextReason:"version"}:c.patchLevel>0&&c.env==="DEV"?{...d,nextReason:"patch"}:null}))).flatMap(r=>r===null?[]:[r])}async function Rt(t,e){return Promise.all(e.map(async n=>{try{t.getSchemaVersion({schema:n,env:"PROD"})}catch(i){if(i.response?.statusCode===404||i.message?.includes("not found in PROD environment"))try{return t.getSchemaVersion({schema:n,env:"DEV"}),n}catch(r){if(!(r.response?.statusCode===404||r.message?.includes("not found in DEV environment")))throw r}}return null})).then(n=>n.flatMap(i=>i!==null?[i]:[]))}async function Ce(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=t.getEventSpecificationById(r).data;(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(d=>d.source)||[]].flatMap(d=>typeof d=="string"?[d]:[]),c=await Rt(t,p);return(s.version||0)>a&&(o[r]={previous:a,next:s.version,devOnlySchema:c}),r})),o}function gi(t,e,n){return t.filter(i=>Vt(e,i.version)!==1).filter(i=>i.version!==e||i.patchLevel).map(i=>({...i,updateType:ve(i.version,e,i.patchLevel)})).filter(fi(n))}function fi(t){return({updateType:e})=>{switch(t){case"major":return!0;case"minor":return e==="patch"||e==="minor";case"patch":return e==="patch"}}}function Vt(t,e){let n=t.replaceAll("-","."),i=e.replaceAll("-",".");return(0,Ie.compare)(n,i)}var Ae=require("cli-spinner"),S=g(require("chalk"));function De(){let t=new Ae.Spinner;return t.setSpinnerString(18),t}var hi="https://snowplow.io",Si="https://docs.snowplow.io/docs/collecting-data/code-generation/",X={SUCCESS:"\u2714",LOG:"\u2139",DEBUG:"\u27A4",ERROR:"\u2717",WARN:"\u26A0"},Oe={LINK:"#9911BB",OPTION:"#9911DD"};function xe(t){return S.default.hex(Oe.LINK).bold(t)}function F(t){return S.default.hex(Oe.OPTION).italic(t)}function yt(t,e){return t==="h1"?S.default.bold.underline(e):S.default.bold(e)}function be(){return`
|
|
3
|
+
${yt("h1","CLI Help")}
|
|
4
4
|
|
|
5
|
-
For more information visit the Snowplow website ${
|
|
5
|
+
For more information visit the Snowplow website ${xe(hi)}
|
|
6
6
|
|
|
7
|
-
For details see the CLI documentation ${
|
|
7
|
+
For details see the CLI documentation ${xe(Si)}
|
|
8
8
|
|
|
9
|
-
${
|
|
9
|
+
${yt("h2","How to get started")}
|
|
10
10
|
1. Use ${S.default.cyanBright("snowtype init")} to initialize the setup.
|
|
11
11
|
2. Use ${S.default.cyanBright("snowtype patch")} to add a Data Structure or Event Specification.
|
|
12
12
|
3. Use ${S.default.cyanBright("snowtype generate")} to generate tracking code.
|
|
13
13
|
|
|
14
|
-
${
|
|
15
|
-
To learn more about each CLI command, use the ${
|
|
14
|
+
${yt("h2","Available commands")}
|
|
15
|
+
To learn more about each CLI command, use the ${F("--help")} option, for example, ${F("snowtype init --help")}.
|
|
16
16
|
|
|
17
|
-
${
|
|
17
|
+
${F("snowtype init")}
|
|
18
18
|
Initialize the setup of Snowtype code generation in a project. Creates the \`snowtype.config.json\` file.
|
|
19
19
|
|
|
20
|
-
${
|
|
20
|
+
${F("snowtype patch")}
|
|
21
21
|
Adds new Data Structures and Event Specifications in the \`snowtype.config.json\` file.
|
|
22
22
|
|
|
23
|
-
${
|
|
23
|
+
${F("snowtype generate")}
|
|
24
24
|
Generates tracking code based on configuration on the \`snowtype.config.json\` file.
|
|
25
25
|
|
|
26
|
-
${
|
|
26
|
+
${F("snowtype update")}
|
|
27
27
|
Checks for latest version updates in Data Structures and Event Specifications.
|
|
28
28
|
|
|
29
|
-
${
|
|
30
|
-
Use the ${
|
|
31
|
-
`}function
|
|
29
|
+
${yt("h2","Debug")}
|
|
30
|
+
Use the ${F("-v")} to output verbose logs
|
|
31
|
+
`}function ke(t){let e=`${X.SUCCESS}: `;return S.default.cyanBright(e)+t}function wt(t){let e=`${X.WARN} Warning: `;return S.default.hex("#FFA500")(e)+t}function Te(t){let e=`${X.LOG} ${t}`;return S.default.yellowBright(e)}function Fe(t){let e=`${X.DEBUG} Debug: `;return S.default.magenta(e)+t}function Le(t){let e=`${X.ERROR} Error: `;return S.default.redBright(e)+t}function $e(t,e){let n=`- ${t}`,i=`+ ${e}`;return`
|
|
32
32
|
${S.default.magenta(n)}
|
|
33
33
|
${S.default.cyanBright(i)}
|
|
34
|
-
`}var
|
|
34
|
+
`}var Ne=g(require("mime-types"));var Re=t=>{let e={outdatedDsWarnings:[],hiddenDsWarnings:[],metrics:[]};return t.reduce((n,i)=>vi({currentMetadata:n,eventSpecificationId:i.eventSpecification.id,newMetadata:i.metadata||e}),{})};function vi({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 Ve=t=>(e,n)=>{yi(e,n||"").forEach(t.warn)};function yi(t,e){let n=wi(t.outdatedDsWarnings,e),i=Ii(t.hiddenDsWarnings,e);return n.concat(i)}function wi(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 je(t,e){let n=Pi(t),i=await Promise.all(n.map(async r=>({schema:r,deployments:await e.fetchDeployments({schema:r,deploymentEnv:"PROD"})}))),o=Ei(i);return Ci(t,o)}var Ei=t=>t.flatMap(({schema:e,deployments:n})=>{let{version:i}=x(e);return n.filter(r=>Vt(i,r.version)===-1).length===0?[]:[e]}),Pi=t=>_(Object.entries(t).filter(([,e])=>e.outdatedDsWarnings.length!==0).flatMap(([,e])=>e.outdatedDsWarnings.flatMap(n=>n.sources.map(i=>i.source)))),Ci=(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},{});function It(t,e){return e.map(i=>t.getDataProductById(i)).flatMap(({data:[i]})=>i?i.eventSpecs:[]).map(i=>i.id)}function xi(t){let{original:e}=t,[n,i]=e.split("/").reverse();return{imageVariant:n,imageId:i}}async function We(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:d}=xi(s),m=await t.fetchImageVariant({imageId:d,imageVariant:c});p.imageBuffer=m.rawBody,p.imageExtension=Ne.default.extension(m.headers["content-type"])||""}n.push(p)}return n}function _e(t,e,n){return{eventSpecificationsWithId:e.map(o=>{let r=t.getEventSpecificationById(o),a=r.data;if(typeof a>"u"||typeof a.event>"u")return[];r.metadata&&Ve(n)(r.metadata,a.dataProductId);let p=Mt(a.event.source);p&&n.warn("Currently code will not be generated for `Standard` events. Skipping...");let c=a.triggers,d=a.name,m=a.version,y=a.sourceApplications||[],f=a.event.schema,l=p?Di(a.event.source):Me(t,a,a.event.source),v=a.entities?.tracked||[],L=v.map(({source:E,schema:H})=>({original:Me(t,a,E),propertyRule:H}));return{eventSpecification:{name:d||"",id:o,dataProductId:a.dataProductId||"",dataProductName:""},version:m||0,eventSchema:l,entitiesSchemas:L,entities:v,triggers:c,propertyRules:f,sourceApplicationIds:y,metadata:r.metadata}}).flat()}}async function Ue(t){return await Promise.all(t.map(async n=>JSON.parse(await se({schema:n}))))}async function Ge(t,e){return await Promise.all(e.map(i=>t.getSchemaVersion({schema:i})))}function ze(t,e){return e.flatMap(({eventSpecification:{dataProductId:r}})=>r?[r]:[]).map(r=>t.getDataProductById(r)).map(r=>r.data[0]&&{...r.data[0],sourceApplications:(r.includes.sourceApplications||[]).filter(a=>a!==void 0)}).filter(Ai)}function He(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:{id:o.eventSpecification.id,name:o.eventSpecification.name,dataProductId:r?.id||"",dataProductName:r?.name||"",...r?.domain?{dataProductDomain:r.domain}:{}},sourceApplications:a}})}function Ai(t){return!!t}function Me(t,e,n){let i=e.event?.schema?.properties?.type?.enum?.[0];return n.match(de)?{self:x(n),isEcomTemplateSchema:i}:t.getSchemaVersion({schema:n})}function Be(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 Di(t){return{self:{...x(t)}}}function Je(t,e,n){return t.filter(i=>{let{data:o}=e.getEventSpecificationById(i),r=e.getAllSchemaDraftVersion(),a=o.event?r.has(o.event.source):!1,s=o.entities?.tracked?o.entities.tracked.filter(p=>r.has(p.source)):[];if(a||s.length>0){let p=[];if(a&&o.event&&p.push(`Event DS: ${o.event.source}`),s.length>0){let c=s.map(d=>d.source).join(", ");p.push(`Entity DS: [${c}]`)}return n.warn(`Event specification with ID "${i}" has been excluded because it contains draft data structures - ${p.join(" | ")}`),!1}else return!0})}function Ke(t,e,n){return t.filter(i=>{let o=e.getAllSchemaDraftVersion().has(i);return o&&n.warn(`DS ${i} is skipped because it is draft`),!o})}var Oi="SNOWPLOW_CONSOLE_API_KEY_ID",bi="SNOWPLOW_CONSOLE_API_KEY";function Ye(t){return t.length!==0}function jt(t){return JSON.stringify(t,null,2)}function Ze(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 ki(t){switch(t){case"typescript":return`${J}${ut}`;case"javascript":return`${J}${pt}`;case"json":return`${J}${dt}`;default:return""}}var qe=t=>(0,w.existsSync)(t)&&!(0,w.lstatSync)(t).isDirectory(),Ti=t=>J+t,Fi=t=>({isTS:t.endsWith(ut),isJSON:t.endsWith(dt),isJS:t.endsWith(pt)}),Nt=t=>({configDir:(0,C.dirname)(t),configPath:t,...Fi(t)});function D(t){let e=(0,C.isAbsolute)(t)?t:(0,C.resolve)(process.cwd(),t);if(qe(e))return Nt(e);if(!(0,w.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='import { SnowtypeConfig } from "@snowplow/snowtype/types";',s=`const config: SnowtypeConfig = ${
|
|
42
|
-
`,p="module.exports = config;",c="export default config;";return n==="json"?(0,
|
|
43
|
-
`))}function
|
|
44
|
-
`,
|
|
40
|
+
cwd: ${process.cwd()}`);let[n]=ce.map(i=>(0,C.resolve)(e,Ti(i))).filter(qe);return Nt(typeof n!="string"?e:n)}function Pt(t,e){let n=T.getFormat(),i=ki(n),o=(0,C.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,w.writeFileSync)(o,jt(t)):(0,w.writeFileSync)(o,(n==="typescript"?[a,s,c]:[r,p]).join(`
|
|
43
|
+
`))}function Ut(t){let e=(0,w.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function Gt(t){return(0,w.readFileSync)(t,{encoding:"utf-8"})}var Li=async t=>(await(0,_t.require)(t,__filename)).default;async function U(t){let{configPath:e,isJS:n,isJSON:i,isTS:o}=D(t),r;return o?(r=await Li(e),T.setFormat("typescript")):n?(r=(await import(e)).default,T.setFormat("javascript")):i&&(r=JSON.parse(Gt(e)),T.setFormat("json")),typeof r=="function"&&(r=await r()),r}function Qe(t){return JSON.parse(Gt(t))}async function tn(t,e){t.debug("Checking for existing configuration.."),await zt(!0,e),t.success("Valid configuration found")}async function zt(t,e){let{configPath:n,isJS:i,isJSON:o,isTS:r}=D(e),a=o===!0||r===!0||i===!0,s=r===!1&&i===!1&&o===!1,p;if(r?p=(await(0,_t.require)(n,__filename)).default:i?p=(await import(n)).default:o&&(p=JSON.parse(Gt(n))),typeof p=="function"&&(p=await p()),t){if(s)throw new tt;N(p)}else if(a)try{throw N(p),new B}catch(c){if(c instanceof B)throw c}}function en(t){return{javascript:".js","javascript-gtm":".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go",dart:".dart",java:".java"}[t]||""}function nn(t,e){let n={eventSpecifications:{}};t.forEach(o=>{n.eventSpecifications[o.eventSpecification.id]=o.version});let i=(0,C.resolve)(e,lt);try{(0,w.writeFileSync)(i,JSON.stringify(n,null,2))}catch{throw new ot}}function on(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 rn(t){let e=t.optsWithGlobals();return{...e,apiKeyId:e.apiKeyId||process.env[Oi],apiKey:e.apiKey||process.env[bi]}}function I(t){return!!(Array.isArray(t)&&!t.length)}function _(t){return[...new Set(t)]}function an(t){let e=_(t);return e.sort(),e}function $i(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 sn(t,e,n,i){let o=t.map(s=>(0,Et.joinIgluSchemaUrlParts)(s.self)),r=$i(e),a=await Rt(n,_([...o,...r]));if(a.length>0&&(console.log(`
|
|
44
|
+
`,wt(`Generating code using schemas in DEV environment, tracking against those will result in failed events. Schemas in DEV:
|
|
45
45
|
`+a.join(`
|
|
46
46
|
`)),`
|
|
47
|
-
`),i))throw new
|
|
47
|
+
`),i))throw new st}function Mt(t){return ue.includes(t)}function Xe({self:t}){let e=(0,Et.joinIgluSchemaUrlParts)(t);return Mt(e)}function cn(t){return{standardEventSpecs:t.filter(e=>Xe(e.eventSchema)),customEventSpecs:t.filter(e=>!Xe(e.eventSchema))}}function pn(t,e,n){if(typeof t=="string"&&typeof e=="string"&&t&&e)return{apiKeyId:t,apiKey:e};throw n.error(new ct),new Error}function un(t){let e=!I(t.configDataStructures),n=!I(t.igluCentralSchemas),i=!I(t.repositories),o=!I(t.eventSpecificationIds),r=!I(t.dataProductIds);return(e||n||i)&&(!o&&!r)}var Ri=["javascript","json","typescript"];function dn(t){return t in K}function ln(t,e){let n=K[t];return Array.isArray(n)?n.map(o=>o.value).includes(e):!1}function mn(t){return Ri.includes(t)}function gn(){return{withVerbosity:e=>({success:i=>{console.log(ke(i))},warn:i=>{console.log(wt(i))},log:i=>{console.log(Te(i))},diff:(i,o)=>{console.log($e(i,o))},debug:i=>{e===!0&&console.log(Fe(JSON.stringify(i)))},error:i=>{console.log(Le(i.message)),e===!0&&console.log(i)}})}}function O(t,e){return async(n,i)=>{let o=rn(i),r=gn(),a=De(),s=r.withVerbosity(o.verbose),{apiKeyId:p,apiKey:c}=pn(o.apiKeyId,o.apiKey,s);if(e!=="init")try{let d=n.config||process.cwd();await tn(s,d)}catch(d){fn(d,s,a)}return t({apiKeyId:p,apiKey:c},s,a,n).then(()=>hn(a)).catch(d=>{fn(d,s,a)})}}function fn(t,e,n){throw hn(n),e.error(t),t}function hn(t){t.isSpinning()===!0&&t.stop(!0)}var Vi={type:"password",message:"Enter your Snowplow organization ID:",mask:!0,validate:Ye},ji={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"}]},Mi={type:"select",message:"Select the format to use:",choices:[{value:"javascript",name:"JavaScript"},{value:"typescript",name:"TypeScript"},{value:"json",name:"JSON"}]},Ni={type:"input",message:"Enter the directory for Snowtype output:",default:"./snowtype"},Wi=t=>({type:"select",message:"Select the language to use:",choices:t});async function _i(t,e){e.debug("Checking for existing configuration file.."),await zt(!1,process.cwd());let{password:n,select:i,input:o}=await import("@inquirer/prompts"),r=t.organizationId||await n(Vi),a=t.tracker||await i(ji);if(!dn(a))throw new V("tracker",a);let s=K[a],p;if(s.length===1){let m=s[0];if(typeof m>"u")throw new nt("Missing language entry.");p=m.value}else p=t.language||await i(Wi(s));if(!ln(a,p))throw new V("language",p);let c=await i(Mi);if(!mn(c))throw new V("format",c);T.setFormat(c);let d=t.outpath||await o(Ni);return e.debug("Assembling initialization options.."),{organizationId:r,tracker:a,language:p,format:c,outpath:d}}async function Ui(t,e,n,i){let o=await _i(i,e);n.setSpinnerTitle("Initialising..."),n.isSpinning()===!1&&n.start(),e.debug("Creating configuration with options: ".concat(JSON.stringify(o)));let r=Ze(o);if(N(r),!await A.createLazy({...t,organizationId:r.organizationId}).authenticate())throw new j;e.success("Authentication succeeded"),Pt(r,process.cwd()),e.success("Configuration created")}var Ht=O(Ui,"init");var Vn=require("path");var Rn=require("@snowplow/snowtype-core");var Ct=require("path"),Sn=require("mkdirp"),Jt=require("fs"),xt=require("@snowplow/snowtype-core");var Gi="instructions.md",vn="assets";async function yn(t,e,n,i,o){Sn.mkdirp.sync((0,Ct.resolve)(i,vn));let r=[],a=Ji(e,n,o),s=[];await Promise.all(e.map(async c=>{let d={triggers:await We(t,c.triggers),instructionsHeading:Bt(c.eventSpecification.name)};s.push(Bt(c.eventSpecification.name));let m=qi(c.propertyRules),y=Xi(c.entities);Hi(c.eventSpecification.id,d,i),r.push(zi({eventStructure:c.eventSchema.self,entitiesStructures:c.entitiesSchemas?.map(f=>f.original.self)||[],name:c.eventSpecification.name,id:c.eventSpecification.id,dataProductId:c.eventSpecification.dataProductId,version:c.version,triggerInstructions:d.triggers,linkToCode:a[c.eventSpecification.id],formattedPropertyRules:m,formattedCardinalityRules:y,organizationId:t.organizationId,sourceApplications:c.sourceApplications,...c.eventSpecification?.dataProductDomain?{dataProductDomain:c.eventSpecification?.dataProductDomain}:{}}))}));let p=`
|
|
48
48
|
# Implementation instructions
|
|
49
49
|
|
|
50
50
|
_A guide on how to implement tracking for the generated Event Specifications._
|
|
@@ -55,8 +55,8 @@ ${s.map(c=>`- [${c.instructionsTitle}](#${c.instructionsLink})`).join(`
|
|
|
55
55
|
|
|
56
56
|
${r.join(`
|
|
57
57
|
`)}
|
|
58
|
-
`;(0,
|
|
59
|
-
## [${
|
|
58
|
+
`;(0,Jt.writeFileSync)((0,Ct.resolve)(i,Gi),p,"utf-8")}function zi({eventStructure:t,entitiesStructures:e,name:n,id:i,dataProductId:o,version:r,triggerInstructions:a,linkToCode:s,formattedPropertyRules:p,formattedCardinalityRules:c,organizationId:d,sourceApplications:m,dataProductDomain:y}){let f="_N/A_";return`
|
|
59
|
+
## [${Bt(n).instructionsTitle}](${Bi(d,o,i)})
|
|
60
60
|
|
|
61
61
|
| | |
|
|
62
62
|
| ----------- | ----------- |
|
|
@@ -67,7 +67,7 @@ ${r.join(`
|
|
|
67
67
|
| **Event Data Structure** | ${t.name}/${t.version} |
|
|
68
68
|
| **Entity Data Structures** | ${e.map(l=>`${l.name}/${l.version}`).sort().join(", ")} |
|
|
69
69
|
| **Code** | ${s} |
|
|
70
|
-
| **Data Product Domain** | ${
|
|
70
|
+
| **Data Product Domain** | ${y&&y.length>0?y:f} |
|
|
71
71
|
|
|
72
72
|
${p.length>0?`### Implementation Instructions for ${t.name} event properties
|
|
73
73
|
|
|
@@ -85,8 +85,8 @@ ${c.map(l=>Object.values(l).join(" | ")).join(`
|
|
|
85
85
|
`)}
|
|
86
86
|
`:""}
|
|
87
87
|
|
|
88
|
-
${a.map((l,v
|
|
89
|
-
### Trigger ${
|
|
88
|
+
${a.map((l,v,L)=>`
|
|
89
|
+
### Trigger ${L.length!==1?v+1:""}
|
|
90
90
|
|
|
91
91
|
#### Screenshot
|
|
92
92
|
${l.imageBuffer?`[<img src="./assets/${i}_${v}.${l.imageExtension}" width="550"/>](./assets/${i}_${v}.${l.imageExtension})`:f}
|
|
@@ -102,15 +102,15 @@ ${l.url||f}
|
|
|
102
102
|
#### Notes
|
|
103
103
|
|
|
104
104
|
${l.description||f}
|
|
105
|
-
`).join("")}`}function
|
|
105
|
+
`).join("")}`}function Hi(t,e,n){e.triggers.forEach((i,o)=>{i.imageBuffer&&(0,Jt.writeFileSync)((0,Ct.resolve)(n,vn,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 Ji(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,xt.createEventSpecificationInstructionsIdentifier)(o)));i[o]=r!==-1?`[Link](./${n+"#L"+r})`:"N/A"}),i}function Bt(t){let e=t;return{instructionsTitle:e,instructionsLink:Ki(e)}}function Ki(t){return t.toLowerCase().replace(/[^a-z\d\s-]/g," ").replace(/\s+/g," ").trim().replace(/-{2,}|\s/g,"-")}function qi(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 Xi(t){return t?t.map(({source:e,minCardinality:n,maxCardinality:i})=>{let{name:o}=(0,xt.splitIgluSchemaUrlParts)(e),r=typeof n<"u"&&n>0?"\u2705":"\u274C",a=Yi(n,i);return{name:o,isRequired:r,formattedCardinalityValues:a}}):[]}function Yi(t,e){return typeof t>"u"?"`any`":typeof e<"u"?t===e?`Exactly \`${t}\``:`Between \`${t}\` and \`${e}\``:`At least \`${t}\``}var In=require("fs"),En=require("path"),Pn=g(require("util"));function Cn(t,e,n,i){let o=e==="typescript"?"ts":"js";(0,In.writeFileSync)((0,En.resolve)(t,`validations.${o}`),`${o==="ts"?`
|
|
106
106
|
import { AnySchema } from "ajv";
|
|
107
107
|
export type CardinalityRule = { minCardinality?: number; maxCardinality?: number };
|
|
108
108
|
type IgluUrl = string;
|
|
109
109
|
type EventSpecificationId = string;
|
|
110
110
|
`:""}
|
|
111
|
-
export const entityRules${o==="ts"?": Record<EventSpecificationId, Record<IgluUrl, CardinalityRule>>":""} = ${
|
|
112
|
-
export const schemasObject${o==="ts"?": Record<IgluUrl | EventSpecificationId, AnySchema | Record<IgluUrl, AnySchema>>":""} = ${
|
|
111
|
+
export const entityRules${o==="ts"?": Record<EventSpecificationId, Record<IgluUrl, CardinalityRule>>":""} = ${wn(i)}
|
|
112
|
+
export const schemasObject${o==="ts"?": Record<IgluUrl | EventSpecificationId, AnySchema | Record<IgluUrl, AnySchema>>":""} = ${wn(n)}`,"utf-8")}function wn(t){return Pn.default.inspect(t,{showHidden:!1,depth:null,maxArrayLength:null})}function Kt(t){return Object.values(t).some(e=>Zi(e)?Qi(e):Kt(e))}function Zi(t){return typeof t=="object"&&t!==null&&Object.hasOwn(t,"$schema")}function Qi(t){return t.properties?Object.values(t.properties).some(e=>Object.hasOwn(e||{},"pattern")):!1}function xn(t,e){let n=eo(t);to(n,e)}function to(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 eo(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=g(require("fs/promises")),Dt=g(require("path")),An=require("yaml");async function Dn(t,e=[]){let n=[];for(let i of e){let o=Dt.default.resolve(t,i),r=await On(o),a=await no(r);n.push(...a)}return n}async function no(t){let e=[];for(let n of t){let{isJson:i}=bn(n),o=await At.default.readFile(n,{encoding:"utf-8"}),r=i?JSON.parse(o):(0,An.parse)(o);io(r)&&e.push(r.data)}return e}async function On(t,e=[]){let n=await At.default.readdir(t);for(let i of n){let o=Dt.default.join(t,i),r=await At.default.stat(o),{isJson:a,isYaml:s}=bn(i);r.isDirectory()?e=await On(o,e):(a||s)&&e.push(o)}return e}function io(t){return typeof t=="object"&&t!==null&&"apiVersion"in t&&typeof t.apiVersion=="string"&&"resourceType"in t&&t.resourceType==="data-structure"}function bn(t){let e=Dt.default.extname(t);return e.match(/\.yml|\.yaml/)?{isYaml:!0,isJson:!1}:e.match(".json")?{isYaml:!1,isJson:!0}:{isYaml:!1,isJson:!1}}var G=require("path"),qt=require("fs"),Xt=require("mkdirp"),kn=g(require("fs-extra"));function Tn({codeLines:t,outFilePath:e,language:n}){if(n==="java"){let i="// SNOWTYPE START: ",o="// SNOWTYPE END: ",r=(0,G.resolve)((0,G.dirname)(e),"com","snowplowanalytics","snowplow","snowtype");Xt.mkdirp.sync(r);let a="",s=!1,p="";for(let c of t)c===o+a&&((0,qt.writeFileSync)((0,G.resolve)(r,a),p),p="",s=!1),s&&(p+=c+`
|
|
113
113
|
`),c.startsWith(i)&&(a=c.slice(i.length),s=!0)}else{let i=t.join(`
|
|
114
|
-
`);(0,
|
|
115
|
-
`),{minify:r}=await import("terser"),a=await r(o,{mangle:!1,ecma:5});a.code?(console.warn(
|
|
116
|
-
`),await t.parseAsync(
|
|
114
|
+
`);(0,qt.writeFileSync)(e,i)}}function Fn(t){kn.default.removeSync((0,G.resolve)(t)),Xt.mkdirp.sync(t)}var Yt=require("path");var Ln=require("path"),Ot=require("fs-extra"),z=2e4,oo=({code:t,codeMinified:e})=>t.length>z&&e.length<=z?`Warning: The content exceeds the GTM limit of ${z} characters. Please use the minified version.`:e.length>z&&e.length>z?`Warning: The content exceeds the GTM limit of ${z} characters.`:"";async function $n({defaultFileName:t,outDir:e,codeLines:n}){let i=(0,Ln.resolve)(e,t+".minified.js"),o=n.join(`
|
|
115
|
+
`),{minify:r}=await import("terser"),a=await r(o,{mangle:!1,ecma:5});a.code?(console.warn(oo({code:o,codeMinified:a.code})),await(0,Ot.remove)(i),await(0,Ot.writeFile)(i,a.code)):console.error("Minification failed: Terser did not generate any code.")}async function ro(t){let{config:e,...n}=t,i=await U(e||process.cwd());return M(i),i.options.commands.generate={...i.options.commands.generate,...n},i}async function Y(t,e,n,i){let{dataProductIds:o,dataStructures:r,igluCentralSchemas:a,eventSpecificationIds:s,repositories:p,language:c,tracker:d,outpath:m,organizationId:y,namespace:f,options:{commands:{generate:l}}}=await ro(i),{configDir:v}=D(i.config||process.cwd()),L=I(r),E=I(a),H=I(s),Nn=I(o),Wn=I(p);L&&E&&H&&Nn&&Wn&&(e.warn("Data structures, schemas, and event specifications are empty."),e.warn("Code generation has been interrupted."),process.exit(1)),n.setSpinnerTitle("Generating..."),n.isSpinning()===!1&&n.start();let _n=un({configDataStructures:r,igluCentralSchemas:a,repositories:p,eventSpecificationIds:s,dataProductIds:o}),P=await A.create({...t,organizationId:y,enableSupportForNonDataProductsTier:_n});if(!await P.authenticate())throw new j;let Un=It(P,o),Gn=an([...Un,...s]),zn=Je(Gn,P,e),{eventSpecificationsWithId:$}=_e(P,zn,e),kt=Re($);l.deprecateOnlyOnProdAvailableUpdates&&(kt=await je(kt,P));let Hn=ze(P,$),Z=He(Hn,$);xn(Z,e);let{customEventSpecs:Bn,standardEventSpecs:Jn}=cn(Z),Kn=Jn.flatMap(Tt=>Tt.entities.map(ei=>ei.source));Se($)&&d==="@snowplow/browser-tracker"&&e.log("You are generating Snowplow Ecommerce events. You would need to install `@snowplow/browser-plugin-snowplow-ecommerce`."),l.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 qn=await Ue(a),Xn=Ke(r,P,e),ee=await Ge(P,[...Xn,...Kn]),Yn=await Dn(v,p),ne=!!(d==="@snowplow/browser-tracker"&&c.match(/javascript|typescript/));await sn(ee,Z,P,l.disallowDevSchemas);let Zn=[...Yn,...qn,...ee],ie={language:c,tracker:d,schemas:Zn,eventSpecifications:Bn,validations:ne&&l.validations,eventSpecificationsInputMetadata:kt,namespace:f},k=await(0,Rn.generate)(ie);if(n.stop(!0),!k)throw new Q;e.success("Code generated, writing...");let R=(0,Yt.resolve)(v,m),Qn=en(c),oe=Ft+Qn,ti=(0,Yt.resolve)(R,oe);if(Fn(R),Tn({codeLines:k.lines,outFilePath:ti,language:c}),ie.language==="javascript-gtm"&&await $n({defaultFileName:Ft,outDir:R,codeLines:k.lines}),nn($,R),ne&&l.validations&&k.validationsSchemaObject){let Tt=Be($);Cn(R,c,k.validationsSchemaObject,Tt),Kt(k.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")}l.instructions&&await yn(P,Z,k.lines,R,oe)}var Zt=O(Y,"generate");async function ao(t){let e=await U(t||process.cwd());return M(e),e}async function so(t,e,n,i){let o=await ao(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}=D(i.config||process.cwd()),d=(0,Vn.resolve)(c,o.outpath,lt),m=await A.create({...t,organizationId:o.organizationId});n.setSpinnerTitle("Checking for updates..."),n.isSpinning()===!1&&n.start();let y=It(m,o.dataProductIds),f=_([...o.eventSpecificationIds,...y]),l={};if(!Ut(d)&&f.length>0)throw new rt;if(Ut(d)&&f.length>0){let E=Qe(d);l=await Ce(m,f,E)}let v=await Pe(m,o.dataStructures,i.maximumBump||r,s);if((Object.entries(l).length>0||v.length>0)===!0){if(e.success("Available updates found!"),on(l,v,e),i.yes||a)return v.length>0&&(v.forEach(E=>{let H=o.dataStructures.indexOf(E.previous);o.dataStructures[H]=E.next}),Pt(o,i.config||process.cwd())),e.debug("Applying the updates.."),Y(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 Qt=O(so,"update");async function co(t){let{config:e,...n}=t;if(Object.values(n).every(o=>Array.isArray(o)&&o.length===0))throw new it;let i=await U(e||process.cwd());return M(i),{patchOptions:n,generateOptions:i.options.commands.generate,regenerateOnPatch:i.options.commands.patch.regenerateOnPatch}}async function po(t,e,n,i){let{isJSON:o,configPath:r}=D(i.config||process.cwd());if(o===!1)throw new at;let{patchOptions:a,generateOptions:s,regenerateOnPatch:p}=await co(i);return e.debug("Starting patch process with options: ".concat(JSON.stringify(a))),Object.entries(a).forEach(([d,m])=>{m.forEach(y=>{Ee(d,y,r)})}),e.success("Configuration patched"),p?Y(t,e,n,s):(e.log("Code is not generated yet for the patched configuration"),Promise.resolve(void 0))}var te=O(po,"patch");var bt=require("@snowplow/snowtype-core");async function Mn(){await import("dotenv/config");let t=new b.Command;t.exitOverride(),t.version(W,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(Ht),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(Qt),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(Zt),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(te),t.addHelpText("before",be()).addHelpText("after",`
|
|
116
|
+
`),await t.parseAsync(jn.argv).catch(e=>{uo(e)})}function uo(t){if(!(t instanceof b.CommanderError&&["commander.help","commander.version","commander.helpDisplayed"].indexOf(t.code)>-1))throw t}Mn().then(()=>{}).catch(()=>{process.exitCode=1});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@snowplow/snowtype",
|
|
3
|
-
"version": "0.15.
|
|
3
|
+
"version": "0.15.2",
|
|
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,15 +13,15 @@
|
|
|
13
13
|
],
|
|
14
14
|
"dependencies": {
|
|
15
15
|
"@commander-js/extra-typings": "^11.1.0",
|
|
16
|
-
"@inquirer/prompts": "^
|
|
17
|
-
"@snowplow/snowtype-core": "^0.15.
|
|
16
|
+
"@inquirer/prompts": "^8.2.0",
|
|
17
|
+
"@snowplow/snowtype-core": "^0.15.2",
|
|
18
18
|
"chalk": "^4.1.2",
|
|
19
19
|
"cli-spinner": "^0.2.10",
|
|
20
20
|
"dotenv": "^16.3.1",
|
|
21
21
|
"fs-extra": "^11.2.0",
|
|
22
22
|
"got": "^11",
|
|
23
23
|
"joi": "^17.6.0",
|
|
24
|
-
"js-sha256": "^0.
|
|
24
|
+
"js-sha256": "^0.11.1",
|
|
25
25
|
"lodash": "^4.17.21",
|
|
26
26
|
"mime-types": "^2.1.35",
|
|
27
27
|
"mkdirp": "^3.0.1",
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
"@types/mime-types": "^2.1.4",
|
|
42
42
|
"@types/node": "^20.9.0",
|
|
43
43
|
"cli-testing-library": "^2.0.2",
|
|
44
|
-
"esbuild": "^0.
|
|
44
|
+
"esbuild": "^0.27.2",
|
|
45
45
|
"jest": "^29.7.0",
|
|
46
46
|
"rimraf": "^5.0.5",
|
|
47
47
|
"ts-jest": "^29.1.1",
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
"test:e2e": "npm run build:production && jest e2e/"
|
|
66
66
|
},
|
|
67
67
|
"engines": {
|
|
68
|
-
"node": ">=
|
|
68
|
+
"node": ">=24.13.0"
|
|
69
69
|
},
|
|
70
70
|
"keywords": [
|
|
71
71
|
"snowplow",
|