ic-mops 0.1.2 → 0.1.5

package/cli.js

@@ -11,7 +11,7 @@ import {install} from './commands/install.js';
 import {publish} from './commands/publish.js';
 import {importPem} from './commands/import-identity.js';
 import {sources} from './commands/sources.js';
-import {getLastVersion, getNetwork, setNetwork} from './mops.js';
+import {checkApiCompatibility, getMaxVersion, getNetwork, setNetwork} from './mops.js';
 import {whoami} from './commands/whoami.js';
 import {installAll} from './commands/install-all.js';
 import logUpdate from 'log-update';
@@ -55,12 +55,17 @@ program
 			config.dependencies = {};
 		}
 
+		let compatible = await checkApiCompatibility();
+		if (!compatible) {
+			return;
+		}
+
 		if (!pkg) {
 			installAll(options);
 		}
 		else {
-			let version = await getLastVersion(pkg);
-			await install(pkg, version, options.verbose);
+			let version = await getMaxVersion(pkg);
+			await install(pkg, version, {verbose: options.verbose});
 
 			config.dependencies[pkg] = version;
 			wirteConfig(config);
@@ -74,7 +79,10 @@ program
 	.command('publish')
 	.description('Publish package to the mops registry')
 	.action(async () => {
-		await publish();
+		let compatible = await checkApiCompatibility();
+		if (compatible) {
+			await publish();
+		}
 	});
 
 // set-network

package/commands/import-identity.js

@@ -1,9 +1,11 @@
 import fs from 'fs';
 import chalk from 'chalk';
+import path from 'path';
+import {globalCacheDir} from '../mops.js';
 
 export async function importPem(data) {
 	try {
-		let url = new URL('../identity.pem', import.meta.url);
+		let url = new URL(path.resolve(globalCacheDir, 'identity.pem'), import.meta.url);
 		fs.writeFileSync(url, data);
 		console.log(chalk.green('Success'));
 	}

package/commands/install-all.js

@@ -12,7 +12,7 @@ export async function installAll({verbose} = {}) {
 	let deps = Object.entries(config.dependencies || {});
 
 	for (let [pkg, ver] of deps) {
-		await install(pkg, ver, verbose);
+		await install(pkg, ver, {verbose});
 	}
 
 	logUpdate.clear();

package/commands/install.js

@@ -1,16 +1,16 @@
 import path from 'path';
 import fs from 'fs';
 import logUpdate from 'log-update';
-import {checkConfigFile, getLastVersion, mainActor, progressBar, readConfig} from '../mops.js';
+import {checkConfigFile, getMaxVersion, mainActor, progressBar, readConfig} from '../mops.js';
 import {parallel} from '../parallel.js';
 
-export async function install(pkg, version = '', verbose = false, dep = false) {
+export async function install(pkg, version = '', {verbose, silent, dep} = {}) {
 	if (!checkConfigFile()) {
 		return;
 	}
 
 	if (!version) {
-		version = await getLastVersion(pkg);
+		version = await getMaxVersion(pkg);
 	}
 
 	let dir = path.join(process.cwd(), '.mops', `${pkg}@${version}`);
@@ -18,12 +18,15 @@ export async function install(pkg, version = '', verbose = false, dep = false) {
 
 	// cache
 	if (fs.existsSync(dir)) {
-		logUpdate(`${dep ? 'Dependency' : 'Installing'} ${pkg}@${version} (cache)`);
+		silent || logUpdate(`${dep ? 'Dependency' : 'Installing'} ${pkg}@${version} (cache)`);
 	}
 	// no cache
 	else {
 		fs.mkdirSync(dir, {recursive: true});
 
+		if (!dep) {
+			actor.notifyInstall(pkg, version);
+		}
 		let filesIds = await actor.getFileIds(pkg, version);
 
 		// progress
@@ -31,7 +34,7 @@ export async function install(pkg, version = '', verbose = false, dep = false) {
 		let step = 0;
 		let progress = () => {
 			step++;
-			logUpdate(`${dep ? 'Dependency' : 'Installing'} ${pkg}@${version} ${progressBar(step, total)}`);
+			silent || logUpdate(`${dep ? 'Dependency' : 'Installing'} ${pkg}@${version} ${progressBar(step, total)}`);
 		};
 
 		// download files
@@ -42,20 +45,15 @@ export async function install(pkg, version = '', verbose = false, dep = false) {
 			fs.writeFileSync(path.join(dir, file.path), Buffer.from(file.content));
 			progress();
 		});
-
-		// TODO: slow (update call)
-		// if (!dep) {
-		// 	await actor.notifyInstall(pkg, version);
-		// }
 	}
 
 	if (verbose) {
-		logUpdate.done();
+		silent || logUpdate.done();
 	}
 
 	// install dependencies
 	let config = readConfig(path.join(dir, 'mops.toml'));
 	for (let [name, version] of Object.entries(config.dependencies || {})) {
-		await install(name, version, verbose, true);
+		await install(name, version, {verbose, silent, dep: true});
 	}
 }

package/commands/publish.js

@@ -17,7 +17,7 @@ export async function publish() {
 
 	// validate
 	for (let key of Object.keys(config)) {
-		if (!['package', 'dependencies', 'permissions', 'scripts'].includes(key)) {
+		if (!['package', 'dependencies', 'scripts'].includes(key)) {
 			console.log(chalk.red('Error: ') + `Unknown config section [${key}]`);
 			return;
 		}
@@ -59,7 +59,6 @@ export async function publish() {
 		'homepage',
 		'readme',
 		'license',
-		'isPrivate',
 		'files',
 		'dfx',
 		'moc',
@@ -101,11 +100,6 @@ export async function publish() {
 		return;
 	}
 
-	if (config.package.permissions && Object.keys(config.package.permissions).length > 50) {
-		console.log(chalk.red('Error: ') + 'max permissions is 50');
-		return;
-	}
-
 	if (config.package.keywords) {
 		for (let keyword of config.package.keywords) {
 			if (keyword.length > 20) {
@@ -135,7 +129,6 @@ export async function publish() {
 		documentation: config.package.documentation || '',
 		readme: 'README.md',
 		license: config.package.license || '',
-		isPrivate: false,
 		owner: getIdentity()?.getPrincipal() || Principal.anonymous(),
 		dfx: config.package.dfx || '',
 		moc: config.package.moc || '',
@@ -143,7 +136,6 @@ export async function publish() {
 		dependencies: (Object.entries(config.dependencies || {})).map(([name, version]) => {
 			return {name, version};
 		}),
-		permissions: [],
 		scripts: [],
 	};
 

package/commands/sources.js

@@ -2,7 +2,7 @@ import path from 'path';
 import fs from 'fs';
 import chalk from 'chalk';
 import {install} from './install.js';
-import {getLastVersion, readConfig} from '../mops.js';
+import {getMaxVersion, readConfig} from '../mops.js';
 
 function rootDir(cwd = process.cwd()) {
 	let configFile = path.join(cwd, 'mops.toml');
@@ -73,8 +73,8 @@ export async function sources({verbose} = {}) {
 			packages['base-unofficial'] = downloadedPackages['base-unofficial'];
 		}
 		else {
-			let version = await getLastVersion('base-unofficial');
-			await install('base-unofficial', version, false, true);
+			let version = await getMaxVersion('base-unofficial');
+			await install('base-unofficial', version, {silent: true, dep: true});
 			packages['base-unofficial'] = version;
 		}
 	}

package/commands/whoami.js

@@ -1,9 +1,10 @@
 import chalk from 'chalk';
 import fs from 'fs';
-import {getIdentity} from '../mops.js';
+import path from 'path';
+import {getIdentity, globalCacheDir} from '../mops.js';
 
 export function whoami() {
-	let identityPem = new URL('../identity.pem', import.meta.url);
+	let identityPem = new URL(path.resolve(globalCacheDir, 'identity.pem'), import.meta.url);
 	if (fs.existsSync(identityPem)) {
 		let identity = getIdentity();
 		console.log(identity.getPrincipal().toText());

package/declarations/main/main.did

@@ -18,18 +18,24 @@ type Result =
  };
 type PublishingId = text;
 type PublishingErr = text;
-type Permission = 
- record {
-   access: Access;
-   user: principal;
- };
 type PackageSummary = 
  record {
+   dependencies: vec Dependency;
    description: text;
+   dfx: text;
+   documentation: text;
+   donation: text;
    downloadsInLast30Days: nat;
    downloadsTotal: nat;
+   homepage: text;
    keywords: vec text;
+   license: text;
+   moc: text;
    name: PackageName;
+   owner: principal;
+   readme: text;
+   repository: text;
+   scripts: vec Script;
    updatedAt: Time;
    version: text;
  };
@@ -43,13 +49,10 @@ type PackageConfig =
    documentation: text;
    donation: text;
    homepage: text;
-   isPrivate: bool;
    keywords: vec text;
    license: text;
    moc: text;
    name: PackageName;
-   owner: principal;
-   permissions: vec Permission;
    readme: text;
    repository: text;
    scripts: vec Script;
@@ -68,23 +71,18 @@ type Dependency =
    name: PackageName;
    version: text;
  };
-type Access = 
- variant {
-   readOnly;
-   readWrite;
- };
 service : {
   finishPublish: (PublishingId) -> (Result);
+  getApiVersion: () -> (Text) query;
   getConfig: (PackageName__1, Version) -> (PackageConfig) query;
   getFile: (FileId) -> (File) query;
   getFileIds: (PackageName__1, Version) -> (vec FileId) query;
-  getLastConfig: (PackageName__1) -> (PackageConfig) query;
-  getLastVersion: (PackageName__1) -> (Version) query;
+  getMaxVersion: (PackageName__1) -> (Version) query;
+  getPackageSummary: (PackageName__1, Version) -> (PackageSummary) query;
   getReadmeFile: (PackageName__1, Version) -> (File) query;
   getRecentlyUpdatedPackages: () -> (vec PackageSummary) query;
   notifyInstall: (PackageName__1, Version) -> () oneway;
   search: (Text) -> (vec PackageSummary) query;
   startPublish: (PackageConfig) -> (Result_1);
   uploadFile: (PublishingId, Text, blob) -> (Result);
-  whoami: () -> (Text) query;
 }

package/declarations/main/main.did.d.ts

@@ -1,8 +1,6 @@
 import type { Principal } from '@dfinity/principal';
 import type { ActorMethod } from '@dfinity/agent';
 
-export type Access = { 'readOnly' : null } |
-  { 'readWrite' : null };
 export interface Dependency { 'name' : PackageName, 'version' : string }
 export type Err = string;
 export interface File {
@@ -14,9 +12,7 @@ export type FileId = string;
 export interface PackageConfig {
   'dfx' : string,
   'moc' : string,
-  'permissions' : Array<Permission>,
   'scripts' : Array<Script>,
-  'owner' : Principal,
   'documentation' : string,
   'name' : PackageName,
   'homepage' : string,
@@ -24,7 +20,6 @@ export interface PackageConfig {
   'version' : string,
   'keywords' : Array<string>,
   'donation' : string,
-  'isPrivate' : boolean,
   'repository' : string,
   'dependencies' : Array<Dependency>,
   'license' : string,
@@ -33,15 +28,25 @@ export interface PackageConfig {
 export type PackageName = string;
 export type PackageName__1 = string;
 export interface PackageSummary {
+  'dfx' : string,
+  'moc' : string,
+  'scripts' : Array<Script>,
+  'owner' : Principal,
+  'documentation' : string,
   'name' : PackageName,
+  'homepage' : string,
   'downloadsTotal' : bigint,
   'downloadsInLast30Days' : bigint,
   'description' : string,
   'version' : string,
   'keywords' : Array<string>,
+  'donation' : string,
   'updatedAt' : Time,
+  'repository' : string,
+  'dependencies' : Array<Dependency>,
+  'license' : string,
+  'readme' : string,
 }
-export interface Permission { 'access' : Access, 'user' : Principal }
 export type PublishingErr = string;
 export type PublishingId = string;
 export type Result = { 'ok' : null } |
@@ -54,16 +59,16 @@ export type Time = bigint;
 export type Version = string;
 export interface _SERVICE {
   'finishPublish' : ActorMethod<[PublishingId], Result>,
+  'getApiVersion' : ActorMethod<[], Text>,
   'getConfig' : ActorMethod<[PackageName__1, Version], PackageConfig>,
   'getFile' : ActorMethod<[FileId], File>,
   'getFileIds' : ActorMethod<[PackageName__1, Version], Array<FileId>>,
-  'getLastConfig' : ActorMethod<[PackageName__1], PackageConfig>,
-  'getLastVersion' : ActorMethod<[PackageName__1], Version>,
+  'getMaxVersion' : ActorMethod<[PackageName__1], Version>,
+  'getPackageSummary' : ActorMethod<[PackageName__1, Version], PackageSummary>,
   'getReadmeFile' : ActorMethod<[PackageName__1, Version], File>,
   'getRecentlyUpdatedPackages' : ActorMethod<[], Array<PackageSummary>>,
   'notifyInstall' : ActorMethod<[PackageName__1, Version], undefined>,
   'search' : ActorMethod<[Text], Array<PackageSummary>>,
   'startPublish' : ActorMethod<[PackageConfig], Result_1>,
   'uploadFile' : ActorMethod<[PublishingId, Text, Array<number>], Result>,
-  'whoami' : ActorMethod<[], Text>,
 }

package/declarations/main/main.did.js

@@ -2,19 +2,16 @@ export const idlFactory = ({ IDL }) => {
   const PublishingId = IDL.Text;
   const Err = IDL.Text;
   const Result = IDL.Variant({ 'ok' : IDL.Null, 'err' : Err });
+  const Text = IDL.Text;
   const PackageName__1 = IDL.Text;
   const Version = IDL.Text;
-  const Access = IDL.Variant({ 'readOnly' : IDL.Null, 'readWrite' : IDL.Null });
-  const Permission = IDL.Record({ 'access' : Access, 'user' : IDL.Principal });
   const Script = IDL.Record({ 'value' : IDL.Text, 'name' : IDL.Text });
   const PackageName = IDL.Text;
   const Dependency = IDL.Record({ 'name' : PackageName, 'version' : IDL.Text });
   const PackageConfig = IDL.Record({
     'dfx' : IDL.Text,
     'moc' : IDL.Text,
-    'permissions' : IDL.Vec(Permission),
     'scripts' : IDL.Vec(Script),
-    'owner' : IDL.Principal,
     'documentation' : IDL.Text,
     'name' : PackageName,
     'homepage' : IDL.Text,
@@ -22,14 +19,12 @@ export const idlFactory = ({ IDL }) => {
     'version' : IDL.Text,
     'keywords' : IDL.Vec(IDL.Text),
     'donation' : IDL.Text,
-    'isPrivate' : IDL.Bool,
     'repository' : IDL.Text,
     'dependencies' : IDL.Vec(Dependency),
     'license' : IDL.Text,
     'readme' : IDL.Text,
   });
   const FileId = IDL.Text;
-  const Text = IDL.Text;
   const File = IDL.Record({
     'id' : FileId,
     'content' : IDL.Vec(IDL.Nat8),
@@ -37,18 +32,30 @@ export const idlFactory = ({ IDL }) => {
   });
   const Time = IDL.Int;
   const PackageSummary = IDL.Record({
+    'dfx' : IDL.Text,
+    'moc' : IDL.Text,
+    'scripts' : IDL.Vec(Script),
+    'owner' : IDL.Principal,
+    'documentation' : IDL.Text,
     'name' : PackageName,
+    'homepage' : IDL.Text,
     'downloadsTotal' : IDL.Nat,
     'downloadsInLast30Days' : IDL.Nat,
     'description' : IDL.Text,
     'version' : IDL.Text,
     'keywords' : IDL.Vec(IDL.Text),
+    'donation' : IDL.Text,
     'updatedAt' : Time,
+    'repository' : IDL.Text,
+    'dependencies' : IDL.Vec(Dependency),
+    'license' : IDL.Text,
+    'readme' : IDL.Text,
   });
   const PublishingErr = IDL.Text;
   const Result_1 = IDL.Variant({ 'ok' : PublishingId, 'err' : PublishingErr });
   return IDL.Service({
     'finishPublish' : IDL.Func([PublishingId], [Result], []),
+    'getApiVersion' : IDL.Func([], [Text], ['query']),
     'getConfig' : IDL.Func(
         [PackageName__1, Version],
         [PackageConfig],
@@ -60,8 +67,12 @@ export const idlFactory = ({ IDL }) => {
         [IDL.Vec(FileId)],
         ['query'],
       ),
-    'getLastConfig' : IDL.Func([PackageName__1], [PackageConfig], ['query']),
-    'getLastVersion' : IDL.Func([PackageName__1], [Version], ['query']),
+    'getMaxVersion' : IDL.Func([PackageName__1], [Version], ['query']),
+    'getPackageSummary' : IDL.Func(
+        [PackageName__1, Version],
+        [PackageSummary],
+        ['query'],
+      ),
     'getReadmeFile' : IDL.Func([PackageName__1, Version], [File], ['query']),
     'getRecentlyUpdatedPackages' : IDL.Func(
         [],
@@ -76,7 +87,6 @@ export const idlFactory = ({ IDL }) => {
         [Result],
         [],
       ),
-    'whoami' : IDL.Func([], [Text], ['query']),
   });
 };
 export const init = ({ IDL }) => { return []; };

package/mops.js

@@ -11,8 +11,13 @@ import {decodeFile} from './pem.js';
 
 global.fetch = fetch;
 
+// (!) make changes in pair with backend
+let apiVersion = '0.1';
+
 let networkFile = new URL('./network.txt', import.meta.url);
 
+export let globalCacheDir = path.resolve(process.env.HOME || process.env.APPDATA, '.mops');
+
 export function setNetwork(network) {
 	fs.writeFileSync(networkFile, network);
 }
@@ -41,7 +46,7 @@ export function getNetwork() {
 }
 
 export let getIdentity = () => {
-	let identityPem = new URL('./identity.pem', import.meta.url);
+	let identityPem = new URL(path.resolve(globalCacheDir, 'identity.pem'), import.meta.url);
 	if (fs.existsSync(identityPem)) {
 		return decodeFile(identityPem);
 	}
@@ -79,12 +84,31 @@ export function progressBar(step, total) {
 	return `[${':'.repeat(done)}${' '.repeat(10 - done)}]`;
 }
 
-export async function getLastVersion(pkgName) {
+export async function getMaxVersion(pkgName) {
 	let actor = await mainActor();
-	return actor.getLastVersion(pkgName);
+	return actor.getMaxVersion(pkgName);
 }
 
 export function readConfig(configFile = path.join(process.cwd(), 'mops.toml')) {
 	let text = fs.readFileSync(configFile).toString();
 	return TOML.parse(text);
+}
+
+// warn on minor mismatch
+// err on major mismatch
+export async function checkApiCompatibility() {
+	let actor = await mainActor();
+	let backendApiVer = await actor.getApiVersion();
+	if (backendApiVer.split('.')[0] !== apiVersion.split('.')[0]) {
+		console.log(chalk.red('ERR: ') + `CLI incompatible with backend. CLI v${apiVersion}, Backend v${backendApiVer}`);
+		console.log('Run ' + chalk.greenBright('npm i -g ic-mops') + ' to upgrade cli.');
+		return false;
+	}
+	else if (backendApiVer.split('.')[1] !== apiVersion.split('.')[1]) {
+		console.log('-'.repeat(50));
+		console.log(chalk.yellow('WARN: ') + `CLI probably incompatible with backend. CLI v${apiVersion}, Backend v${backendApiVer}`);
+		console.log('Recommended to run ' + chalk.greenBright('npm i -g ic-mops') + ' to upgrade cli.');
+		console.log('-'.repeat(50));
+	}
+	return true;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ic-mops",
-	"version": "0.1.2",
+	"version": "0.1.5",
 	"type": "module",
 	"bin": {
 		"mops": "cli.js"