@c8y/websdk 1019.0.3

package/README.md

@@ -0,0 +1,54 @@
+**`@c8y/websdk` Package Overview**
+
+The @c8y/websdk Angular schematic enables quick scaffolding of custom Cumulocity applications. It sets up an Angular environment integrated with essential Cumulocity features, allowing developers to efficiently focus on creating unique IoT solutions within the Cumulocity platform.
+
+# How to use
+
+## Install
+Install the Angular 16 `@angular/cli` package.
+
+```bash
+npm install @angular/cli@v16-lts -g
+```
+
+Generate a new Angular 16 application:
+
+```bash
+ng new <appName> --interactive=false --routing=true --style=less
+```
+
+Navigate to the application directory:
+
+```bash
+cd <appName>
+```
+
+Use the `ng add` command to include `@c8y/websdk`, and follow the prompts.
+
+```bash
+ng add @c8y/websdk
+```
+
+Bypass prompts:
+
+```bash
+ng add @c8y/websdk --application=@c8y/<appName>@<version> --skip-confirmation
+```
+
+> Note: In the **bypass prompts** scenario:
+> - `<appName>` must be one of the following: administration, application, cockpit, codex, devicemanagement, hybrid, package-blueprint, tutorial, widget-plugin.
+> - `<version>` denotes the specific package version listed in the npm registry.
+
+## Run development server & build
+
+Launch the development server:
+
+```bash
+ng serve -u https://<yourTenant>.latest.stage.c8y.io/
+```
+
+Build the application:
+
+```bash
+ng build <appName>
+```

package/dist/app-list.json

@@ -0,0 +1 @@
+["administration","application","cockpit","codex","devicemanagement","hybrid","package-blueprint","tutorial","widget-plugin"]

package/dist/collection.json

@@ -0,0 +1,9 @@
+{
+  "schematics": {
+    "ng-add": {
+      "description": "Adds Cumulocity IoT application to the project.",
+      "factory": "./ng-add/index#ngAdd",
+      "schema": "./ng-add/ng-add.json"
+    }
+  }
+}

package/dist/ng-add/index.d.ts

@@ -0,0 +1,9 @@
+import { SchematicContext, Tree } from '@angular-devkit/schematics';
+import { CumulocityNgAddOptions } from './ng-add.model';
+/**
+ * This function adds a rule to the tree using the provided commandline options, predefined
+ * application options and module definitions.
+ * @param options - The options provided via commandline.
+ * @return a Rule function which applies the addition to the Tree and SchematicContext.
+ */
+export declare function ngAdd(options: CumulocityNgAddOptions): (tree: Tree, context: SchematicContext) => Promise<void>;

package/dist/ng-add/index.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ngAdd = void 0;
+const tasks_1 = require("@angular-devkit/schematics/tasks");
+const inquirer = require("inquirer");
+const helpers_1 = require("yargs/helpers");
+const pacote = require("pacote");
+const yargs = require("yargs");
+const fs_extra_1 = require("fs-extra");
+const dependencies_1 = require("@schematics/angular/utility/dependencies");
+const path_1 = require("path");
+/**
+ * This function adds a rule to the tree using the provided commandline options, predefined
+ * application options and module definitions.
+ * @param options - The options provided via commandline.
+ * @return a Rule function which applies the addition to the Tree and SchematicContext.
+ */
+function ngAdd(options) {
+    /**
+     * Return a Rule that applies the addition to the Tree and SchematicContext.
+     */
+    return async (tree, context) => {
+        const argv = await yargs((0, helpers_1.hideBin)(process.argv)).argv;
+        const registry = argv.registry || 'https://registry.npmjs.org/';
+        const { appName, selectedVersion } = await getApplicationNameAndVersion(options.application, registry);
+        triggerDevkitNgAdd(appName, selectedVersion, tree, context, options);
+    };
+}
+exports.ngAdd = ngAdd;
+async function getApplicationNameAndVersion(argAppPackage, registry) {
+    // case 0: ''
+    if (!argAppPackage) {
+        const appName = await chooseProjectToScaffoldFrom();
+        const shownVersions = await getAllRelevantVersions(appName, registry);
+        const selectedVersion = await selectBaseVersion(shownVersions);
+        return { appName, selectedVersion };
+    }
+    const splitted = argAppPackage.split('@');
+    const isScoped = argAppPackage.startsWith('@');
+    // case 1: @c8y/cockpit@10.12.2 --> do not show any prompt
+    if (isScoped && splitted.length === 3) {
+        const [, appName, selectedVersion] = splitted;
+        return { appName: '@' + appName, selectedVersion };
+    }
+    // case 2: @c8y/cockpit
+    if (isScoped && splitted.length === 2) {
+        const appName = argAppPackage;
+        const shownVersions = await getAllRelevantVersions(appName, registry);
+        const selectedVersion = await selectBaseVersion(shownVersions);
+        return { appName, selectedVersion };
+    }
+    // case 3: cockpit
+    if (!isScoped && splitted.length === 1) {
+        const appName = argAppPackage;
+        const shownVersions = await getAllRelevantVersions(appName, registry);
+        const selectedVersion = await selectBaseVersion(shownVersions);
+        return { appName, selectedVersion };
+    }
+    // case 4: cockpit@10.10.10
+    if (!isScoped && splitted.length === 2) {
+        const [appName, selectedVersion] = splitted;
+        return { appName, selectedVersion };
+    }
+    // case 5: should actually not exist?!
+    return { appName: argAppPackage, selectedVersion: 'latest' };
+}
+function triggerDevkitNgAdd(appName, selectedVersion, tree, context, options) {
+    const dependencies = [
+        {
+            name: appName,
+            version: selectedVersion,
+            type: dependencies_1.NodeDependencyType.Dev
+        }
+    ];
+    dependencies.forEach(dependency => (0, dependencies_1.addPackageJsonDependency)(tree, dependency));
+    const taskId = context.addTask(new tasks_1.NodePackageInstallTask());
+    context.addTask(new tasks_1.RunSchematicTask('@c8y/devkit', 'ng-add', {
+        collection: null,
+        ...options,
+        application: appName
+    }), [taskId]);
+}
+async function chooseProjectToScaffoldFrom() {
+    const pathToAppList = (0, path_1.join)(__dirname, '../app-list.json');
+    const choices = await (0, fs_extra_1.readJson)(pathToAppList);
+    return inquirer
+        .prompt([
+        {
+            type: 'list',
+            name: 'base_project',
+            message: 'Which base project do you want to scaffold from?',
+            choices
+        }
+    ])
+        .then((input) => {
+        return `@c8y/${input.base_project}`;
+    });
+}
+async function selectBaseVersion(shownVersions) {
+    return inquirer
+        .prompt([
+        {
+            type: 'list',
+            name: 'base_version',
+            message: 'Which base version do you want to scaffold from?',
+            choices: shownVersions
+        }
+    ])
+        .then(async (answers) => {
+        if (answers.base_version.includes('latest') || answers.base_version.includes('next')) {
+            // Check if latest or next was selected and clean the string to include only the version.
+            answers.base_version = answers.base_version.split(' (')[0];
+        }
+        else if (answers.base_version === 'other') {
+            answers.base_version = await otherVersionSelectedPrompt();
+        }
+        return answers.base_version;
+    });
+}
+function otherVersionSelectedPrompt() {
+    return inquirer
+        .prompt([
+        {
+            type: 'input',
+            name: 'version_choice',
+            message: 'Enter the desired version: '
+        }
+    ])
+        .then((input) => {
+        return input.version_choice;
+    });
+}
+function getAllRelevantVersions(appName, registry) {
+    return pacote.packument(appName, { registry }).then(async (packument) => {
+        const versionList = Object.keys(packument.versions);
+        return [packument['dist-tags'].latest, ...versionList, 'other'];
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/ng-add/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ng-add/index.ts"],"names":[],"mappings":";;;AACA,4DAA4F;AAC5F,qCAAqC;AACrC,2CAAwC;AACxC,iCAAiC;AACjC,+BAA+B;AAC/B,uCAAoC;AACpC,2EAIkD;AAClD,+BAA4B;AAG5B;;;;;GAKG;AACH,SAAgB,KAAK,CAAC,OAA+B;IACnD;;OAEG;IACH,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACrD,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QACrD,MAAM,QAAQ,GAAI,IAAI,CAAC,QAAmB,IAAI,6BAA6B,CAAC;QAC5E,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,MAAM,4BAA4B,CACrE,OAAO,CAAC,WAAW,EACnB,QAAQ,CACT,CAAC;QACF,kBAAkB,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC,CAAC;AACJ,CAAC;AAbD,sBAaC;AAED,KAAK,UAAU,4BAA4B,CAAC,aAAa,EAAE,QAAQ;IACjE,aAAa;IACb,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,OAAO,GAAG,MAAM,2BAA2B,EAAE,CAAC;QACpD,MAAM,aAAa,GAAG,MAAM,sBAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACtE,MAAM,eAAe,GAAG,MAAM,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAC/D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;KACrC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,QAAQ,GAAG,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAE/C,0DAA0D;IAC1D,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACrC,MAAM,CAAC,EAAE,OAAO,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAC;QAC9C,OAAO,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,EAAE,eAAe,EAAE,CAAC;KACpD;IAED,uBAAuB;IACvB,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACrC,MAAM,OAAO,GAAG,aAAa,CAAC;QAC9B,MAAM,aAAa,GAAG,MAAM,sBAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACtE,MAAM,eAAe,GAAG,MAAM,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAC/D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;KACrC;IAED,kBAAkB;IAClB,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACtC,MAAM,OAAO,GAAG,aAAa,CAAC;QAC9B,MAAM,aAAa,GAAG,MAAM,sBAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACtE,MAAM,eAAe,GAAG,MAAM,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAC/D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;KACrC;IAED,2BAA2B;IAC3B,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACtC,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAC;QAC5C,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;KACrC;IAED,sCAAsC;IACtC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,kBAAkB,CACzB,OAAe,EACf,eAAuB,EACvB,IAAU,EACV,OAAyB,EACzB,OAA+B;IAE/B,MAAM,YAAY,GAAqB;QACrC;YACE,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,eAAe;YACxB,IAAI,EAAE,iCAAkB,CAAC,GAAG;SAC7B;KACF,CAAC;IACF,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,IAAA,uCAAwB,EAAC,IAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IACtF,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,8BAAsB,EAAE,CAAC,CAAC;IAC7D,OAAO,CAAC,OAAO,CACb,IAAI,wBAAgB,CAAC,aAAa,EAAE,QAAQ,EAAE;QAC5C,UAAU,EAAE,IAAI;QAChB,GAAG,OAAO;QACV,WAAW,EAAE,OAAO;KACrB,CAAC,EACF,CAAC,MAAM,CAAC,CACT,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,2BAA2B;IACxC,MAAM,aAAa,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAG,MAAM,IAAA,mBAAQ,EAAC,aAAa,CAAC,CAAC;IAC9C,OAAO,QAAQ;SACZ,MAAM,CAAC;QACN;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,kDAAkD;YAC3D,OAAO;SACR;KACF,CAAC;SACD,IAAI,CAAC,CAAC,KAAU,EAAE,EAAE;QACnB,OAAO,QAAQ,KAAK,CAAC,YAAY,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;AACP,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,aAAuB;IACtD,OAAO,QAAQ;SACZ,MAAM,CAAC;QACN;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,kDAAkD;YAC3D,OAAO,EAAE,aAAa;SACvB;KACF,CAAC;SACD,IAAI,CAAC,KAAK,EAAE,OAAY,EAAE,EAAE;QAC3B,IAAI,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACpF,yFAAyF;YACzF,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5D;aAAM,IAAI,OAAO,CAAC,YAAY,KAAK,OAAO,EAAE;YAC3C,OAAO,CAAC,YAAY,GAAG,MAAM,0BAA0B,EAAE,CAAC;SAC3D;QACD,OAAO,OAAO,CAAC,YAAY,CAAC;IAC9B,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,0BAA0B;IACjC,OAAO,QAAQ;SACZ,MAAM,CAAC;QACN;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,6BAA6B;SACvC;KACF,CAAC;SACD,IAAI,CAAC,CAAC,KAAU,EAAE,EAAE;QACnB,OAAO,KAAK,CAAC,cAAc,CAAC;IAC9B,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,sBAAsB,CAAC,OAAe,EAAE,QAAgB;IAC/D,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,SAAc,EAAE,EAAE;QAC3E,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,GAAG,WAAW,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/ng-add/ng-add.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "c8y-ng-add",
+  "title": "Cumulocity schematic",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The name of the project.",
+      "$default": {
+        "$source": "projectName"
+      }
+    },
+    "application": {
+      "type": "string"
+    }
+  }
+}

package/dist/ng-add/ng-add.model.d.ts

@@ -0,0 +1,4 @@
+export interface CumulocityNgAddOptions {
+    application: string;
+    project: string;
+}

package/dist/ng-add/ng-add.model.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ng-add.model.js.map

package/dist/ng-add/ng-add.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ng-add.model.js","sourceRoot":"","sources":["../../ng-add/ng-add.model.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@c8y/websdk",
+  "version": "1019.0.3",
+  "description": "Allows to scaffold a Cumulocity IoT application with ng add @c8y/websdk",
+  "license": "Apache-2.0",
+  "scripts": {
+    "test": "jest",
+    "build": "rimraf ./dist && tsc -p ./tsconfig.json && yarn build:applist",
+    "postbuild": "mkdirp ./dist/ng-add/ && yarn copy:schemas",
+    "copy:schemas": "npx ncp ./collection.json ./dist/collection.json && npx ncp ./ng-add/ng-add.json ./dist/ng-add/ng-add.json",
+    "build:applist": "ts-node ./tools/app-list-extract.ts"
+  },
+  "schematics": "./dist/collection.json",
+  "files": [
+    "dist/"
+  ],
+  "dependencies": {
+    "yargs": "17.7.2"
+  },
+  "devDependencies": {
+    "mkdirp": "3.0.1",
+    "ts-node": "10.9.1"
+  },
+  "author": ""
+}