@limetech/lime-web-components 5.0.1 → 5.2.0

package/dist/translator/translator.d.ts

@@ -1,13 +1,16 @@
 /**
  * Service for translating strings into different languages
+ * @public
+ * @group Localization
  */
 export interface Translator {
     /**
      * Get a translated string by ID
      *
-     * @param {string} id id of the translation
-     * @param {object} params any parameters that the translation might require
-     * @returns {string} the translation
+     * @param id - id of the translation
+     * @param params - any parameters that the translation might require
+     * @returns the translation
      */
     get(id: string, params?: Record<string, string | number | undefined>): string;
 }
+//# sourceMappingURL=translator.d.ts.map

package/dist/translator/translator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translator.d.ts","sourceRoot":"","sources":["../../src/translator/translator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACvB;;;;;;OAMG;IACH,GAAG,CACC,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GACrD,MAAM,CAAC;CACb"}

package/dist/translator/types.d.ts

@@ -12,3 +12,4 @@ declare module '../core/platform' {
     }
 }
 export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/translator/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C,QAAA,MAAM,YAAY,cAAc,CAAC;AAIjC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,SAAS,EAAE,OAAO,YAAY,CAAC;KAClC;IAED,UAAU,wBAAwB;QAC9B,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC;KAC/D;CACJ"}

package/dist/userdata/decorator.d.ts

@@ -1,6 +1,8 @@
 import { StateOptions } from '../core';
 /**
  * Config for the {@link SelectUserData} state decorator
+ * @public
+ * @group User data
  */
 export interface SelectUserDataOptions extends StateOptions {
     /**
@@ -11,7 +13,10 @@ export interface SelectUserDataOptions extends StateOptions {
 /**
  * Gets an object with all user data, optionally filtered by key
  *
- * @param {SelectUserDataOptions} options state decorator options
- * @returns {PropertyDecorator} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group User data
  */
 export declare function SelectUserData(options?: SelectUserDataOptions): PropertyDecorator;
+//# sourceMappingURL=decorator.d.ts.map

package/dist/userdata/decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../src/userdata/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEf,MAAM,SAAS,CAAC;AAGjB;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACvD;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC1B,OAAO,GAAE,qBAA0B,GACpC,iBAAiB,CAMnB"}

package/dist/userdata/decorator.js

@@ -3,8 +3,10 @@ import { createStateDecorator } from '../core/decorators/factory';
 /**
  * Gets an object with all user data, optionally filtered by key
  *
- * @param {SelectUserDataOptions} options state decorator options
- * @returns {PropertyDecorator} state decorator
+ * @param options - state decorator options
+ * @returns state decorator
+ * @public
+ * @group User data
  */
 export function SelectUserData(options = {}) {
     const config = {

package/dist/userdata/index.d.ts

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

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

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

package/dist/userdata/repository.d.ts

@@ -2,28 +2,30 @@ import { StateRepository } from '../core';
 /**
  * Handle fetching and saving user specific data, e.g. settings or other state
  * data that should persist between sessions
- *
+ * @public
+ * @group User data
  */
 export interface UserDataRepository extends StateRepository {
     /**
      * Check if user data exists
      *
-     * @param key name of the key containing the data
+     * @param key - name of the key containing the data
      * @returns true if user data exists
      */
     has(key: string): boolean;
     /**
      * Get user data
      *
-     * @param key name of the key containing the data
+     * @param key - name of the key containing the data
      * @returns the data
      */
     get<T = any>(key: string): T;
     /**
      * Set user data
      *
-     * @param key name of the key for the data
-     * @param data the data to save, will delete the data if undefined
+     * @param key - name of the key for the data
+     * @param data - the data to save, will delete the data if undefined
      */
     set<T = any>(key: string, data?: T): void;
 }
+//# sourceMappingURL=repository.d.ts.map

package/dist/userdata/repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/userdata/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACvD;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B;;;;;OAKG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;CAC7C"}

package/dist/userdata/types.d.ts

@@ -12,3 +12,4 @@ declare module '../core/platform' {
     }
 }
 export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/userdata/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD,QAAA,MAAM,YAAY,oBAAoB,CAAC;AAIvC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,kBAAkB,EAAE,OAAO,YAAY,CAAC;KAC3C;IAED,UAAU,wBAAwB;QAC9B,GAAG,CACC,IAAI,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,GACpD,kBAAkB,CAAC;KACzB;CACJ"}

package/dist/userpreferences/index.d.ts

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

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

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

package/dist/userpreferences/index.js

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

package/dist/userpreferences/repository.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Handle fetching and saving user preferences.
+ * @alpha
+ */
+export interface UserPreferencesRepository {
+    /**
+     * Get the current user preferences.
+     *
+     * @param key - Supply the key for a specific preference to get only that value.
+     * @returns If a key is supplied, the value stored under that key is returned. If no key is supplied, an object with all preferences is returned instead.
+     */
+    get<T = any>(key?: string): T;
+    /**
+     * Set or delete the value for a specific user preference.
+     *
+     * @note The value set must be serializable as JSON. If non-serializable data is given, it might result in an error, but more likely, the data will simply be lost.
+     *
+     * @param key - The key to store the value under.
+     * @param data - The data to save. Leave undefined to instead delete the currently stored value.
+     */
+    set<T = any>(key: string, data?: T): void;
+    /**
+     * Get the schema for the user preferences.
+     */
+    getSchema(): Record<string, unknown>;
+}
+//# sourceMappingURL=repository.d.ts.map

package/dist/userpreferences/repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/userpreferences/repository.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;;OAKG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC;IAE9B;;;;;;;OAOG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC"}

package/dist/userpreferences/repository.js

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

package/dist/userpreferences/types.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/userpreferences/types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAEzD,QAAA,MAAM,YAAY,oBAAoB,CAAC;AAIvC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,yBAAyB,EAAE,OAAO,YAAY,CAAC;KAClD;IAED,UAAU,wBAAwB;QAC9B,GAAG,CACC,IAAI,EAAE,uBAAuB,CAAC,2BAA2B,CAAC,GAC3D,yBAAyB,CAAC;KAChC;CACJ"}

package/dist/userpreferences/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-web-components",
-  "version": "5.0.1",
+  "version": "5.2.0",
   "description": "Lime Web Components",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -13,51 +13,51 @@
   ],
   "scripts": {
     "build": "tsc && tsc -p tsconfig.es5.json",
-    "start": "npm run generate-api-docs && docz dev",
+    "start": "tsc --watch",
     "test": "stencil test --spec",
-    "docz:build": "npm run generate-api-docs && docz build",
-    "docz:publish": "node publish-docs.js",
-    "generate-api-docs": "typedoc && node transform-docs.js",
+    "docs": "typedoc",
+    "docs:publish": "node publish-docs.js",
+    "api:update": "npm run build && api-extractor run --local --verbose",
+    "api:verify": "api-extractor run",
     "lint": "npm run lint:src && npm run lint:json",
     "lint:fix": "npm run lint:src:fix && npm run lint:json:fix",
     "lint:json": "prettier -l '{!(package*).json,packages/*/!(package*).json,.prettierrc}'",
     "lint:json:fix": "prettier --write '{!(package*).json,packages/*/!(package*).json,.prettierrc}'",
     "lint:src": "eslint '**/*.{ts,js}' --max-warnings=0",
     "lint:src:fix": "eslint '**/*.{ts,js}' --fix --max-warnings=0",
-    "postpublish": "npm run docz:publish -- --v=current",
-    "postpublish:dry-run": "npm run docz:publish -- --v=current --dryRun"
+    "postpublish": "npm run docs:publish -- --v=current",
+    "postpublish:dry-run": "npm run docs:publish -- --v=current --dryRun"
   },
   "dependencies": {
-    "rxjs": "^7.5.6",
-    "tslib": "^2.4.0"
+    "@stencil/core": "^2.22.1",
+    "rxjs": "^7.8.0",
+    "tslib": "^2.4.1"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^16.2.4",
-    "@stencil/core": "^2.18.0",
+    "@microsoft/api-extractor": "^7.33.7",
     "@types/jest": "^27.5.0",
-    "@typescript-eslint/eslint-plugin": "^5.38.0",
-    "@typescript-eslint/parser": "^5.38.0",
-    "commitizen": "^4.2.5",
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "@typescript-eslint/parser": "^5.49.0",
+    "commitizen": "^4.2.6",
     "cz-conventional-changelog": "^3.3.0",
-    "docz": "0.12.5",
-    "eslint": "^8.23.1",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jsdoc": "^37.9.7",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-ban": "^1.6.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-react": "^7.31.8",
-    "eslint-plugin-sonarjs": "^0.15.0",
+    "eslint-plugin-react": "^7.32.1",
+    "eslint-plugin-sonarjs": "^0.18.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "jest": "^27.5.1",
     "jest-cli": "^27.5.1",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.3",
     "replace-in-file": "^6.3.5",
     "shelljs": "0.8.5",
-    "typedoc": "0.17.7",
+    "typedoc": "^0.23.24",
     "typedoc-plugin-markdown": "~2.4.2",
-    "typescript": "^4.8.3"
-  },
-  "peerDependencies": {
-    "@stencil/core": "^2.17.1"
+    "typescript": "^4.9.4",
+    "yargs": "^17.6.2"
   },
   "keywords": [
     "lime web components",