@limetech/lime-web-components 5.10.0 → 5.12.0

package/dist/commandbus/commandbus.d.ts

@@ -176,4 +176,14 @@ export declare function Command(options: CommandOptions): (commandClass: Command
  * @group Command bus
  */
 export declare function getCommandId(value: object | CommandIdentifier): string;
+/**
+ * Get all registered ids of a command and its parent classes
+ *
+ * @param value - either a command or a command identifier
+ *
+ * @returns ids of the command
+ * @beta
+ * @group Command bus
+ */
+export declare function getCommandIds(value: object | CommandIdentifier): string[];
 //# sourceMappingURL=commandbus.d.ts.map

package/dist/commandbus/commandbus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commandbus.d.ts","sourceRoot":"","sources":["../../src/commandbus/commandbus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,MAAM,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,cAAc;IAC9C;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAEpE;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;IAE7B;;;;;;OAMG;IACH,WAAW,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAEnD;;;;;;OAMG;IACH,UAAU,CAAC,YAAY,EAAE,YAAY,GAAG,cAAc,CAAC;IAEvD;;;;;OAKG;IACH,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CACvD;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,GAAG,CAAC;AAEjE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,GAAG,GAAG,CAAC;CAClE;AAED;;;;GAIG;AACH,oBAAY,gBAAgB;IACxB;;;;;OAKG;IACH,QAAQ,qBAAqB;IAE7B;;;;OAIG;IACH,OAAO,oBAAoB;IAE3B;;;;OAIG;IACH,MAAM,mBAAmB;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG;IAClC;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;CAC9C;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,cAAc,kBACrB,YAAY,UAGrC;AAOD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,MAAM,CAgBtE"}
+{"version":3,"file":"commandbus.d.ts","sourceRoot":"","sources":["../../src/commandbus/commandbus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,MAAM,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,cAAc;IAC9C;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAEpE;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;IAE7B;;;;;;OAMG;IACH,WAAW,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAEnD;;;;;;OAMG;IACH,UAAU,CAAC,YAAY,EAAE,YAAY,GAAG,cAAc,CAAC;IAEvD;;;;;OAKG;IACH,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CACvD;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,GAAG,CAAC;AAEjE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,GAAG,GAAG,CAAC;CAClE;AAED;;;;GAIG;AACH,oBAAY,gBAAgB;IACxB;;;;;OAKG;IACH,QAAQ,qBAAqB;IAE7B;;;;OAIG;IACH,OAAO,oBAAoB;IAE3B;;;;OAIG;IACH,MAAM,mBAAmB;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG;IAClC;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;CAC9C;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,cAAc,kBACrB,YAAY,UAIrC;AAeD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,MAAM,CAgBtE;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,MAAM,EAAE,CAWzE"}

package/dist/commandbus/commandbus.js

@@ -37,12 +37,20 @@ export var CommandEventName;
 export function Command(options) {
     return (commandClass) => {
         setCommandId(commandClass, options.id);
+        setHasInstance(commandClass, options.id);
     };
 }
 function setCommandId(commandClass, id) {
     // eslint-disable-next-line @typescript-eslint/dot-notation
     commandClass['commandId'] = id;
 }
+function setHasInstance(commandClass, id) {
+    Object.defineProperty(commandClass, Symbol.hasInstance, {
+        value: (instance) => {
+            return getCommandIds(instance).includes(id);
+        },
+    });
+}
 /**
  * Get the registered id of the command
  *
@@ -66,3 +74,22 @@ export function getCommandId(value) {
     /* eslint-enable @typescript-eslint/dot-notation */
     return null;
 }
+/**
+ * Get all registered ids of a command and its parent classes
+ *
+ * @param value - either a command or a command identifier
+ *
+ * @returns ids of the command
+ * @beta
+ * @group Command bus
+ */
+export function getCommandIds(value) {
+    let ids = [];
+    let id;
+    let commandClass = value;
+    while ((id = getCommandId(commandClass))) {
+        ids = [...ids, id];
+        commandClass = Object.getPrototypeOf(commandClass);
+    }
+    return Array.from(new Set(ids));
+}

package/dist/commandbus/commandbus.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=commandbus.spec.d.ts.map

package/dist/commandbus/commandbus.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandbus.spec.d.ts","sourceRoot":"","sources":["../../src/commandbus/commandbus.spec.ts"],"names":[],"mappings":""}

package/dist/commandbus/commandbus.spec.js

@@ -0,0 +1,55 @@
+import { __decorate } from "tslib";
+/* eslint-disable max-classes-per-file */
+import { Command, getCommandIds } from './commandbus';
+var Webclient;
+(function (Webclient) {
+    let TestCommand = class TestCommand {
+    };
+    TestCommand = __decorate([
+        Command({
+            id: 'test',
+        })
+    ], TestCommand);
+    Webclient.TestCommand = TestCommand;
+    let MyTestCommand = class MyTestCommand extends TestCommand {
+    };
+    MyTestCommand = __decorate([
+        Command({
+            id: 'my-test',
+        })
+    ], MyTestCommand);
+    Webclient.MyTestCommand = MyTestCommand;
+})(Webclient || (Webclient = {}));
+var Addon;
+(function (Addon) {
+    let TestCommand = class TestCommand {
+    };
+    TestCommand = __decorate([
+        Command({
+            id: 'test',
+        })
+    ], TestCommand);
+    Addon.TestCommand = TestCommand;
+})(Addon || (Addon = {}));
+test.each([
+    [new Webclient.TestCommand(), ['test']],
+    [new Webclient.MyTestCommand(), ['my-test', 'test']],
+    ['test', ['test']],
+    [null, []],
+])('getCommandIds() with instance %s returns %j', (value, result) => {
+    expect(getCommandIds(value)).toEqual(result);
+});
+test.each([
+    [Webclient.TestCommand, ['test']],
+    [Webclient.MyTestCommand, ['my-test', 'test']],
+])('getCommandIds() with class %p returns %j', (value, result) => {
+    expect(getCommandIds(value)).toEqual(result);
+});
+test('instanceof returns true when class from another namespace has same command ID', () => {
+    const command = new Webclient.TestCommand();
+    expect(command).toBeInstanceOf(Addon.TestCommand);
+});
+test('instanceof returns true when sub-class from another namespace has same command ID', () => {
+    const command = new Webclient.MyTestCommand();
+    expect(command).toBeInstanceOf(Addon.TestCommand);
+});

package/dist/es5/commandbus/commandbus.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCommandId = exports.Command = exports.CommandEventName = void 0;
+exports.getCommandIds = exports.getCommandId = exports.Command = exports.CommandEventName = void 0;
+var tslib_1 = require("tslib");
 var CommandEventName;
 (function (CommandEventName) {
     CommandEventName["Received"] = "command.received";
@@ -10,12 +11,20 @@ var CommandEventName;
 function Command(options) {
     return function (commandClass) {
         setCommandId(commandClass, options.id);
+        setHasInstance(commandClass, options.id);
     };
 }
 exports.Command = Command;
 function setCommandId(commandClass, id) {
     commandClass['commandId'] = id;
 }
+function setHasInstance(commandClass, id) {
+    Object.defineProperty(commandClass, Symbol.hasInstance, {
+        value: function (instance) {
+            return getCommandIds(instance).includes(id);
+        },
+    });
+}
 function getCommandId(value) {
     if (typeof value === 'string') {
         return value;
@@ -29,3 +38,14 @@ function getCommandId(value) {
     return null;
 }
 exports.getCommandId = getCommandId;
+function getCommandIds(value) {
+    var ids = [];
+    var id;
+    var commandClass = value;
+    while ((id = getCommandId(commandClass))) {
+        ids = tslib_1.__spreadArray(tslib_1.__spreadArray([], ids, true), [id], false);
+        commandClass = Object.getPrototypeOf(commandClass);
+    }
+    return Array.from(new Set(ids));
+}
+exports.getCommandIds = getCommandIds;

package/dist/es5/commandbus/commandbus.spec.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var commandbus_1 = require("./commandbus");
+var Webclient;
+(function (Webclient) {
+    var TestCommand = (function () {
+        function TestCommand() {
+        }
+        TestCommand = tslib_1.__decorate([
+            (0, commandbus_1.Command)({
+                id: 'test',
+            })
+        ], TestCommand);
+        return TestCommand;
+    }());
+    Webclient.TestCommand = TestCommand;
+    var MyTestCommand = (function (_super) {
+        tslib_1.__extends(MyTestCommand, _super);
+        function MyTestCommand() {
+            return _super !== null && _super.apply(this, arguments) || this;
+        }
+        MyTestCommand = tslib_1.__decorate([
+            (0, commandbus_1.Command)({
+                id: 'my-test',
+            })
+        ], MyTestCommand);
+        return MyTestCommand;
+    }(TestCommand));
+    Webclient.MyTestCommand = MyTestCommand;
+})(Webclient || (Webclient = {}));
+var Addon;
+(function (Addon) {
+    var TestCommand = (function () {
+        function TestCommand() {
+        }
+        TestCommand = tslib_1.__decorate([
+            (0, commandbus_1.Command)({
+                id: 'test',
+            })
+        ], TestCommand);
+        return TestCommand;
+    }());
+    Addon.TestCommand = TestCommand;
+})(Addon || (Addon = {}));
+test.each([
+    [new Webclient.TestCommand(), ['test']],
+    [new Webclient.MyTestCommand(), ['my-test', 'test']],
+    ['test', ['test']],
+    [null, []],
+])('getCommandIds() with instance %s returns %j', function (value, result) {
+    expect((0, commandbus_1.getCommandIds)(value)).toEqual(result);
+});
+test.each([
+    [Webclient.TestCommand, ['test']],
+    [Webclient.MyTestCommand, ['my-test', 'test']],
+])('getCommandIds() with class %p returns %j', function (value, result) {
+    expect((0, commandbus_1.getCommandIds)(value)).toEqual(result);
+});
+test('instanceof returns true when class from another namespace has same command ID', function () {
+    var command = new Webclient.TestCommand();
+    expect(command).toBeInstanceOf(Addon.TestCommand);
+});
+test('instanceof returns true when sub-class from another namespace has same command ID', function () {
+    var command = new Webclient.MyTestCommand();
+    expect(command).toBeInstanceOf(Addon.TestCommand);
+});

package/dist/limeobject/commands/create-dialog.d.ts

@@ -26,6 +26,7 @@ export declare class CreateLimeobjectDialogCommand {
      */
     route?: boolean;
     title?: string;
+    subtitle?: string;
     context?: LimeWebComponentContext;
     /**
      * @beta

package/dist/limeobject/commands/create-dialog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-dialog.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/create-dialog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;;;;;;GAWG;AACH,qBAGa,6BAA6B;IACtC;;OAEG;IACI,QAAQ,EAAE,QAAQ,CAAC;IAE1B;;OAEG;IACI,UAAU,CAAC,EAAE,GAAG,CAAC;IAExB;;OAEG;IACI,KAAK,CAAC,EAAE,OAAO,CAAS;IAKxB,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,OAAO,CAAC,EAAE,uBAAuB,CAAC;IAEzC;;;;OAIG;IACI,WAAW,CAAC,EAAE,GAAG,CAAC;CAC5B"}
+{"version":3,"file":"create-dialog.d.ts","sourceRoot":"","sources":["../../../src/limeobject/commands/create-dialog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;;;;;;GAWG;AACH,qBAGa,6BAA6B;IACtC;;OAEG;IACI,QAAQ,EAAE,QAAQ,CAAC;IAE1B;;OAEG;IACI,UAAU,CAAC,EAAE,GAAG,CAAC;IAExB;;OAEG;IACI,KAAK,CAAC,EAAE,OAAO,CAAS;IAKxB,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAKlB,OAAO,CAAC,EAAE,uBAAuB,CAAC;IAEzC;;;;OAIG;IACI,WAAW,CAAC,EAAE,GAAG,CAAC;CAC5B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-web-components",
-  "version": "5.10.0",
+  "version": "5.12.0",
   "description": "Lime Web Components",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -35,13 +35,13 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^16.2.4",
-    "@microsoft/api-extractor": "^7.34.7",
+    "@microsoft/api-extractor": "^7.34.9",
     "@types/jest": "^27.5.0",
-    "@typescript-eslint/eslint-plugin": "^5.59.2",
-    "@typescript-eslint/parser": "^5.59.2",
+    "@typescript-eslint/eslint-plugin": "^5.59.6",
+    "@typescript-eslint/parser": "^5.59.6",
     "commitizen": "^4.3.0",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.39.0",
+    "eslint": "^8.40.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-ban": "^1.6.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",