@limetech/lime-web-components 4.54.2 → 5.0.1

package/LICENSE.txt

@@ -10,4 +10,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.

package/README.md

@@ -1,13 +1,28 @@
 # Lime Web Components
 
-This package contains the main library for Lime Web Components
+[![Version](https://img.shields.io/npm/v/@limetech/lime-web-components.svg)](https://www.npmjs.com/package/@limetech/lime-web-components) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
-Lime Web Components are web components that are used to customize [Lime CRM](https://lime-crm.se/). Components are built using [StencilJS](https://stenciljs.com/docs/introduction), which uses [TypeScript](https://www.typescriptlang.org), [JSX](https://reactjs.org/docs/introducing-jsx.html) and [reactive](https://en.wikipedia.org/wiki/Reactive_programming) data-binding.
+To start the dev-server, run `npm start`.
 
-## Installation & Usage
+To build the dist folder, run `npm run build`.
 
-Please use **lime-project** to generate new plugins and components. **lime-web-components** will be installed for you. To keep **lime-web-components** up to date, run `npm up @limetech/lime-web-components` to update within the same major version, or `npm install @limetech/lime-web-components@latest` to update to the latest version, possibly with breaking changes.
+Read the full documentation at [https://lundalogik.github.io/lime-web-components/](https://lundalogik.github.io/lime-web-components/)
 
-For a list of changes, see the [CHANGELOG](https://github.com/Lundalogik/lime-web-components/blob/master/CHANGELOG.md).
+## Deploy documentation
 
-Read the full documentation at [https://lundalogik.github.io/lime-web-components/](https://lundalogik.github.io/lime-web-components/)
+Documentation is deployed to GitHub Pages when a new release is built by Jenkins. It can also be deployed manually from a Linux or macOS computer. *NB! Running the publish script locally will update your git config for the repository with the values of the GIT_AUTHOR_EMAIL and GIT_AUTHOR_NAME environment variables. If you set these to anything other than your own user, you may wish to update your config again after publishing. The script will also make changes to a few files, and will checkout these again at the end. Any uncommitted changes you've made to these files **will be lost**. The script also removes the local copy of the branch gh-pages.*
+
+Follow these steps:
+
+1. The following environment variables must be set:
+  - GIT_AUTHOR_EMAIL - the email address for the user making the commit
+  - GIT_AUTHOR_NAME - the name of the user making the commit
+  - GH_TOKEN - a GitHub access-token with write-access to the repository
+  - GH_USERNAME - the GitHub user to which the above access-token belongs
+2. Run `git fetch`.
+3. Run `git branch` and make sure you do *not* have a local copy of the branch `gh-pages`. If you do, push anything that should be pushed, and remove the local branch.
+4. From the repo-root, run `npm run docz:publish -- --v=<version>`, where `<version>` is the version of lime-elements you are building the documentation for. **Any existing documentation for this version number will be overwritten.** If no version is supplied, the version will be set to `0.0.0-dev`. If `--dryRun=true` is supplied, the entire script will run, except the push to GitHub.
+
+## Get help
+
+- If you have a general question, or are in need of support, please open a [Question issue](https://github.com/Lundalogik/lime-web-components/issues/new?template=03_question.md) on GitHub.

package/dist/commandbus/commandbus.d.ts

@@ -41,7 +41,7 @@ export interface CommandBus extends CommandHandler {
      * @param {CommandConfig} config The command configuration
      * @throws {Error} Thrown if the command has not been registered yet
      */
-    createCommand?<T = any>(config: CommandConfig<T>): T;
+    createCommand<T = any>(config: CommandConfig<T>): T;
 }
 /**
  * Service for executing commands

package/dist/dialog/dialog.d.ts

@@ -24,7 +24,7 @@ export interface DialogRenderer {
      * @param id the dialog identifier
      * @param properties any properties to send to the dialog
      */
-    update?(id: number, properties?: DialogProperties): void;
+    update(id: number, properties?: DialogProperties): void;
     /**
      * Destroy a dialog
      *

package/dist/es5/userdata/decorator.js

@@ -6,7 +6,7 @@ var factory_1 = require("../core/decorators/factory");
 function SelectUserData(options) {
     if (options === void 0) { options = {}; }
     var config = {
-        name: core_1.PlatformServiceName.UserData,
+        name: core_1.PlatformServiceName.UserDataRepository,
     };
     return (0, factory_1.createStateDecorator)(options, config);
 }

package/dist/es5/userdata/types.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var platform_1 = require("../core/platform");
 var SERVICE_NAME = 'state.user-data';
-platform_1.PlatformServiceName.UserData = SERVICE_NAME;
+platform_1.PlatformServiceName.UserDataRepository = SERVICE_NAME;

package/dist/filter/repository.d.ts

@@ -14,5 +14,5 @@ export interface FilterRepository extends StateRepository {
      * @param id a filter id to delete
      * @returns {Promise<void>} a promise that will be resolved when the filter is deleted
      */
-    delete?(filter: Filter): Promise<void>;
+    delete(filter: Filter): Promise<void>;
 }

package/dist/limeobject/repository.d.ts

@@ -15,7 +15,7 @@ export interface LimeObjectRepository extends StateRepository {
      * @param {LoadOptions} options options about the objects to load
      * @returns {ObjectResponse} list of objects together with total count of objects
      */
-    loadObjects?(limetype: string, options?: LoadOptions): Promise<ObjectResponse>;
+    loadObjects(limetype: string, options?: LoadOptions): Promise<ObjectResponse>;
     /**
      * Load related objects into the state
      *
@@ -31,27 +31,14 @@ export interface LimeObjectRepository extends StateRepository {
      *
      * @param {string} limetype name of the limetype of the owning limeobject
      */
-    loadSchema?(limetype: string): Promise<object>;
-    /**
-     * Reload the specified limeobject and update corresponding views in the webclient
-     *
-     * NOTE: This is just a temporary method that can be used to get around some quirks in the current version of the
-     * webclient. It is deprecated and code should not rely on its existance. Check if the method exists before using
-     * it to make code backwards compatible, e.g. `limeobjects.reload && limeobjects.reload('company', 1001)`
-     *
-     * Once the quirks in the webclient have been fixed, there should be no need for this method and objects should
-     * update themselves automatically.
-     *
-     * @deprecated
-     */
-    reloadObject?(limetype: string, id: number): void;
+    loadSchema(limetype: string): Promise<object>;
     /**
      * Delete the specified limeobject
      *
      * @param {string} limetype name of the limetype of the limeobject
      * @param {number} id the id of the limeobject
      */
-    deleteObject?(limetype: string, id: number): Promise<void>;
+    deleteObject(limetype: string, id: number): Promise<void>;
 }
 export interface LoadOptions {
     /**

package/dist/userdata/decorator.js

@@ -8,7 +8,7 @@ import { createStateDecorator } from '../core/decorators/factory';
  */
 export function SelectUserData(options = {}) {
     const config = {
-        name: PlatformServiceName.UserData,
+        name: PlatformServiceName.UserDataRepository,
     };
     return createStateDecorator(options, config);
 }

package/dist/userdata/types.d.ts

@@ -5,10 +5,10 @@ declare module '../core/platform' {
         /**
          * @see {@link UserDataRepository}
          */
-        UserData: typeof SERVICE_NAME;
+        UserDataRepository: typeof SERVICE_NAME;
     }
     interface LimeWebComponentPlatform {
-        get(name: PlatformServiceNameType['UserData']): UserDataRepository;
+        get(name: PlatformServiceNameType['UserDataRepository']): UserDataRepository;
     }
 }
 export {};

package/dist/userdata/types.js

@@ -1,3 +1,3 @@
 import { PlatformServiceName } from '../core/platform';
 const SERVICE_NAME = 'state.user-data';
-PlatformServiceName.UserData = SERVICE_NAME;
+PlatformServiceName.UserDataRepository = SERVICE_NAME;

package/package.json

@@ -1,55 +1,78 @@
 {
   "name": "@limetech/lime-web-components",
-  "version": "4.54.2",
+  "version": "5.0.1",
+  "description": "Lime Web Components",
   "author": "Lime Technologies",
-  "homepage": "https://github.com/Lundalogik/lime-web-components",
   "license": "Apache-2.0",
   "main": "dist/es5/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "keywords": [
-    "lime web components",
-    "lime crm"
-  ],
   "files": [
-    "dist",
+    "dist/",
     "testing"
   ],
   "scripts": {
     "build": "tsc && tsc -p tsconfig.es5.json",
+    "start": "npm run generate-api-docs && docz dev",
     "test": "stencil test --spec",
-    "test:watch": "stencil test --spec --watch"
-  },
-  "config": {
-    "commitizen": {
-      "path": "../../node_modules/cz-conventional-changelog"
-    }
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Lundalogik/lime-web-components.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Lundalogik/lime-web-components/issues"
+    "docz:build": "npm run generate-api-docs && docz build",
+    "docz:publish": "node publish-docs.js",
+    "generate-api-docs": "typedoc && node transform-docs.js",
+    "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"
   },
   "dependencies": {
-    "@limetech/lime-web-components-commands": "^4.51.2",
-    "@limetech/lime-web-components-decorators": "^4.53.1",
-    "@limetech/lime-web-components-interfaces": "^4.51.2",
-    "@limetech/lime-web-components-testing": "^4.53.1",
     "rxjs": "^7.5.6",
     "tslib": "^2.4.0"
   },
   "devDependencies": {
+    "@commitlint/config-conventional": "^16.2.4",
+    "@stencil/core": "^2.18.0",
     "@types/jest": "^27.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.38.0",
+    "@typescript-eslint/parser": "^5.38.0",
+    "commitizen": "^4.2.5",
+    "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-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react": "^7.31.8",
+    "eslint-plugin-sonarjs": "^0.15.0",
     "jest": "^27.5.1",
-    "jest-cli": "^27.5.1"
+    "jest-cli": "^27.5.1",
+    "prettier": "^2.7.1",
+    "replace-in-file": "^6.3.5",
+    "shelljs": "0.8.5",
+    "typedoc": "0.17.7",
+    "typedoc-plugin-markdown": "~2.4.2",
+    "typescript": "^4.8.3"
   },
   "peerDependencies": {
     "@stencil/core": "^2.17.1"
   },
-  "gitHead": "13613b1b5a0b22a21cd574f5050391e403a315c3"
+  "keywords": [
+    "lime web components",
+    "lime crm"
+  ],
+  "directories": {
+    "doc": "doc"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Lundalogik/lime-web-components.git"
+  }
 }

package/testing/package.json

@@ -2,7 +2,7 @@
   "name": "@limetech/lime-web-components",
   "author": "Lime Technologies",
   "main": "../dist/es5/testing/index.js",
-  "module": "../dist/testing/index.es.js",
+  "module": "../dist/testing/index.js",
   "types": "../dist/testing/index.d.ts",
   "keywords": [
     "lime web components",