cubejs-cli 0.29.1 → 0.29.5

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.29.5](https://github.com/cube-js/cube.js/compare/v0.29.4...v0.29.5) (2021-12-17)
+
+
+### Features
+
+* **cubejs-cli:** generate TypeScript types from API for use by `@cubejs-client/core` ([b97d9ca](https://github.com/cube-js/cube.js/commit/b97d9ca7f1d611c73fdd4ef3ff8ebfc77bc8aff7))
+
+
+
+
+
+## [0.29.4](https://github.com/cube-js/cube.js/compare/v0.29.3...v0.29.4) (2021-12-16)
+
+**Note:** Version bump only for package cubejs-cli
+
+
+
+
+
+## [0.29.3](https://github.com/cube-js/cube.js/compare/v0.29.2...v0.29.3) (2021-12-15)
+
+**Note:** Version bump only for package cubejs-cli
+
+
+
+
+
+## [0.29.2](https://github.com/cube-js/cube.js/compare/v0.29.1...v0.29.2) (2021-12-15)
+
+**Note:** Version bump only for package cubejs-cli
+
+
+
+
+
 ## [0.29.1](https://github.com/cube-js/cube.js/compare/v0.29.0...v0.29.1) (2021-12-15)
 
 **Note:** Version bump only for package cubejs-cli

package/dist/src/cli.js

@@ -9,6 +9,7 @@ const deploy_1 = require("./command/deploy");
 const create_1 = require("./command/create");
 const generate_1 = require("./command/generate");
 const token_1 = require("./command/token");
+const typegen_1 = require("./command/typegen");
 const auth_1 = require("./command/auth");
 const utils_1 = require("./utils");
 const packageJson = utils_1.loadCliManifest();
@@ -24,6 +25,7 @@ commander_1.default
 (async () => {
     await auth_1.configureAuthCommand(commander_1.default);
     await token_1.configureTokenCommand(commander_1.default);
+    await typegen_1.configureTypegenCommand(commander_1.default);
     await create_1.configureCreateCommand(commander_1.default);
     await generate_1.configureGenerateCommand(commander_1.default);
     await deploy_1.configureDeployCommand(commander_1.default);

package/dist/src/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,0DAAgC;AAEhC,6CAA0D;AAC1D,6CAA0D;AAC1D,6CAA0D;AAC1D,iDAA8D;AAC9D,2CAAwD;AACxD,yCAAsD;AACtD,mCAA0C;AAE1C,MAAM,WAAW,GAAG,uBAAe,EAAE,CAAC;AAEtC,mBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC1C,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEhC,mBAAO;KACJ,KAAK,CAAC,qBAAqB,CAAC;KAC5B,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;IACjB,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,mEAAmE,CAAC,CAAC;IACjF,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC;AAEL,CAAC,KAAK,IAAI,EAAE;IACV,MAAM,2BAAoB,CAAC,mBAAO,CAAC,CAAC;IACpC,MAAM,6BAAqB,CAAC,mBAAO,CAAC,CAAC;IACrC,MAAM,+BAAsB,CAAC,mBAAO,CAAC,CAAC;IACtC,MAAM,mCAAwB,CAAC,mBAAO,CAAC,CAAC;IACxC,MAAM,+BAAsB,CAAC,mBAAO,CAAC,CAAC;IACtC,MAAM,+BAAsB,CAAC,mBAAO,CAAC,CAAC;IAEtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;QACjC,mBAAO,CAAC,IAAI,EAAE,CAAC;KAChB;IAED,mBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC,EAAE,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,0DAAgC;AAEhC,6CAA0D;AAC1D,6CAA0D;AAC1D,6CAA0D;AAC1D,iDAA8D;AAC9D,2CAAwD;AACxD,+CAA4D;AAC5D,yCAAsD;AACtD,mCAA0C;AAE1C,MAAM,WAAW,GAAG,uBAAe,EAAE,CAAC;AAEtC,mBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC1C,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEhC,mBAAO;KACJ,KAAK,CAAC,qBAAqB,CAAC;KAC5B,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;IACjB,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,mEAAmE,CAAC,CAAC;IACjF,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC;AAEL,CAAC,KAAK,IAAI,EAAE;IACV,MAAM,2BAAoB,CAAC,mBAAO,CAAC,CAAC;IACpC,MAAM,6BAAqB,CAAC,mBAAO,CAAC,CAAC;IACrC,MAAM,iCAAuB,CAAC,mBAAO,CAAC,CAAC;IACvC,MAAM,+BAAsB,CAAC,mBAAO,CAAC,CAAC;IACtC,MAAM,mCAAwB,CAAC,mBAAO,CAAC,CAAC;IACxC,MAAM,+BAAsB,CAAC,mBAAO,CAAC,CAAC;IACtC,MAAM,+BAAsB,CAAC,mBAAO,CAAC,CAAC;IAEtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;QACjC,mBAAO,CAAC,IAAI,EAAE,CAAC;KAChB;IAED,mBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC,EAAE,CAAC"}

package/dist/src/command/typegen.d.ts

@@ -0,0 +1,3 @@
+import type { CommanderStatic } from 'commander';
+export declare function configureTypegenCommand(program: CommanderStatic): void;
+//# sourceMappingURL=typegen.d.ts.map

package/dist/src/command/typegen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typegen.d.ts","sourceRoot":"","sources":["../../../src/command/typegen.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAgGjD,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAetE"}

package/dist/src/command/typegen.js

@@ -0,0 +1,103 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureTypegenCommand = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const request_promise_1 = __importDefault(require("request-promise"));
+const utils_1 = require("../utils");
+const wrapInQuotes = (values) => {
+    if (values.length === 0) {
+        return '\'\'';
+    }
+    return values
+        .map(m => `'${m}'`)
+        .join('\n  | ');
+};
+const stripSpaces = (str) => str.replace(/\s/g, '');
+const selectName = (o) => o.name;
+const createCubeProps = (cube) => {
+    const cubeName = stripSpaces(cube.name);
+    const dimensions = cube.dimensions.map(selectName);
+    const measures = cube.measures.map(selectName);
+    const timeDimensions = cube.dimensions.filter((d) => d.type === 'time').map(selectName);
+    const segments = cube.segments.map(selectName);
+    return `export type ${cubeName}Measure = ${wrapInQuotes(measures)};
+export type ${cubeName}Dimension = ${wrapInQuotes(dimensions)};
+export type ${cubeName}TimeDimension = ${wrapInQuotes(timeDimensions)};
+export type ${cubeName}Segment = ${wrapInQuotes(segments)};
+`;
+};
+const createTypeDefinitions = (cubes) => {
+    const cubeNames = cubes.map(cube => cube.name);
+    const topLevelTypes = [
+        'Measure',
+        'Dimension',
+        'TimeDimension',
+        'Segment',
+    ];
+    return `// DO NOT MANUALLY EDIT - THIS FILE IS AUTOMATICALLY GENERATED
+
+export type Cubes = ${cubeNames.map(c => `'${c}'`).join('\n  | ')};
+
+${cubes.map(createCubeProps).join('\n')}
+${topLevelTypes.map((topLevelType) => `
+export type Introspected${topLevelType}Name = ${cubeNames.map(c => `${c}${topLevelType}`).join('\n  | ')};
+`).join('\n')}`;
+};
+const generateQueryTypes = async (apiUrl, { token }) => {
+    if (!token) {
+        await utils_1.displayError('Type generation requires a token. Please generate one and try again');
+    }
+    let meta = {
+        cubes: [],
+    };
+    try {
+        meta = await request_promise_1.default({
+            headers: {
+                authorization: token,
+            },
+            url: `${apiUrl}/meta`,
+            json: true,
+        });
+    }
+    catch (e) {
+        await utils_1.displayError(e.error.error);
+    }
+    if (meta.cubes.length === 0) {
+        await utils_1.displayError('No cubes were found. Please create a cube and try again');
+    }
+    const typeDefs = createTypeDefinitions(meta.cubes);
+    const pathToCubeDX = require.resolve('@cubejs-client/dx');
+    const pathToDefinitionFile = pathToCubeDX.replace('/src/index.js', '/generated.d.ts');
+    try {
+        await fs_extra_1.default.writeFile(pathToDefinitionFile, typeDefs);
+        await utils_1.event({
+            event: 'cli:typegen:success',
+            area: 'cli:typegen'
+        });
+        console.log('Types successfully generated!');
+    }
+    catch (e) {
+        await utils_1.displayError('Could not persist types to disk. Please file a GitHub issue reporting this', {
+            area: 'cli:typegen',
+        });
+    }
+};
+function configureTypegenCommand(program) {
+    program
+        .command('typegen <apiUrl>')
+        .description('Generate types from your Cube API for your frontend project')
+        .option('--token <token>', 'A valid JWT for your Cube project')
+        .action((apiUrl, options) => generateQueryTypes(apiUrl, options)
+        .catch(e => utils_1.displayError(e.stack || e)))
+        .on('--help', () => {
+        console.log('');
+        console.log('Example:');
+        console.log('');
+        console.log('  $ cubejs typegen http://localhost:4000/cubejs-api/v1 --token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkZXBsb3ltZW50SWQiOiIxIiwidXJsIjoiaHR0cHM6Ly9leGFtcGxlcy5jdWJlY2xvdWQuZGV2IiwiaWF0IjoxNTE2MjM5MDIyfQ.La3MiuqfGigfzADl1wpxZ7jlb6dY60caezgqIOoHt-c');
+    });
+}
+exports.configureTypegenCommand = configureTypegenCommand;
+//# sourceMappingURL=typegen.js.map

package/dist/src/command/typegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typegen.js","sourceRoot":"","sources":["../../../src/command/typegen.ts"],"names":[],"mappings":";;;;;;AACA,wDAA0B;AAC1B,sEAAiC;AAEjC,oCAA+C;AAE/C,MAAM,YAAY,GAAG,CAAC,MAAgB,EAAE,EAAE;IACxC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,MAAM,CAAC;KACf;IAED,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;SAClB,IAAI,CAAC,QAAQ,CAAC,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAEpE,MAAM,UAAU,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAEjC,MAAM,eAAe,GAAG,CAAC,IAAS,EAAE,EAAE;IACpC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxF,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAE/C,OAAO,eAAe,QAAQ,aAAa,YAAY,CAAC,QAAQ,CAAC;cACrD,QAAQ,eAAe,YAAY,CAAC,UAAU,CAAC;cAC/C,QAAQ,mBAAmB,YAAY,CAAC,cAAc,CAAC;cACvD,QAAQ,aAAa,YAAY,CAAC,QAAQ,CAAC;CACxD,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,KAAY,EAAE,EAAE;IAC7C,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG;QACpB,SAAS;QACT,WAAW;QACX,eAAe;QACf,SAAS;KACV,CAAC;IAEF,OAAO;;sBAEa,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;;EAE/D,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;EACrC,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC;0BACZ,YAAY,UAAU,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;CACvG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;IACrD,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,oBAAY,CAAC,qEAAqE,CAAC,CAAC;KAC3F;IAED,IAAI,IAAI,GAAG;QACT,KAAK,EAAE,EAAE;KACV,CAAC;IAEF,IAAI;QACF,IAAI,GAAG,MAAM,yBAAE,CAAC;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,KAAK;aACrB;YACD,GAAG,EAAE,GAAG,MAAM,OAAO;YACrB,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;KACJ;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,oBAAY,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACnC;IAED,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,MAAM,oBAAY,CAAC,yDAAyD,CAAC,CAAC;KAC/E;IAED,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC1D,MAAM,oBAAoB,GAAG,YAAY,CAAC,OAAO,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;IAEtF,IAAI;QACF,MAAM,kBAAE,CAAC,SAAS,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;QACnD,MAAM,aAAK,CAAC;YACV,KAAK,EAAE,qBAAqB;YAC5B,IAAI,EAAE,aAAa;SACpB,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;KAC9C;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,oBAAY,CAAC,4EAA4E,EAAE;YAC/F,IAAI,EAAE,aAAa;SACpB,CAAC,CAAC;KACJ;AACH,CAAC,CAAC;AAEF,SAAgB,uBAAuB,CAAC,OAAwB;IAC9D,OAAO;SACJ,OAAO,CAAC,kBAAkB,CAAC;SAC3B,WAAW,CAAC,6DAA6D,CAAC;SAC1E,MAAM,CAAC,iBAAiB,EAAE,mCAAmC,CAAC;SAC9D,MAAM,CACL,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC;SACrD,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,oBAAY,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAC1C;SACA,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;QACjB,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACxB,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,wPAAwP,CAAC,CAAC;IACxQ,CAAC,CAAC,CAAC;AACP,CAAC;AAfD,0DAeC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "cubejs-cli",
   "description": "Cube.js Command Line Interface",
   "author": "Cube Dev, Inc.",
-  "version": "0.29.1",
+  "version": "0.29.5",
   "repository": {
     "type": "git",
     "url": "https://github.com/cube-js/cube.js.git",
@@ -46,7 +46,7 @@
   },
   "devDependencies": {
     "@cubejs-backend/linter": "^0.29.0",
-    "@cubejs-backend/server": "^0.29.1",
+    "@cubejs-backend/server": "^0.29.5",
     "@oclif/command": "^1.8.0",
     "@types/cli-progress": "^3.8.0",
     "@types/cross-spawn": "^6.0.2",
@@ -65,5 +65,5 @@
   "eslintConfig": {
     "extends": "../cubejs-linter"
   },
-  "gitHead": "46d6462b1b81da36c2a1896ba8fed709c8f18fb3"
+  "gitHead": "518281dea6e0c511813df4502f3aa97038f9be23"
 }