@cognite/cli 0.5.1 → 0.6.0-alpha.6

package/dist/skills-HEBDDOC4.js

@@ -0,0 +1,12 @@
+import {
+  buildPullArgs,
+  execSkillsCli,
+  pullAllArgs,
+  registerSkillsCommand
+} from "./chunk-SUXS6HCW.js";
+export {
+  buildPullArgs,
+  execSkillsCli,
+  pullAllArgs,
+  registerSkillsCommand
+};

package/package.json

@@ -1,29 +1,31 @@
 {
   "name": "@cognite/cli",
+  "version": "0.6.0-alpha.6",
+  "description": "CLI for Cognite Data Fusion",
+  "license": "Apache-2.0",
+  "author": "Cognite",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cognitedata/dune.git",
+    "directory": "packages/cli"
+  },
+  "type": "module",
   "bin": {
-    "cdf": "index.js"
+    "dune": "./dist/cli/cli.js"
   },
   "files": [
-    "index.js",
-    "operations.js"
+    "dist"
   ],
-  "version": "0.5.1",
-  "description": "a cli for cognite data fusion",
-  "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified, continuing anyway\" && exit 0"
-  },
-  "author": "You",
-  "license": "MIT",
-  "dependencies": {
-    "@cognite/sdk": "^2.6.1",
-    "js-yaml": "^3.13.1",
-    "pipe-args": "^1.3.0",
-    "yargs": "^13.3.0"
+    "build": "tsup",
+    "prepublishOnly": "pnpm run build"
   },
-  "prettier": {
-    "singleQuote": true,
-    "trailingComma": "es5"
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "tsup": "^8.4.0",
+    "typescript": "^5.0.0"
   },
-  "devDependencies": {}
+  "engines": {
+    "node": ">=20"
+  }
 }

package/README.md

@@ -1,61 +0,0 @@
-# cdf cli
-
-This is in super alpha!
-
-## Install
-
-    $ npm i -g @cognite/cli
-
-## Screencast example
-
-![This is how it works](https://media.giphy.com/media/TgymOB5RrXunSANV3P/giphy.gif)
-
-## Usage
-
-The project and api-key is specified through the two _required_ environment variables
-
-    $ export COGNITE_PROJECT=publicdata
-    $ export COGNITE_CREDENTIALS=<api-key>
-
-and the optional environment variable
-
-    $ export COGNITE_BASE_URL=<cluster-specific-url>
-
-## Examples
-
-`cdf assets list`
-
-`cdf assets list --limit=5`
-
-`cdf assets list --filter.root=true --limit=5`
-
-`cdf assets retrieve --externalIds=test1,test2`
-
-`cdf assets retrieve --ids=123,234`
-
-`cdf assets search --filter.root=true --search.name=name --limit=10`
-
-`cdf assets create --externalId=test1 --name=somename`
-
-`cdf assets update --externalId=test1 --update.name.set=somenewname`
-
-You can also pipe JSON input to create/delete to create multiple assets at once. Assuming assets.json contains
-
-```
-[
-    {"externalId": "test.1"},
-    {"externalId": "test.2"}
-]
-```
-
-then;
-`cat assets.json | cdf assets create`
-`cat assets.json | cdf assets delete`
-
-## Settings
-
-## Contribution
-
-Yes, please. Issues and PRs are highly welcome.
-
-This package is automatically released using [semantic release](https://github.com/semantic-release/semantic-release). Please write commit messages that follows the angular commit message conventions (feat:, fix: etc).

package/index.js

@@ -1,134 +0,0 @@
-#!/usr/bin/env node
-require('pipe-args').load();
-const yargs = require('yargs');
-const { CogniteClient } = require('@cognite/sdk');
-const yaml = require('js-yaml');
-const getOperation = require('./operations');
-
-if (!(process.env.COGNITE_CREDENTIALS && process.env.COGNITE_PROJECT)) {
-  console.error(`Both COGNITE_CREDENTIALS and COGNITE_PROJECT needs to be set`);
-  process.exit(1);
-}
-
-const sdk = new CogniteClient({
-  appId: 'cdf-cli',
-  baseUrl: process.env.COGNITE_BASE_URL || 'https://api.cognitedata.com',
-});
-
-sdk.loginWithApiKey({
-  apiKey: process.env.COGNITE_CREDENTIALS,
-  project: process.env.COGNITE_PROJECT,
-});
-
-// Supported resource types
-const rTypes = [
-  'timeseries',
-  'sequences',
-  'assets',
-  'events',
-  'files',
-  'datapoints',
-  'apiKeys',
-  'securityCategories',
-  'serviceAccounts',
-  'groups',
-  'raw',
-  'models3D',
-  'revisions3D',
-];
-
-// Remove these nonsense properties from the rTypes
-// and assume the rest is the actual operations
-const BLACKLIST = [
-  'transformTo',
-  'client',
-  'resourcePath',
-  'map',
-  'callListEndpointWithGet',
-  'callListEndpointWithPost',
-  'sequenceRowsAPI',
-  'rawTablesApi',
-  'rawRowsApi',
-].map(i => new RegExp(i, 'gi'));
-
-const allOperations = {};
-
-rTypes.forEach(t => {
-  const subOperations = Object.keys(sdk[t]);
-  const validOperations = subOperations.filter(
-    key => !BLACKLIST.some(regEx => regEx.test(key))
-  );
-  allOperations[t] = validOperations;
-});
-
-function cleanArguments(args) {
-  const cp = {
-    ...args,
-  };
-  // Remove the ones that will not get passed on to the SDK
-  delete cp['$0'];
-  delete cp['_'];
-  delete cp['o'];
-  return cp;
-}
-
-let argv;
-
-Object.keys(allOperations).map(key => {
-  argv = yargs.usage(`$0 ${key}`).command(key, `work with ${key}`, yargs => {
-    argv = yargs.usage(`$0 ${key} <operation> [options]`);
-    argv = allOperations[key].reduce(
-      (p, c) =>
-        p.command(
-          c,
-          `${c} ${key}`,
-          () => {
-            // Here I can build the options for each request
-          },
-          async yargz => {
-            const resourceType = key;
-            const operation = c;
-            // Fetch the right operation, e.g timeseries list
-            const func = getOperation(
-              resourceType,
-              operation,
-              sdk,
-              cleanArguments(yargz)
-            );
-            if (!func) {
-              console.error(
-                `Sorry, ${resourceType} ${operation} is not implemented yet :-(`
-              );
-              process.exit(1);
-            }
-
-            // Handle result
-            try {
-              let extraArguments = [];
-              if (yargz['_'].length > 2) {
-                // Some arguments should go to the sdk
-                // this would be all non-options after cdf revisions3D list
-                extraArguments = yargz['_'].slice(2);
-              }
-              let result = await func(...extraArguments);
-              if (result.map) {
-                // This is an array, remove nonsense objects
-                result = result.map(r => JSON.parse(JSON.stringify(r)));
-              }
-              const YAML_OUTPUT = /yaml|yml/.test(yargz.o);
-              if (YAML_OUTPUT) {
-                console.log(yaml.safeDump(result));
-              } else {
-                console.log(JSON.stringify(result, null, 2));
-              }
-            } catch (ex) {
-              console.error(ex);
-            }
-          }
-        ),
-      yargs
-    );
-  });
-});
-
-argv.help().argv;

package/operations.js

@@ -1,113 +0,0 @@
-function getOperation(resourceType, operation, sdk, args) {
-  // Generic function that can read a single entity from options
-  // e.g `cdf timeseries create --externalId=my.extid --name=my.name`
-  // or it reads a piped/buffered input
-  // e.g `cat timeseries.json | cdf timeseries create`
-  const argsOrPipedOperation = operation => {
-    return () => {
-      // Check if any normal arguments are sent
-      let createArgs;
-      if (Object.keys(args).length > 0) {
-        createArgs = [{ ...args }];
-      } else {
-        // Assume that stuff is piped
-        const buffer = process.argv[process.argv.length - 1];
-        createArgs = JSON.parse(buffer);
-      }
-      return sdk[resourceType][operation](createArgs);
-    };
-  };
-
-  const operationMap = {
-    list: function() {
-      let assetIds = args.assetIds;
-      switch (typeof assetIds) {
-        case 'number':
-          assetIds = [assetIds];
-          break;
-        case 'string':
-          if (assetIds.startsWith('[')) {
-            assetIds = assetIds.slice(1);
-          }
-          if (assetIds.endsWith(']')) {
-            assetIds = assetIds.slice(0, assetIds.length - 1);
-          }
-          const splitted = assetIds.split(',');
-          if (splitted.length > 1) {
-            assetIds = splitted.map(Number);
-          } else {
-            assetIds = [Number(assetIds)];
-          }
-          break;
-        default:
-          assetIds = undefined;
-      }
-      // Some list operations take more just one object
-      // Check if this function was called with any direct objects and pass them on
-      // ex. cdf revisions3D list 123123 --filter
-      // To make the code worse, make sure there's nothing undefined #javascript
-      const sdkArguments = [
-        ...arguments,
-        {
-          ...args,
-          assetIds,
-          limit: undefined,
-        },
-      ].filter(a => a !== undefined);
-      const promise = sdk[resourceType].list(...sdkArguments);
-      if (promise.autoPagingToArray) {
-        return promise.autoPagingToArray({ limit: args.limit });
-      }
-      return promise;
-    },
-
-    list3DNodes: function() {
-      const sdkArguments = [
-        ...arguments,
-        {
-          ...args,
-        },
-      ].filter(a => a !== undefined);
-
-      return sdk[resourceType].list3DNodes(...sdkArguments);
-    },
-
-    retrieve: () => {
-      const externalIds =
-        (args.externalIds && String(args.externalIds).split(',')) || [];
-      const ids = (args.ids && String(args.ids).split(',')) || [];
-      const allIds = [
-        ...ids.map(i => ({ id: i })),
-        ...externalIds.map(i => ({ externalId: i })),
-      ];
-
-      if (resourceType === 'datapoints') {
-        // This has to be handled separately.
-        const clonedArgs = {
-          ...args,
-          ids: undefined,
-          externalIds: undefined,
-        };
-        return sdk.datapoints.retrieve({ ...clonedArgs, items: allIds });
-      }
-      return sdk[resourceType].retrieve(allIds);
-    },
-
-    retrieveLatest: argsOrPipedOperation('retrieveLatest'),
-
-    search: () => sdk[resourceType].search(args),
-
-    create: argsOrPipedOperation('create'),
-
-    delete: argsOrPipedOperation('delete'),
-
-    update: argsOrPipedOperation('update'),
-  };
-  const func = operationMap[operation];
-  if (func) {
-    return func;
-  }
-  throw new Error(`${resourceType}.${operation} isn't implemented yet :-(`);
-}
-
-module.exports = getOperation;