@snowplow/snowtype 0.13.2 → 0.13.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/README.md +11 -4
- package/dist/index.js +45 -45
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -23,15 +23,22 @@ Useful scripts:
|
|
|
23
23
|
Add a `.env` file in the `packages/cli` folder with the following content:
|
|
24
24
|
|
|
25
25
|
```bash
|
|
26
|
-
SNOWPLOW_CONSOLE_API_KEY_ID=YOUR_KEY_ID_HERE
|
|
27
|
-
SNOWPLOW_CONSOLE_API_KEY=YOUR_KEY_HERE
|
|
28
|
-
|
|
26
|
+
export SNOWPLOW_CONSOLE_API_KEY_ID=YOUR_KEY_ID_HERE
|
|
27
|
+
export SNOWPLOW_CONSOLE_API_KEY=YOUR_KEY_HERE
|
|
28
|
+
export SNOWPLOW_CONSOLE_ORG_ID=YOUR_ORG_ID_HERE
|
|
29
|
+
export SNOWPLOW_CONSOLE_API_URL=https://next.console.snowplowanalytics.com/api/msc
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
If you are testing against production locally, make sure to set it up correctly:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
export SNOWPLOW_CONSOLE_API_URL=https://console.snowplowanalytics.com/api/msc
|
|
29
36
|
```
|
|
30
37
|
|
|
31
38
|
Then use:
|
|
32
39
|
|
|
33
40
|
```bash
|
|
34
|
-
npm run snowtype init
|
|
41
|
+
npm run snowtype -- init
|
|
35
42
|
```
|
|
36
43
|
|
|
37
44
|
to initialize the project.
|
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 ae=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&&ae(t,o,{get:()=>e[o],enumerable:!(i=ii(e,o))||i.enumerable});return t};var f=(t,e,n)=>(n=t!=null?ni(ri(t)):{},si(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var Mn=f(require("process")),k=require("@commander-js/extra-typings");var b=require("@inquirer/prompts");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}},tt=class extends h{constructor(){super("GenerationFailed")}},J=class extends h{constructor(){super("ConfigAlreadyExists")}},et=class extends h{constructor(){super("ConfigNotExists")}},nt=class extends h{constructor(e){super("ConfigInvalid",e)}},it=class extends h{constructor(e){super("InternalError",e.concat(pi))}},j=class extends h{constructor(e,n){let i=`Value ${n} is an invalid ${e}.`;super("InvalidOption",i)}},ot=class extends h{constructor(){super("MissingOptions")}},M=class extends h{constructor(){super("AuthError")}},rt=class extends h{constructor(){super("WriteLockFile")}},at=class extends h{constructor(){super("MissingLockFile")}},st=class extends h{constructor(){super("PatchingNotSupported")}},ct=class extends h{constructor(){super("DevNotAllowed")}},pt=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"),Rt=f(require("assert"));var u=f(require("joi")),gt=require("@snowplow/snowtype-core");var $t=f(require("assert"));var K="snowtype.config",ut=".js",dt=".ts",lt=".json",pe=Object.freeze([ut,dt,lt]),mt=".snowtype-lock.json",Lt="snowplow";var q={"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}}},de=["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"],le="iglu:com.snowplowanalytics.snowplow.ecommerce";var ft=require("lodash");function ge(t){let e=t.split("-");(0,$t.default)(e.length===3,"invalid SchemaVer"),(0,$t.default)(e.filter(n=>isNaN(parseInt(n))).length===0,"invalid SchemaVer")}function N(t){t.options=(0,ft.merge)((0,ft.cloneDeep)(ue),t.options||{})}var me=new RegExp("^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/[0-9]+-[0-9]+-[0-9]+$"),ui=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(me)),repositories:u.default.array().optional().items(u.default.string()),dataStructures:u.default.array().optional().items(u.default.string().regex(me)),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()})})})}),W=t=>{let e=ui.validate(t,{abortEarly:!1,convert:!1});if(e.error)throw new nt(e.error.annotate());return t};function di(t){let e=fe.sha256.create();return e.update(t),e.hex()}function he(t,e){let{vendor:n,name:i,format:o}=x(t);return di(`${e}-${n}-${i}-${o}`)}function x(t){let e=t.replace("iglu:",""),[n,i,o,r]=e.split("/");return(0,Rt.default)(typeof n=="string"&&typeof i=="string"&&typeof o=="string"&&typeof r=="string",`invalid iglu uri ${t}`),ge(r),{vendor:n,name:i,format:o,version:r}}function Se(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 ve(t){return t.some(e=>e.eventSchema.isEcomTemplateSchema)}function X(t){let[e,n,i]=t.split("-").map(o=>parseInt(o));return{model:e,revision:n,addition:i}}function ye(t,e,n=0){if(t===e&&n!==0)return"patch";let{model:i,revision:o,addition:r}=X(t),{model:a,revision:s,addition:p}=X(e);if(i!==a)return"major";if(o!==s)return"minor";if(r!==p)return"patch";(0,Rt.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(`
|
|
2
|
+
`);super(a),this.response={statusCode:n,body:r}}};function we(t){return!!Object.hasOwn(t||{},"response")}var _="0.13.3";var Ie=f(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,Ie.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,St.default)(e,{headers:{"X-API-Key-Id":this.apiKeyId,"X-API-Key":this.apiKey,"X-Snowtype":_}}).json();return this.accessToken=n,n}fetchResource(e){return this.pLimit(async()=>{try{let n=await this.fetchAccessToken();return await(0,St.default)(e,{headers:{Authorization:"Bearer "+n,"X-Snowtype":_}}).json()}catch(n){throw we(n)?new ht(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=he(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,St.default)(i,{headers:{Authorization:"Bearer "+o,"X-Snowtype":_}})}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"),y=require("fs");var _t=f(require("util")),Ut=require("tsx/cjs/api");var F=(()=>{let t="json";return{setFormat:i=>t=i,getFormat:()=>t}})();var Pt=require("@snowplow/snowtype-core");var yt=require("fs");var vt=f(require("assert"));var Ee=require("semver");function Pe(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,Mt(o)),!0}catch(i){return console.error(i),!1}}var li=(t,e)=>{let{model:n,revision:i,addition:o}=X(t.version),{model:r,revision:a,addition:s}=X(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 Ce(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=mi(s,a,n);p.sort(li);let c=p.pop();if(!c)return null;let d={previous:r,next:Se(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 Vt(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 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=t.getEventSpecificationById(r).data;(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(d=>d.source)||[]].flatMap(d=>typeof d=="string"?[d]:[]),c=await Vt(t,p);return(s.version||0)>a&&(o[r]={previous:a,next:s.version,devOnlySchema:c}),r})),o}function mi(t,e,n){return t.filter(i=>jt(e,i.version)!==1).filter(i=>i.version!==e||i.patchLevel).map(i=>({...i,updateType:ye(i.version,e,i.patchLevel)})).filter(gi(n))}function gi(t){return({updateType:e})=>{switch(t){case"major":return!0;case"minor":return e==="patch"||e==="minor";case"patch":return e==="patch"}}}function jt(t,e){let n=t.replaceAll("-","."),i=e.replaceAll("-",".");return(0,Ee.compare)(n,i)}var De=require("cli-spinner"),S=f(require("chalk"));function Oe(){let t=new De.Spinner;return t.setSpinnerString(18),t}var fi="https://snowplow.io",hi="https://docs.snowplow.io/docs/collecting-data/code-generation/",Y={SUCCESS:"\u2714",LOG:"\u2139",DEBUG:"\u27A4",ERROR:"\u2717",WARN:"\u26A0"},be={LINK:"#9911BB",OPTION:"#9911DD"};function Ae(t){return S.default.hex(be.LINK).bold(t)}function L(t){return S.default.hex(be.OPTION).italic(t)}function wt(t,e){switch(t){case"h1":return S.default.bold.underline(e);default:return S.default.bold(e)}}function ke(){return`
|
|
3
|
+
${wt("h1","CLI Help")}
|
|
4
4
|
|
|
5
|
-
For more information visit the Snowplow website ${
|
|
5
|
+
For more information visit the Snowplow website ${Ae(fi)}
|
|
6
6
|
|
|
7
|
-
For details see the CLI documentation ${
|
|
7
|
+
For details see the CLI documentation ${Ae(hi)}
|
|
8
8
|
|
|
9
|
-
${
|
|
10
|
-
1. Use ${
|
|
11
|
-
2. Use ${
|
|
12
|
-
3. Use ${
|
|
9
|
+
${wt("h2","How to get started")}
|
|
10
|
+
1. Use ${S.default.cyanBright("snowtype init")} to initialize the setup.
|
|
11
|
+
2. Use ${S.default.cyanBright("snowtype patch")} to add a Data Structure or Event Specification.
|
|
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
|
+
${wt("h2","Available commands")}
|
|
15
|
+
To learn more about each CLI command, use the ${L("--help")} option, for example, ${L("snowtype init --help")}.
|
|
16
16
|
|
|
17
|
-
${
|
|
17
|
+
${L("snowtype init")}
|
|
18
18
|
Initialize the setup of Snowtype code generation in a project. Creates the \`snowtype.config.json\` file.
|
|
19
19
|
|
|
20
|
-
${
|
|
20
|
+
${L("snowtype patch")}
|
|
21
21
|
Adds new Data Structures and Event Specifications in the \`snowtype.config.json\` file.
|
|
22
22
|
|
|
23
|
-
${
|
|
23
|
+
${L("snowtype generate")}
|
|
24
24
|
Generates tracking code based on configuration on the \`snowtype.config.json\` file.
|
|
25
25
|
|
|
26
|
-
${
|
|
26
|
+
${L("snowtype update")}
|
|
27
27
|
Checks for latest version updates in Data Structures and Event Specifications.
|
|
28
28
|
|
|
29
|
-
${
|
|
30
|
-
Use the ${
|
|
31
|
-
`}function
|
|
32
|
-
${
|
|
33
|
-
${
|
|
34
|
-
`}var We=
|
|
29
|
+
${wt("h2","Debug")}
|
|
30
|
+
Use the ${L("-v")} to output verbose logs
|
|
31
|
+
`}function Te(t){let e=`${Y.SUCCESS}: `;return S.default.cyanBright(e)+t}function It(t){let e=`${Y.WARN} Warning: `;return S.default.hex("#FFA500")(e)+t}function Fe(t){let e=`${Y.LOG} ${t}`;return S.default.yellowBright(e)}function Le(t){let e=`${Y.DEBUG} Debug: `;return S.default.magenta(e)+t}function $e(t){let e=`${Y.ERROR} Error: `;return S.default.redBright(e)+t}function Re(t,e){let n=`- ${t}`,i=`+ ${e}`;return`
|
|
32
|
+
${S.default.magenta(n)}
|
|
33
|
+
${S.default.cyanBright(i)}
|
|
34
|
+
`}var We=f(require("mime-types"));var Ve=t=>{let e={outdatedDsWarnings:[],hiddenDsWarnings:[],metrics:[]};return t.reduce((n,i)=>Si({currentMetadata:n,eventSpecificationId:i.eventSpecification.id,newMetadata:i.metadata||e}),{})};function Si({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 je=t=>(e,n)=>{vi(e,n||"").forEach(t.warn)};function vi(t,e){let n=yi(t.outdatedDsWarnings,e),i=wi(t.hiddenDsWarnings,e);return n.concat(i)}function yi(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 wi(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 Me(t,e){let n=Ei(t),i=await Promise.all(n.map(async r=>({schema:r,deployments:await e.fetchDeployments({schema:r,deploymentEnv:"PROD"})}))),o=Ii(i);return Pi(t,o)}var Ii=t=>t.flatMap(({schema:e,deployments:n})=>{let{version:i}=x(e);return n.filter(r=>jt(i,r.version)===-1).length===0?[]:[e]}),Ei=t=>U(Object.entries(t).filter(([,e])=>e.outdatedDsWarnings.length!==0).flatMap(([,e])=>e.outdatedDsWarnings.flatMap(n=>n.sources.map(i=>i.source)))),Pi=(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 Et(t,e){return e.map(i=>t.getDataProductById(i)).flatMap(({data:[i]})=>i?i.eventSpecs:[]).map(i=>i.id)}function Ci(t){let{original:e}=t,[n,i]=e.split("/").reverse();return{imageVariant:n,imageId:i}}async function _e(t,e){let n=[];if(!(e&&e.length))return[];for(let i of e){let{description:o,appIds:r,url:a,variantUrls:s}=i,p={description:o,appIds:r,url:a};if(s){let{imageVariant:c,imageId:d}=Ci(s),g=await t.fetchImageVariant({imageId:d,imageVariant:c});p.imageBuffer=g.rawBody,p.imageExtension=We.default.extension(g.headers["content-type"])||""}n.push(p)}return n}function Ue(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&&je(n)(r.metadata,a.dataProductId);let p=Nt(a.event.source);p&&n.warn("Currently code will not be generated for `Standard` events. Skipping...");let c=a.triggers,d=a.name,g=a.version,w=a.sourceApplications||[],m=a.event.schema,l=p?Ai(a.event.source):Ne(t,a,a.event.source),v=a.entities?.tracked||[],$=v.map(({source:E,schema:B})=>({original:Ne(t,a,E),propertyRule:B}));return{eventSpecification:{name:d||"",id:o,dataProductId:a.dataProductId||"",dataProductName:"",dataProductDomain:""},version:g||0,eventSchema:l,entitiesSchemas:$,entities:v,triggers:c,propertyRules:m,sourceApplicationIds:w,metadata:r.metadata}}).flat()}}async function Ge(t){return await Promise.all(t.map(async n=>JSON.parse(await ce({schema:n}))))}async function ze(t,e){return await Promise.all(e.map(i=>t.getSchemaVersion({schema:i})))}function He(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(xi)}function Be(t,e){let n=t.reduce((o,r)=>(o[r.id]={...r},o),{});return e.map(o=>{let r=n[o.eventSpecification.dataProductId],a=o.sourceApplicationIds.flatMap(s=>r?.sourceApplications.find(p=>p.id===s)||[]);return{...o,eventSpecification:{...o.eventSpecification,dataProductName:r?.name||"",dataProductDomain:r?.domain||""},sourceApplications:a}})}function xi(t){return!!t}function Ne(t,e,n){let i=e.event?.schema?.properties?.type?.enum?.[0];return n.match(le)?{self:x(n),isEcomTemplateSchema:i}:t.getSchemaVersion({schema:n})}function Je(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 Ai(t){return{self:{...x(t)}}}function Ke(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 qe(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 Di="SNOWPLOW_CONSOLE_API_KEY_ID",Oi="SNOWPLOW_CONSOLE_API_KEY";function Ze(t){return t.length!==0}function Mt(t){return JSON.stringify(t,null,2)}function Qe(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 bi(t){switch(t){case"typescript":return`${K}${dt}`;case"javascript":return`${K}${ut}`;case"json":return`${K}${lt}`;default:return""}}var Xe=t=>(0,y.existsSync)(t)&&!(0,y.lstatSync)(t).isDirectory(),ki=t=>K+t,Ti=t=>({isTS:t.endsWith(dt),isJSON:t.endsWith(lt),isJS:t.endsWith(ut)}),Wt=t=>({configDir:(0,C.dirname)(t),configPath:t,...Ti(t)});function D(t){let e=(0,C.isAbsolute)(t)?t:(0,C.resolve)(process.cwd(),t);if(Xe(e))return Wt(e);if(!(0,y.existsSync)(e))throw new Error(`Can't find a root directory while resolving a config file path.
|
|
39
39
|
Provided path to resolve: ${t}
|
|
40
|
-
cwd: ${process.cwd()}`);let[n]=
|
|
41
|
-
`,a='import { SnowtypeConfig } from "@snowplow/snowtype/types";',s=`const config: SnowtypeConfig = ${
|
|
42
|
-
`,p="module.exports = config;",c="export default config;";return n==="json"?(0,y.writeFileSync)(o,
|
|
43
|
-
`))}function
|
|
44
|
-
`,
|
|
40
|
+
cwd: ${process.cwd()}`);let[n]=pe.map(i=>(0,C.resolve)(e,ki(i))).filter(Xe);return Wt(typeof n!="string"?e:n)}function Ct(t,e){let n=F.getFormat(),i=bi(n),o=(0,C.resolve)(e,i),r=`const config = ${_t.default.inspect(t,!1,null)}
|
|
41
|
+
`,a='import { SnowtypeConfig } from "@snowplow/snowtype/types";',s=`const config: SnowtypeConfig = ${_t.default.inspect(t,!1,null)}
|
|
42
|
+
`,p="module.exports = config;",c="export default config;";return n==="json"?(0,y.writeFileSync)(o,Mt(t)):(0,y.writeFileSync)(o,(n==="typescript"?[a,s,c]:[r,p]).join(`
|
|
43
|
+
`))}function Gt(t){let e=(0,y.statSync)(t,{throwIfNoEntry:!1});return e===void 0?!1:e.isFile()}function zt(t){return(0,y.readFileSync)(t,{encoding:"utf-8"})}var Fi=async t=>(await(0,Ut.require)(t,__filename)).default;async function G(t){let{configPath:e,isJS:n,isJSON:i,isTS:o}=D(t),r;return o?(r=await Fi(e),F.setFormat("typescript")):n?(r=(await import(e)).default,F.setFormat("javascript")):i&&(r=JSON.parse(zt(e)),F.setFormat("json")),typeof r=="function"&&(r=await r()),r}function tn(t){return JSON.parse(zt(t))}async function en(t,e){t.debug("Checking for existing configuration.."),await Ht(!0,e),t.success("Valid configuration found")}async function Ht(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,Ut.require)(n,__filename)).default:i?p=(await import(n)).default:o&&(p=JSON.parse(zt(n))),typeof p=="function"&&(p=await p()),t){if(s)throw new et;W(p)}else if(a)try{throw W(p),new J}catch(c){if(c instanceof J)throw c}}function nn(t){return{javascript:".js","javascript-gtm":".js",typescript:".ts",kotlin:".kt",swift:".swift",go:".go",dart:".dart",java:".java"}[t]||""}function on(t,e){let n={eventSpecifications:{}};t.forEach(o=>{n.eventSpecifications[o.eventSpecification.id]=o.version});let i=(0,C.resolve)(e,mt);try{(0,y.writeFileSync)(i,JSON.stringify(n,null,2))}catch{throw new rt}}function rn(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 an(t){let e=t.optsWithGlobals();return{...e,apiKeyId:e.apiKeyId||process.env[Di],apiKey:e.apiKey||process.env[Oi]}}function I(t){return!!(Array.isArray(t)&&!t.length)}function U(t){return[...new Set(t)]}function sn(t){let e=U(t);return e.sort(),e}function Li(t){return t.flatMap(e=>{let n=(0,Pt.joinIgluSchemaUrlParts)(e.eventSchema.self),i=e.entities.map(o=>o.source);return[n,...i]})}async function cn(t,e,n,i){let o=t.map(s=>(0,Pt.joinIgluSchemaUrlParts)(s.self)),r=Li(e),a=await Vt(n,U([...o,...r]));if(a.length>0&&(console.log(`
|
|
44
|
+
`,It(`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 ct}function Nt(t){return de.includes(t)}function Ye({self:t}){let e=(0,Pt.joinIgluSchemaUrlParts)(t);return Nt(e)}function pn(t){return{standardEventSpecs:t.filter(e=>Ye(e.eventSchema)),customEventSpecs:t.filter(e=>!Ye(e.eventSchema))}}function un(t,e,n){if(typeof t=="string"&&typeof e=="string"&&t&&e)return{apiKeyId:t,apiKey:e};throw n.error(new pt),new Error}function dn(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 $i=["javascript","json","typescript"];function ln(t){return t in q}function mn(t,e){let n=q[t];return Array.isArray(n)?n.map(o=>o.value).includes(e):!1}function gn(t){return $i.includes(t)}function fn(){return{withVerbosity:e=>({success:i=>{console.log(Te(i))},warn:i=>{console.log(It(i))},log:i=>{console.log(Fe(i))},diff:(i,o)=>{console.log(Re(i,o))},debug:i=>{e===!0&&console.log(Le(JSON.stringify(i)))},error:i=>{console.log($e(i.message)),e===!0&&console.log(i)}})}}function O(t,e){return async(n,i)=>{let o=an(i),r=fn(),a=Oe(),s=r.withVerbosity(o.verbose),{apiKeyId:p,apiKey:c}=un(o.apiKeyId,o.apiKey,s);if(e!=="init")try{let d=n.config||process.cwd();await en(s,d)}catch(d){hn(d,s,a)}return t({apiKeyId:p,apiKey:c},s,a,n).then(()=>Sn(a)).catch(d=>{hn(d,s,a)})}}function hn(t,e,n){throw Sn(n),e.error(t),t}function Sn(t){t.isSpinning()===!0&&t.stop(!0)}var Ri={type:"password",message:"Enter your Snowplow organization ID:",mask:!0,validate:Ze},Vi={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"}]},ji={type:"select",message:"Select the format to use:",choices:[{value:"javascript",name:"JavaScript"},{value:"typescript",name:"TypeScript"},{value:"json",name:"JSON"}]},Mi={type:"input",message:"Enter the directory for Snowtype output:",default:"./snowtype"},Ni=t=>({type:"select",message:"Select the language to use:",choices:t});async function Wi(t,e){e.debug("Checking for existing configuration file.."),await Ht(!1,process.cwd());let n=t.organizationId||await(0,b.password)(Ri),i=t.tracker||await(0,b.select)(Vi);if(!ln(i))throw new j("tracker",i);let o=q[i],r;if(o.length===1){let p=o[0];if(typeof p>"u")throw new it("Missing language entry.");r=p.value}else r=t.language||await(0,b.select)(Ni(o));if(!mn(i,r))throw new j("language",r);let a=await(0,b.select)(ji);if(!gn(a))throw new j("format",a);F.setFormat(a);let s=t.outpath||await(0,b.input)(Mi);return e.debug("Assembling initialization options.."),{organizationId:n,tracker:i,language:r,format:a,outpath:s}}async function _i(t,e,n,i){let o=await Wi(i,e);n.setSpinnerTitle("Initialising..."),n.isSpinning()===!1&&n.start(),e.debug("Creating configuration with options: ".concat(JSON.stringify(o)));let r=Qe(o);if(W(r),!await A.createLazy({...t,organizationId:r.organizationId}).authenticate())throw new M;e.success("Authentication succeeded"),Ct(r,process.cwd()),e.success("Configuration created")}var Bt=O(_i,"init");var jn=require("path");var Vn=require("@snowplow/snowtype-core");var xt=require("path"),vn=require("mkdirp"),Kt=require("fs"),At=require("@snowplow/snowtype-core");var Ui="instructions.md",yn="assets";async function wn(t,e,n,i,o){vn.mkdirp.sync((0,xt.resolve)(i,yn));let r=[],a=Bi(e,n,o),s=[];await Promise.all(e.map(async c=>{let d={triggers:await _e(t,c.triggers),instructionsHeading:Jt(c.eventSpecification.name)};s.push(Jt(c.eventSpecification.name));let g=Ki(c.propertyRules),w=qi(c.entities);zi(c.eventSpecification.id,d,i),r.push(Gi({eventStructure:c.eventSchema.self,entitiesStructures:c.entitiesSchemas?.map(m=>m.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:g,formattedCardinalityRules:w,organizationId:t.organizationId,sourceApplications:c.sourceApplications,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,19 +55,19 @@ ${s.map(c=>`- [${c.instructionsTitle}](#${c.instructionsLink})`).join(`
|
|
|
55
55
|
|
|
56
56
|
${r.join(`
|
|
57
57
|
`)}
|
|
58
|
-
`;(0,
|
|
59
|
-
## [${
|
|
58
|
+
`;(0,Kt.writeFileSync)((0,xt.resolve)(i,Ui),p,"utf-8")}function Gi({eventStructure:t,entitiesStructures:e,name:n,id:i,dataProductId:o,version:r,triggerInstructions:a,linkToCode:s,formattedPropertyRules:p,formattedCardinalityRules:c,organizationId:d,sourceApplications:g,dataProductDomain:w}){let m="_N/A_";return`
|
|
59
|
+
## [${Jt(n).instructionsTitle}](${Hi(d,o,i)})
|
|
60
60
|
|
|
61
61
|
| | |
|
|
62
62
|
| ----------- | ----------- |
|
|
63
63
|
| **Id** | ${i} |
|
|
64
64
|
| **Version** | ${r} |
|
|
65
65
|
| **Data Product Id** | ${o} |
|
|
66
|
-
| **Source Application/s** | ${
|
|
66
|
+
| **Source Application/s** | ${g.length?g.map(l=>l.name).join(", "):"None selected"} |
|
|
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** | ${w.length>0?w:
|
|
70
|
+
| **Data Product Domain** | ${w.length>0?w:m} |
|
|
71
71
|
|
|
72
72
|
${p.length>0?`### Implementation Instructions for ${t.name} event properties
|
|
73
73
|
|
|
@@ -85,32 +85,32 @@ ${c.map(l=>Object.values(l).join(" | ")).join(`
|
|
|
85
85
|
`)}
|
|
86
86
|
`:""}
|
|
87
87
|
|
|
88
|
-
${a.map((l,
|
|
89
|
-
### Trigger ${
|
|
88
|
+
${a.map((l,v,$)=>`
|
|
89
|
+
### Trigger ${$.length!==1?v+1:""}
|
|
90
90
|
|
|
91
91
|
#### Screenshot
|
|
92
|
-
${l.imageBuffer?`[<img src="./assets/${i}_${
|
|
92
|
+
${l.imageBuffer?`[<img src="./assets/${i}_${v}.${l.imageExtension}" width="550"/>](./assets/${i}_${v}.${l.imageExtension})`:m}
|
|
93
93
|
|
|
94
94
|
#### In which application(s) does this trigger apply?
|
|
95
95
|
|
|
96
|
-
${l.appIds&&l.appIds.length?l.appIds.map(
|
|
96
|
+
${l.appIds&&l.appIds.length?l.appIds.map(E=>"`"+E+"` "):m}
|
|
97
97
|
|
|
98
98
|
#### The URL of the page on which this event specification triggers:
|
|
99
99
|
|
|
100
|
-
${l.url||
|
|
100
|
+
${l.url||m}
|
|
101
101
|
|
|
102
102
|
#### Notes
|
|
103
103
|
|
|
104
|
-
${l.description||
|
|
105
|
-
`).join("")}`}function
|
|
104
|
+
${l.description||m}
|
|
105
|
+
`).join("")}`}function zi(t,e,n){e.triggers.forEach((i,o)=>{i.imageBuffer&&(0,Kt.writeFileSync)((0,xt.resolve)(n,yn,t+"_"+o+"."+i.imageExtension),i.imageBuffer,"binary")})}function Hi(t,e,n){return`https://console.snowplowanalytics.com/${t}/data-products/${e}/event-specifications/${n}`}function Bi(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,At.createEventSpecificationInstructionsIdentifier)(o)));i[o]=r!==-1?`[Link](./${n+"#L"+r})`:"N/A"}),i}function Jt(t){let e=t;return{instructionsTitle:e,instructionsLink:Ji(e)}}function Ji(t){return t.toLowerCase().replace(/[^a-z\d\s-]/g," ").replace(/\s+/g," ").trim().replace(/-{2,}|\s/g,"-")}function Ki(t){return t?Object.entries(t.properties||{}).map(e=>{let[n,i]=e,o=t.required?.includes(n)?"\u2705":"\u274C",r=i.description||"-",a=i.enum?i.enum.map(s=>`\`${s}\``).join(" or "):"-";return{name:n,isRequired:o,description:r,expectedValues:a}}):[]}function qi(t){return t?t.map(({source:e,minCardinality:n,maxCardinality:i})=>{let{name:o}=(0,At.splitIgluSchemaUrlParts)(e),r=typeof n<"u"&&n>0?"\u2705":"\u274C",a=Xi(n,i);return{name:o,isRequired:r,formattedCardinalityValues:a}}):[]}function Xi(t,e){return typeof t>"u"?"`any`":typeof e<"u"?t===e?`Exactly \`${t}\``:`Between \`${t}\` and \`${e}\``:`At least \`${t}\``}var En=require("fs"),Pn=require("path"),Cn=f(require("util"));function xn(t,e,n,i){let o=e==="typescript"?"ts":"js";(0,En.writeFileSync)((0,Pn.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>>":""} = ${In(i)}
|
|
112
|
+
export const schemasObject${o==="ts"?": Record<IgluUrl | EventSpecificationId, AnySchema | Record<IgluUrl, AnySchema>>":""} = ${In(n)}`,"utf-8")}function In(t){return Cn.default.inspect(t,{showHidden:!1,depth:null,maxArrayLength:null})}function qt(t){return Object.values(t).some(e=>Yi(e)?Zi(e):qt(e))}function Yi(t){return typeof t=="object"&&t!==null&&Object.hasOwn(t,"$schema")}function Zi(t){return t.properties?Object.values(t.properties).some(e=>Object.hasOwn(e||{},"pattern")):!1}function An(t,e){let n=to(t);Qi(n,e)}function Qi(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 to(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 Dt=f(require("fs/promises")),Ot=f(require("path")),Dn=require("yaml");async function On(t,e=[]){let n=[];for(let i of e){let o=Ot.default.resolve(t,i),r=await bn(o),a=await eo(r);n.push(...a)}return n}async function eo(t){let e=[];for(let n of t){let{isJson:i}=kn(n),o=await Dt.default.readFile(n,{encoding:"utf-8"}),r=i?JSON.parse(o):(0,Dn.parse)(o);no(r)&&e.push(r.data)}return e}async function bn(t,e=[]){let n=await Dt.default.readdir(t);for(let i of n){let o=Ot.default.join(t,i),r=await Dt.default.stat(o),{isJson:a,isYaml:s}=kn(i);r.isDirectory()?e=await bn(o,e):(a||s)&&e.push(o)}return e}function no(t){return typeof t=="object"&&t!==null&&"apiVersion"in t&&typeof t.apiVersion=="string"&&"resourceType"in t&&t.resourceType==="data-structure"}function kn(t){let e=Ot.default.extname(t);return e.match(/\.yml|\.yaml/)?{isYaml:!0,isJson:!1}:e.match(".json")?{isYaml:!1,isJson:!0}:{isYaml:!1,isJson:!1}}var z=require("path"),Xt=require("fs"),Yt=require("mkdirp"),Tn=f(require("fs-extra"));function Fn({codeLines:t,outFilePath:e,language:n}){if(n==="java"){let i="// SNOWTYPE START: ",o="// SNOWTYPE END: ",r=(0,z.resolve)((0,z.dirname)(e),"com","snowplowanalytics","snowplow","snowtype");Yt.mkdirp.sync(r);let a="",s=!1,p="";for(let c of t)c===o+a&&((0,Xt.writeFileSync)((0,z.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,Xt.writeFileSync)(e,i)}}function Ln(t){Tn.default.removeSync((0,z.resolve)(t)),Yt.mkdirp.sync(t)}var Zt=require("path");var $n=require("path"),bt=require("fs-extra"),H=2e4,io=({code:t,codeMinified:e})=>t.length>H&&e.length<=H?`Warning: The content exceeds the GTM limit of ${H} characters. Please use the minified version.`:e.length>H&&e.length>H?`Warning: The content exceeds the GTM limit of ${H} characters.`:"";async function Rn({defaultFileName:t,outDir:e,codeLines:n}){let i=(0,$n.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(io({code:o,codeMinified:a.code})),await(0,bt.remove)(i),await(0,bt.writeFile)(i,a.code)):console.error("Minification failed: Terser did not generate any code.")}async function oo(t){let{config:e,...n}=t,i=await G(e||process.cwd());return N(i),i.options.commands.generate={...i.options.commands.generate,...n},i}async function Z(t,e,n,i){let{dataProductIds:o,dataStructures:r,igluCentralSchemas:a,eventSpecificationIds:s,repositories:p,language:c,tracker:d,outpath:g,organizationId:w,options:{commands:{generate:m}}}=await oo(i),{configDir:l}=D(i.config||process.cwd()),v=I(r),$=I(a),E=I(s),B=I(o),Wn=I(p);v&&$&&E&&B&&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=dn({configDataStructures:r,igluCentralSchemas:a,repositories:p,eventSpecificationIds:s,dataProductIds:o}),P=await A.create({...t,organizationId:w,enableSupportForNonDataProductsTier:_n});if(!await P.authenticate())throw new M;let Un=Et(P,o),Gn=sn([...Un,...s]),zn=Ke(Gn,P,e),{eventSpecificationsWithId:R}=Ue(P,zn,e),Tt=Ve(R);m.deprecateOnlyOnProdAvailableUpdates&&(Tt=await Me(Tt,P));let Hn=He(P,R),Q=Be(Hn,R);An(Q,e);let{customEventSpecs:Bn,standardEventSpecs:Jn}=pn(Q),Kn=Jn.flatMap(Ft=>Ft.entities.map(ei=>ei.source));ve(R)&&d==="@snowplow/browser-tracker"&&e.log("You are generating Snowplow Ecommerce events. You would need to install `@snowplow/browser-plugin-snowplow-ecommerce`."),m.validations&&e.log("For validations to work properly you would need to install `ajv@8`, `ajv-formats@2` and `ajv-draft-04@1` on your project.");let qn=await Ge(a),Xn=qe(r,P,e),ne=await ze(P,[...Xn,...Kn]),Yn=await On(l,p),ie=!!(d==="@snowplow/browser-tracker"&&c.match(/javascript|typescript/));await cn(ne,Q,P,m.disallowDevSchemas);let Zn=[...Yn,...qn,...ne],oe={language:c,tracker:d,schemas:Zn,eventSpecifications:Bn,validations:ie&&m.validations,eventSpecificationsInputMetadata:Tt},T=await(0,Vn.generate)(oe);if(n.stop(!0),!T)throw new tt;e.success("Code generated, writing...");let V=(0,Zt.resolve)(l,g),Qn=nn(c),re=Lt+Qn,ti=(0,Zt.resolve)(V,re);if(Ln(V),Fn({codeLines:T.lines,outFilePath:ti,language:c}),oe.language==="javascript-gtm"&&await Rn({defaultFileName:Lt,outDir:V,codeLines:T.lines}),on(R,V),ie&&m.validations&&T.validationsSchemaObject){let Ft=Je(R);xn(V,c,T.validationsSchemaObject,Ft),qt(T.validationsSchemaObject)&&e.warn("Some schemas appear to have attributes that can have inconsistent validations between the pipeline and client-side validation. Read more at https://docs.snowplow.io/docs/collecting-data/code-generation/client-side-validation/#divergence-with-pipeline-validation")}m.instructions&&await wn(P,Q,T.lines,V,re)}var Qt=O(Z,"generate");async function ro(t){let e=await G(t||process.cwd());return N(e),e}async function ao(t,e,n,i){let o=await ro(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,jn.resolve)(c,o.outpath,mt),g=await A.create({...t,organizationId:o.organizationId});n.setSpinnerTitle("Checking for updates..."),n.isSpinning()===!1&&n.start();let w=Et(g,o.dataProductIds),m=U([...o.eventSpecificationIds,...w]),l={};if(!Gt(d)&&m.length>0)throw new at;if(Gt(d)&&m.length>0){let E=tn(d);l=await xe(g,m,E)}let v=await Ce(g,o.dataStructures,i.maximumBump||r,s);if((Object.entries(l).length>0||v.length>0)===!0){if(e.success("Available updates found!"),rn(l,v,e),i.yes||a)return v.length>0&&(v.forEach(E=>{let B=o.dataStructures.indexOf(E.previous);o.dataStructures[B]=E.next}),Ct(o,i.config||process.cwd())),e.debug("Applying the updates.."),Z(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 te=O(ao,"update");async function so(t){let{config:e,...n}=t;if(Object.values(n).every(o=>Array.isArray(o)&&o.length===0))throw new ot;let i=await G(e||process.cwd());return N(i),{patchOptions:n,generateOptions:i.options.commands.generate,regenerateOnPatch:i.options.commands.patch.regenerateOnPatch}}async function co(t,e,n,i){let{isJSON:o,configPath:r}=D(i.config||process.cwd());if(o===!1)throw new st;let{patchOptions:a,generateOptions:s,regenerateOnPatch:p}=await so(i);return e.debug("Starting patch process with options: ".concat(JSON.stringify(a))),Object.entries(a).forEach(([d,g])=>{g.forEach(w=>{Pe(d,w,r)})}),e.success("Configuration patched"),p?Z(t,e,n,s):(e.log("Code is not generated yet for the patched configuration"),Promise.resolve(void 0))}var ee=O(co,"patch");var kt=require("@snowplow/snowtype-core");async function Nn(){await import("dotenv/config");let t=new k.Command;t.exitOverride(),t.version(_,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 k.Option("-t, --tracker <availableTrackers>","tracker to use").choices(kt.trackerTemplates)).addOption(new k.Option("-l, --language <availableLanguages>","language to use").choices(kt.languageIds)).option("-o, --outpath <string>","output path").action(Bt),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 k.Option("-m, --maximumBump <'patch' | 'minor' | 'major'>","the maximum SchemaVer update to show an available update notification. Defaults to 'major'").choices(["patch","minor","major"])).action(te),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(Qt),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(ee),t.addHelpText("before",ke()).addHelpText("after",`
|
|
116
|
+
`),await t.parseAsync(Mn.argv).catch(e=>{po(e)})}function po(t){if(!(t instanceof k.CommanderError&&["commander.help","commander.version","commander.helpDisplayed"].indexOf(t.code)>-1))throw t}Nn().then(()=>{}).catch(()=>{process.exitCode=1});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@snowplow/snowtype",
|
|
3
|
-
"version": "0.13.
|
|
3
|
+
"version": "0.13.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/",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"dependencies": {
|
|
15
15
|
"@commander-js/extra-typings": "^11.1.0",
|
|
16
16
|
"@inquirer/prompts": "^3.3.0",
|
|
17
|
-
"@snowplow/snowtype-core": "^0.13.
|
|
17
|
+
"@snowplow/snowtype-core": "^0.13.3",
|
|
18
18
|
"chalk": "^4.1.2",
|
|
19
19
|
"cli-spinner": "^0.2.10",
|
|
20
20
|
"dotenv": "^16.3.1",
|