@snowplow/snowtype 0.12.0 → 0.12.1

package/dist/index.js

@@ -1,5 +1,5 @@
 "use strict";var Hn=Object.create;var ae=Object.defineProperty;var zn=Object.getOwnPropertyDescriptor;var Bn=Object.getOwnPropertyNames;var Jn=Object.getPrototypeOf,Kn=Object.prototype.hasOwnProperty;var qn=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of Bn(e))!Kn.call(t,o)&&o!==n&&ae(t,o,{get:()=>e[o],enumerable:!(i=zn(e,o))||i.enumerable});return t};var f=(t,e,n)=>(n=t!=null?Hn(Jn(t)):{},qn(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var Ln=f(require("process")),b=require("@commander-js/extra-typings");var O=require("@inquirer/prompts");var Xn={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"},Yn="Please report a bug.",h=class extends Error{code;constructor(e,n=""){let i=Xn[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(Yn))}},R=class extends h{constructor(e,n){let i=`Value ${n} is an invalid ${e}.`;super("InvalidOption",i)}},it=class extends h{constructor(){super("MissingOptions")}},$=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 se=f(require("got"));async function ce({schema:t}){return(await(0,se.default)(`https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/${t.replace("iglu:","")}`)).body}var St=f(require("got"));var fe=require("js-sha256"),$t=f(require("assert"));var u=f(require("joi")),gt=require("@snowplow/snowtype-core");var Rt=f(require("assert"));var J="snowtype.config",pt=".js",ut=".ts",lt=".json",pe=Object.freeze([pt,ut,lt]),dt=".snowtype-lock.json",Lt="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"}]},ue={commands:{generate:{instructions:!1,validations:!1,disallowDevSchemas:!1,deprecateOnlyOnProdAvailableUpdates:!1},update:{maximumBump:"major",regenerateOnUpdate:!1,showOnlyProdUpdates:!1},patch:{regenerateOnPatch:!1}}},le=["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"],de="iglu:com.snowplowanalytics.snowplow.ecommerce";var mt=require("lodash");function me(t){let e=t.split("-");(0,Rt.default)(e.length===3,"invalid SchemaVer"),(0,Rt.default)(e.filter(n=>isNaN(parseInt(n))).length===0,"invalid SchemaVer")}function j(t){t.options=(0,mt.merge)((0,mt.cloneDeep)(ue),t.options||{})}var ge=new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$"),Zn=u.default.object().required().keys({tracker:u.default.string().required().valid(...gt.trackerTemplates),language:u.default.string().required().valid(...gt.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(ge)),repositories:u.default.array().optional().items(u.default.string()),dataStructures:u.default.array().optional().items(u.default.string().regex(ge)),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()})})})}),M=t=>{let e=Zn.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new et(e.error.annotate());return t};function Qn(t){let e=fe.sha256.create();return e.update(t),e.hex()}function ft(t,e){let{vendor:n,name:i,format:o}=I(t);return Qn(`${e}-${n}-${i}-${o}`)}function I(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 ht=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(`
-`);super(a),this.response={statusCode:n,body:r}}};function ye(t){return!!Object.hasOwn(t||{},"response")}var N="0.12.0";var P=class{apiKeyId;apiKey;organizationId;accessToken;apiUrl=process.env.SNOWPLOW_CONSOLE_API_URL||"https://console.snowplowanalytics.com/api/msc";constructor({apiKeyId:e,apiKey:n,organizationId:i}){this.apiKeyId=e,this.apiKey=n,this.organizationId=i}async fetchAccessToken(){if(this.accessToken)return this.accessToken;let e=`${this.apiUrl}/v1/organizations/${this.organizationId}/credentials/v3/token`,{accessToken:n}=await(0,St.default)(e,{headers:{"X-API-Key-Id":this.apiKeyId,"X-API-Key":this.apiKey,"X-Snowtype":N}}).json();return this.accessToken=n,n}async fetchResource(e){let n=await this.fetchAccessToken();try{return await(0,St.default)(e,{headers:{Authorization:"Bearer "+n,"X-Snowtype":N}}).json()}catch(i){throw ye(i)?new ht(i):i}}fetchSchemaVersion({schema:e,env:n="DEV"}){let{version:i}=I(e),o=ft(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=ft(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=ft(e,this.organizationId),o=25,r=[],a=!0,s=0,p=c=>`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/${i}/deployments?size=${o}&from=${c}${n?`&env=${n}`:""}`;for(;a;){let c=await this.fetchResource(p(s));s+=o,r=r.concat(c),c.length===0&&(a=!1)}return r}fetchEventSpecification({eventSpecificationId:e}){let n=`${this.apiUrl}/v1/organizations/${this.organizationId}/event-specs/v1/${e}`;return this.fetchResource(n)}async fetchImageVariant({imageId:e,imageVariant:n}){let i=`${this.apiUrl}/v1/organizations/${this.organizationId}/images/v1/${e}/${n}`,o=await this.fetchAccessToken();return(0,St.default)(i,{headers:{Authorization:"Bearer "+o,"X-Snowtype":N}})}fetchDataProduct({dataProductId:e}){let n=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-products/v2/${e}`;return this.fetchResource(n)}async authenticate(){try{return await this.fetchAccessToken(),!0}catch{return!1}}};var E=require("path"),y=require("fs");var Ut=f(require("util")),_t=require("tsx/cjs/api");var D=(()=>{let t="json";return{setFormat:i=>t=i,getFormat:()=>t}})();var xt=require("@snowplow/snowtype-core");var yt=require("fs");var vt=f(require("assert"));var we=require("semver");function Ie(t,e,n){try{let i=(0,yt.readFileSync)(n,{encoding:"utf-8"}),o=JSON.parse(i);return o[t].some(a=>a===e)||o[t].push(e),(0,yt.writeFileSync)(n,Nt(o)),!0}catch(i){return console.error(i),!1}}var ti=(t,e)=>{let{model:n,revision:i,addition:o}=q(t.version),{model:r,revision:a,addition:s}=q(e.version);return(0,vt.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 Ee(t,e,n,i){return(await Promise.all(e.map(async r=>{let{version:a}=I(r),s=await t.fetchDeployments({schema:r,...i&&{deploymentEnv:"PROD"}}),p=ei(s,a,n);p.sort(ti);let c=p.pop();if(!c)return null;let l={previous:r,next:he(r,{version:c.version}),nextEnv:c.env};return c.version!==a?{...l,nextReason:"version"}:c.patchLevel>0&&c.env==="DEV"?{...l,nextReason:"patch"}:null}))).flatMap(r=>r===null?[]:[r])}async function jt(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 xe(t,e,n){let{eventSpecifications:i}=n,o={};return await Promise.all(e.map(async r=>{let a=i[r];if(!a)return r;let s=(await t.fetchEventSpecification({eventSpecificationId:r})).data[0];(0,vt.default)(!!s,`failed to fetch event spec ${r}`),(0,vt.default)(!!s.version,`event spec with no version ${r}`);let p=[s.event?.source,...s.entities?.tracked?.map(l=>l.source)||[]].flatMap(l=>typeof l=="string"?[l]:[]),c=await jt(t,p);return(s.version||0)>a&&(o[r]={previous:a,next:s.version,devOnlySchema:c}),r})),o}function ei(t,e,n){return t.filter(i=>Mt(e,i.version)!==1).filter(i=>i.version!==e||i.patchLevel).map(i=>({...i,updateType:ve(i.version,e,i.patchLevel)})).filter(ni(n))}function ni(t){return({updateType:e})=>{switch(t){case"major":return!0;case"minor":return e==="patch"||e==="minor";case"patch":return e==="patch"}}}function Mt(t,e){let n=t.replaceAll("-","."),i=e.replaceAll("-",".");return(0,we.compare)(n,i)}var Ce=require("cli-spinner"),S=f(require("chalk"));function Ae(){let t=new Ce.Spinner;return t.setSpinnerString(18),t}var ii="https://snowplow.io",oi="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 Pe(t){return S.default.hex(Oe.LINK).bold(t)}function k(t){return S.default.hex(Oe.OPTION).italic(t)}function wt(t,e){switch(t){case"h1":return S.default.bold.underline(e);default:return S.default.bold(e)}}function be(){return`
+`);super(a),this.response={statusCode:n,body:r}}};function ye(t){return!!Object.hasOwn(t||{},"response")}var N="0.12.1";var P=class{apiKeyId;apiKey;organizationId;accessToken;apiUrl=process.env.SNOWPLOW_CONSOLE_API_URL||"https://console.snowplowanalytics.com/api/msc";constructor({apiKeyId:e,apiKey:n,organizationId:i}){this.apiKeyId=e,this.apiKey=n,this.organizationId=i}async fetchAccessToken(){if(this.accessToken)return this.accessToken;let e=`${this.apiUrl}/v1/organizations/${this.organizationId}/credentials/v3/token`,{accessToken:n}=await(0,St.default)(e,{headers:{"X-API-Key-Id":this.apiKeyId,"X-API-Key":this.apiKey,"X-Snowtype":N}}).json();return this.accessToken=n,n}async fetchResource(e){let n=await this.fetchAccessToken();try{return await(0,St.default)(e,{headers:{Authorization:"Bearer "+n,"X-Snowtype":N}}).json()}catch(i){throw ye(i)?new ht(i):i}}fetchSchemaVersion({schema:e,env:n="DEV"}){let{version:i}=I(e),o=ft(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=ft(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=ft(e,this.organizationId),o=25,r=[],a=!0,s=0,p=c=>`${this.apiUrl}/v1/organizations/${this.organizationId}/data-structures/v1/${i}/deployments?size=${o}&from=${c}${n?`&env=${n}`:""}`;for(;a;){let c=await this.fetchResource(p(s));s+=o,r=r.concat(c),c.length===0&&(a=!1)}return r}fetchEventSpecification({eventSpecificationId:e}){let n=`${this.apiUrl}/v1/organizations/${this.organizationId}/event-specs/v1/${e}`;return this.fetchResource(n)}async fetchImageVariant({imageId:e,imageVariant:n}){let i=`${this.apiUrl}/v1/organizations/${this.organizationId}/images/v1/${e}/${n}`,o=await this.fetchAccessToken();return(0,St.default)(i,{headers:{Authorization:"Bearer "+o,"X-Snowtype":N}})}fetchDataProduct({dataProductId:e}){let n=`${this.apiUrl}/v1/organizations/${this.organizationId}/data-products/v2/${e}`;return this.fetchResource(n)}async authenticate(){try{return await this.fetchAccessToken(),!0}catch{return!1}}};var E=require("path"),y=require("fs");var Ut=f(require("util")),_t=require("tsx/cjs/api");var D=(()=>{let t="json";return{setFormat:i=>t=i,getFormat:()=>t}})();var xt=require("@snowplow/snowtype-core");var yt=require("fs");var vt=f(require("assert"));var we=require("semver");function Ie(t,e,n){try{let i=(0,yt.readFileSync)(n,{encoding:"utf-8"}),o=JSON.parse(i);return o[t].some(a=>a===e)||o[t].push(e),(0,yt.writeFileSync)(n,Nt(o)),!0}catch(i){return console.error(i),!1}}var ti=(t,e)=>{let{model:n,revision:i,addition:o}=q(t.version),{model:r,revision:a,addition:s}=q(e.version);return(0,vt.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 Ee(t,e,n,i){return(await Promise.all(e.map(async r=>{let{version:a}=I(r),s=await t.fetchDeployments({schema:r,...i&&{deploymentEnv:"PROD"}}),p=ei(s,a,n);p.sort(ti);let c=p.pop();if(!c)return null;let l={previous:r,next:he(r,{version:c.version}),nextEnv:c.env};return c.version!==a?{...l,nextReason:"version"}:c.patchLevel>0&&c.env==="DEV"?{...l,nextReason:"patch"}:null}))).flatMap(r=>r===null?[]:[r])}async function jt(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 xe(t,e,n){let{eventSpecifications:i}=n,o={};return await Promise.all(e.map(async r=>{let a=i[r];if(!a)return r;let s=(await t.fetchEventSpecification({eventSpecificationId:r})).data[0];(0,vt.default)(!!s,`failed to fetch event spec ${r}`),(0,vt.default)(!!s.version,`event spec with no version ${r}`);let p=[s.event?.source,...s.entities?.tracked?.map(l=>l.source)||[]].flatMap(l=>typeof l=="string"?[l]:[]),c=await jt(t,p);return(s.version||0)>a&&(o[r]={previous:a,next:s.version,devOnlySchema:c}),r})),o}function ei(t,e,n){return t.filter(i=>Mt(e,i.version)!==1).filter(i=>i.version!==e||i.patchLevel).map(i=>({...i,updateType:ve(i.version,e,i.patchLevel)})).filter(ni(n))}function ni(t){return({updateType:e})=>{switch(t){case"major":return!0;case"minor":return e==="patch"||e==="minor";case"patch":return e==="patch"}}}function Mt(t,e){let n=t.replaceAll("-","."),i=e.replaceAll("-",".");return(0,we.compare)(n,i)}var Ce=require("cli-spinner"),S=f(require("chalk"));function Ae(){let t=new Ce.Spinner;return t.setSpinnerString(18),t}var ii="https://snowplow.io",oi="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 Pe(t){return S.default.hex(Oe.LINK).bold(t)}function k(t){return S.default.hex(Oe.OPTION).italic(t)}function wt(t,e){switch(t){case"h1":return S.default.bold.underline(e);default:return S.default.bold(e)}}function be(){return`
 ${wt("h1","CLI Help")}
 
   For more information visit the Snowplow website ${Pe(ii)}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snowplow/snowtype",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "description": "A code generator CLI for faster and type-safe Snowplow tracking code",
   "author": "Peter Perlepes <peter@snowplowanalytics.com>",
   "homepage": "https://snowplow.io/",
@@ -14,7 +14,7 @@
   "dependencies": {
     "@commander-js/extra-typings": "^11.1.0",
     "@inquirer/prompts": "^3.3.0",
-    "@snowplow/snowtype-core": "^0.12.0",
+    "@snowplow/snowtype-core": "^0.12.1",
     "chalk": "^4.1.2",
     "cli-spinner": "^0.2.10",
     "dotenv": "^16.3.1",