@limetech/lime-web-components 5.23.1 → 5.25.0

package/dist/action/action.d.ts

@@ -17,11 +17,7 @@ export interface Action<T extends AnyCommand = AnyCommand> {
     /**
      * Icon of the action
      */
-    icon?: string;
-    /**
-     * Color of the icon
-     */
-    color?: string;
+    icon?: string | Icon;
     /**
      * Label to display on or next to the action.
      * The label will be translated by the {@link Translator}
@@ -50,4 +46,32 @@ export type LimeObjectAction = Action<LimeObjectCommand>;
  * @group Actions
  */
 export type LimeObjectBulkAction = Action<LimeObjectBulkCommand>;
+/**
+ * Icon of an action
+ *
+ * @alpha
+ * @group Actions
+ */
+export type Icon = {
+    /**
+     * Name of the icon
+     */
+    name: string;
+    /**
+     * Color of the icon.
+     */
+    color?: string;
+    /**
+     * Background color of the icon.
+     */
+    backgroundColor?: string;
+    /**
+     * The `title` attribute of the icon.
+     * Used primarily to improve accessibility for users who
+     * take advantage of assistive technologies; but also
+     * to clarify further what an icon tries to resemble
+     * for sighted users.
+     */
+    title?: string;
+};
 //# sourceMappingURL=action.d.ts.map

package/dist/action/action.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/action/action.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,UAAU,EACV,qBAAqB,EACrB,iBAAiB,EACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAMjD;;;;GAIG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IACrD;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC;IAEX;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/action/action.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,UAAU,EACV,qBAAqB,EACrB,iBAAiB,EACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAMjD;;;;GAIG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IACrD;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC;IAEX;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAEjE;;;;;GAKG;AACH,MAAM,MAAM,IAAI,GAAG;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/es5/index.js

@@ -24,3 +24,4 @@ tslib_1.__exportStar(require("./application"), exports);
 tslib_1.__exportStar(require("./userpreferences"), exports);
 tslib_1.__exportStar(require("./datetimeformatter"), exports);
 tslib_1.__exportStar(require("./conditionregistry"), exports);
+tslib_1.__exportStar(require("./view"), exports);

package/dist/es5/view/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./registry"), exports);
+tslib_1.__exportStar(require("./types"), exports);

package/dist/es5/view/registry.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es5/view/types.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var platform_1 = require("../core/platform");
+var SERVICE_NAME = 'viewFactoryRegistry';
+platform_1.PlatformServiceName.ViewFactoryRegistry = SERVICE_NAME;

package/dist/index.d.ts

@@ -43,4 +43,5 @@ export * from './application';
 export * from './userpreferences';
 export * from './datetimeformatter';
 export * from './conditionregistry';
+export * from './view';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,QAAQ,CAAC"}

package/dist/index.js

@@ -43,3 +43,4 @@ export * from './application';
 export * from './userpreferences';
 export * from './datetimeformatter';
 export * from './conditionregistry';
+export * from './view';

package/dist/view/index.d.ts

@@ -0,0 +1,3 @@
+export * from './registry';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/view/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/view/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC"}

package/dist/view/index.js

@@ -0,0 +1,2 @@
+export * from './registry';
+export * from './types';

package/dist/view/registry.d.ts

@@ -0,0 +1,64 @@
+import { LimeWebComponentContext } from '../core';
+import { LimeObject } from '../limeobject';
+/**
+ * Registry for view factories
+ *
+ * A view factory is used to create a view for a {@link LimeObject}.
+ * Multiple factories can be registered for the same view type, and when that
+ * is done the factory returned from {@link ViewFactoryRegistry.getFactory} will
+ * invoke each one in the order that they were added, using the return value
+ * from each factory as input for the next factory in the chain.
+ *
+ * @example Registering a view factory
+ * ```ts
+ * const factory = (
+ *      limeobject: LimeObject,
+ *      context: LimeWebComponentContext,
+ *      view?: ListItem
+ * ): ListItem => {
+ *      return {
+ *          ...view,
+ *          icon: 'dog',
+ *      };
+ * };
+ * registry.registerFactory('list', factory);
+ * ```
+ *
+ * @example Using a factory to create a view
+ * ```ts
+ * const createListItem = registry.getFactory('list');
+ * const listItem = createListItem(limeobject, context);
+ * ```
+ *
+ * @alpha
+ * @group Views
+ */
+export interface ViewFactoryRegistry {
+    /**
+     * Get a factory for the given view type
+     *
+     * @param type - the type of view to get a factory for
+     * @returns a factory for the given view type
+     */
+    getFactory<T = unknown>(type: string): ViewFactory<T> | undefined;
+    /**
+     * Register a factory for a given view type
+     *
+     * @param type - the type of view to get a factory for
+     * @param factory - factory function to create a view of the specific type
+     */
+    registerFactory<T = unknown>(type: string, factory: ViewFactory<T>): void;
+}
+/**
+ * Factory to create a view for a {@link LimeObject}
+ *
+ * @param limeobject - the limeobject to create a view for
+ * @param context - the context of the web component rendering the view
+ * @param view - the view as it was created by the previous factory, or
+ * `undefined` if this is the first factory in the chain
+ *
+ * @alpha
+ * @group Views
+ */
+export type ViewFactory<T = unknown> = (limeobject: LimeObject, context: LimeWebComponentContext, view?: T) => T | undefined;
+//# sourceMappingURL=registry.d.ts.map

package/dist/view/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/view/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;;OAKG;IACH,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAElE;;;;;OAKG;IACH,eAAe,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAC7E;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,CACnC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,uBAAuB,EAChC,IAAI,CAAC,EAAE,CAAC,KACP,CAAC,GAAG,SAAS,CAAC"}

package/dist/view/registry.js

@@ -0,0 +1 @@
+export {};

package/dist/view/types.d.ts

@@ -0,0 +1,19 @@
+import { ViewFactoryRegistry } from './registry';
+declare const SERVICE_NAME = "viewFactoryRegistry";
+declare module '../core/platform' {
+    interface PlatformServiceNameType {
+        /**
+         * @alpha
+         * @see {@link ViewFactoryRegistry}
+         */
+        ViewFactoryRegistry: typeof SERVICE_NAME;
+    }
+    interface LimeWebComponentPlatform {
+        /**
+         * @alpha
+         */
+        get(name: PlatformServiceNameType['ViewFactoryRegistry']): ViewFactoryRegistry;
+    }
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/view/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/view/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAGjD,QAAA,MAAM,YAAY,wBAAwB,CAAC;AAI3C,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;;WAGG;QACH,mBAAmB,EAAE,OAAO,YAAY,CAAC;KAC5C;IAED,UAAU,wBAAwB;QAC9B;;WAEG;QACH,GAAG,CACC,IAAI,EAAE,uBAAuB,CAAC,qBAAqB,CAAC,GACrD,mBAAmB,CAAC;KAC1B;CACJ"}

package/dist/view/types.js

@@ -0,0 +1,3 @@
+import { PlatformServiceName } from '../core/platform';
+const SERVICE_NAME = 'viewFactoryRegistry';
+PlatformServiceName.ViewFactoryRegistry = SERVICE_NAME;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-web-components",
-  "version": "5.23.1",
+  "version": "5.25.0",
   "description": "Lime Web Components",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -9,7 +9,8 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist/",
-    "testing"
+    "testing",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "tsc && tsc -p tsconfig.es5.json",
@@ -34,28 +35,28 @@
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^16.2.4",
-    "@microsoft/api-extractor": "^7.38.5",
+    "@commitlint/config-conventional": "^18.6.0",
+    "@microsoft/api-extractor": "^7.39.5",
     "@types/jest": "^27.5.0",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
     "commitizen": "^4.3.0",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.55.0",
-    "eslint-config-prettier": "^8.10.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-ban": "^1.6.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-prettier": "^5.1.3",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-sonarjs": "^0.23.0",
     "eslint-plugin-tsdoc": "^0.2.17",
     "jest": "^27.5.1",
     "jest-cli": "^27.5.1",
-    "prettier": "^2.8.8",
-    "replace-in-file": "^6.3.5",
+    "prettier": "^3.2.5",
+    "replace-in-file": "^7.1.0",
     "shelljs": "0.8.5",
     "typedoc": "^0.23.24",
-    "typedoc-plugin-markdown": "~2.4.2",
+    "typedoc-plugin-markdown": "~3.15.0",
     "typescript": "^4.9.5",
     "yargs": "^17.7.2"
   },