@limetech/lime-web-components 5.14.0 → 5.16.0

package/dist/conditionregistry/conditionregistry.d.ts

@@ -0,0 +1,75 @@
+import { LimeObject } from '../limeobject';
+/**
+ * This interface defines callbacks intended to be registered to the {@link Condition} registry
+ *
+ * @alpha
+ * @group Conditions
+ */
+export type Condition<T = unknown> = {
+    /**
+     * The condition type, describing what to evaluate the condition for, for example "limeobject"
+     */
+    type: string;
+    evaluate: (subject: T, params: any) => boolean;
+    id: string;
+};
+/**
+ * A condition to evaluate for a {@link LimeObject}
+ *
+ * @alpha
+ * @group Conditions
+ */
+export type LimeObjectCondition = Condition<LimeObject> & {
+    type: 'limeobject';
+};
+/**
+ * Check if condition expects a lime object to be passed when it is evaluated
+ *
+ * @alpha
+ * @group Conditions
+ */
+export declare function isLimeObjectCondition(condition: Condition): condition is Condition<LimeObject>;
+/**
+ * Service for adding and retrieving, and checking {@link Condition}s to and from the condition registry
+ *
+ * @alpha
+ * @group Conditions
+ */
+export interface ConditionRegistry {
+    /**
+     * Add a {@link Condition} to the registry
+     *
+     * @param condition - the condition to pass to the registry
+     * @throws error if the id already exists in the registry
+     */
+    addCondition(condition: Condition): any;
+    /**
+     * Remove a {@link Condition} from the registry
+     *
+     * @param condition - the condition to remove
+     * @throws error if the id does not exist in the registry
+     */
+    removeCondition(condition: Condition): any;
+    /**
+     * Checks if a {@link Condition} exists on the registry
+     *
+     * @param id - id of the condition
+     * @returns true if it exists, false otherwise
+     */
+    hasCondition(id: string): boolean;
+    /**
+     * Gets all {@link Condition}s
+     *
+     * @returns a list of all existing conditions
+     */
+    getConditions(): Condition[];
+    /**
+     * Gets a {@link Condition} by id
+     *
+     * @param id - id of the condition
+     * @throws error if no condition was found with the specified id
+     * @returns the condition with the specified id
+     */
+    getCondition(id: string): Condition;
+}
+//# sourceMappingURL=conditionregistry.d.ts.map

package/dist/conditionregistry/conditionregistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditionregistry.d.ts","sourceRoot":"","sources":["../../src/conditionregistry/conditionregistry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,OAAO,IAAI;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAWb,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,KAAK,OAAO,CAAC;IAK/C,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,SAAS,CAAC,UAAU,CAAC,GAAG;IACtD,IAAI,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACjC,SAAS,EAAE,SAAS,GACrB,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,CAEpC;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,SAAS,OAAE;IAEnC;;;;;OAKG;IACH,eAAe,CAAC,SAAS,EAAE,SAAS,OAAE;IAEtC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;IAElC;;;;OAIG;IACH,aAAa,IAAI,SAAS,EAAE,CAAC;IAE7B;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC"}

package/dist/conditionregistry/conditionregistry.js

@@ -0,0 +1,9 @@
+/**
+ * Check if condition expects a lime object to be passed when it is evaluated
+ *
+ * @alpha
+ * @group Conditions
+ */
+export function isLimeObjectCondition(condition) {
+    return condition.type === 'limeobject';
+}

package/dist/conditionregistry/index.d.ts

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

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

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

package/dist/conditionregistry/index.js

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

package/dist/conditionregistry/types.d.ts

@@ -0,0 +1,15 @@
+import { ConditionRegistry as Service } from './conditionregistry';
+declare const SERVICE_NAME = "conditionRegistry";
+declare module '../core/platform' {
+    interface PlatformServiceNameType {
+        /**
+         * @see {@link Service | ConditionRegistry}
+         */
+        ConditionRegistry: typeof SERVICE_NAME;
+    }
+    interface LimeWebComponentPlatform {
+        get(name: PlatformServiceNameType['ConditionRegistry']): Service;
+    }
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/conditionregistry/types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,IAAI,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnE,QAAA,MAAM,YAAY,sBAAsB,CAAC;AAIzC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,YAAY,CAAC;KAC1C;IACD,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC;KACpE;CACJ"}

package/dist/conditionregistry/types.js

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

package/dist/es5/conditionregistry/conditionregistry.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLimeObjectCondition = void 0;
+function isLimeObjectCondition(condition) {
+    return condition.type === 'limeobject';
+}
+exports.isLimeObjectCondition = isLimeObjectCondition;

package/dist/es5/conditionregistry/index.js

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

package/dist/es5/conditionregistry/types.js

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

package/dist/es5/index.js

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

package/dist/index.d.ts

@@ -41,4 +41,5 @@ export * from './userdata';
 export * from './application';
 export * from './userpreferences';
 export * from './datetimeformatter';
+export * from './conditionregistry';
 //# 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,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,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"}

package/dist/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-web-components",
-  "version": "5.14.0",
+  "version": "5.16.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.36.4",
+    "@microsoft/api-extractor": "^7.38.0",
     "@types/jest": "^27.5.0",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "commitizen": "^4.3.0",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.49.0",
+    "eslint": "^8.50.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-plugin-ban": "^1.6.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",