@itwin/presentation-common 4.1.0-dev.8 → 4.1.0-dev.81

package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyCategorySpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { CustomRendererSpecification } from \"./CustomRendererSpecification\";\r\n\r\n/**\r\n * Identifier for no category. Used to make category displayed at root level by using\r\n * this identifier for [[PropertyCategorySpecification.parentId]].\r\n *\r\n * @public\r\n */\r\nexport interface NoCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"None\";\r\n}\r\n\r\n/**\r\n * Identifier of the default parent category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **last**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface ParentCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"DefaultParent\";\r\n}\r\n\r\n/**\r\n * Identifier of the root category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **first**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface RootCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Root\";\r\n}\r\n\r\n/**\r\n * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.\r\n * @public\r\n */\r\nexport interface IdCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Id\";\r\n\r\n  /** ID of the category pointed to by this identifier */\r\n  categoryId: string;\r\n}\r\n\r\n/**\r\n * Category identifier used to assign properties to a category.\r\n * @public\r\n */\r\nexport type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;\r\n\r\n/**\r\n * Content modifier for defining custom property categories. Custom categories are not present in the result unless\r\n * they contain at least one property. One way to assign a property to the category is by using\r\n * [property overrides]($docs/presentation/content/PropertySpecification.md).\r\n *\r\n * @see [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyCategorySpecification {\r\n  /**\r\n   * Category identifier used to reference the category definition from property overrides or other category\r\n   * definitions. The identifier has to be unique within the list of category definitions where this\r\n   * specification is used.\r\n   */\r\n  id: string;\r\n\r\n  /**\r\n   * Identifier of a parent category. When specifying the parent category by ID, it has to be available in\r\n   * the scope of this category definition.\r\n   */\r\n  parentId?: string | CategoryIdentifier | NoCategoryIdentifier;\r\n\r\n  /** Display label of the category. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * Extensive description of the category. The description is assigned to the category object that's set\r\n   * on content fields and it's up to UI component to decide how the description is displayed.\r\n   */\r\n  description?: string;\r\n\r\n  /**\r\n   * Assign a custom [[CategoryDescription.priority]] to the category. It's up to the\r\n   * UI component to make sure that priority is respected - categories with higher priority should appear\r\n   * before or above categories with lower priority.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Controls the value of [[CategoryDescription.expand]] which tells the UI component\r\n   * displaying the category to auto-expand the category.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Custom category [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows\r\n   * assigning a custom category renderer to be used in UI. This specification is used to set up\r\n   * [[CategoryDescription.renderer]] for this category and it's up to the UI component to\r\n   * make sure appropriate renderer is used to render the category.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n}\r\n"]}
+{"version":3,"file":"PropertyCategorySpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { CustomRendererSpecification } from \"./CustomRendererSpecification\";\r\n\r\n/**\r\n * Identifier for no category. Used to make category displayed at root level by using\r\n * this identifier for [[PropertyCategorySpecification.parentId]].\r\n *\r\n * @public\r\n */\r\nexport interface NoCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"None\";\r\n}\r\n\r\n/**\r\n * Identifier of the default parent category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **last**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface ParentCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"DefaultParent\";\r\n}\r\n\r\n/**\r\n * Identifier of the root category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **first**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface RootCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Root\";\r\n}\r\n\r\n/**\r\n * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.\r\n * @public\r\n */\r\nexport interface IdCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Id\";\r\n\r\n  /** ID of the category pointed to by this identifier */\r\n  categoryId: string;\r\n\r\n  /** Controls whether a class category should be included under the category pointed to by this identifier */\r\n  createClassCategory?: boolean;\r\n}\r\n\r\n/**\r\n * Category identifier used to assign properties to a category.\r\n * @public\r\n */\r\nexport type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;\r\n\r\n/**\r\n * Content modifier for defining custom property categories. Custom categories are not present in the result unless\r\n * they contain at least one property. One way to assign a property to the category is by using\r\n * [property overrides]($docs/presentation/content/PropertySpecification.md).\r\n *\r\n * @see [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyCategorySpecification {\r\n  /**\r\n   * Category identifier used to reference the category definition from property overrides or other category\r\n   * definitions. The identifier has to be unique within the list of category definitions where this\r\n   * specification is used.\r\n   */\r\n  id: string;\r\n\r\n  /**\r\n   * Identifier of a parent category. When specifying the parent category by ID, it has to be available in\r\n   * the scope of this category definition.\r\n   */\r\n  parentId?: string | CategoryIdentifier | NoCategoryIdentifier;\r\n\r\n  /** Display label of the category. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * Extensive description of the category. The description is assigned to the category object that's set\r\n   * on content fields and it's up to UI component to decide how the description is displayed.\r\n   */\r\n  description?: string;\r\n\r\n  /**\r\n   * Assign a custom [[CategoryDescription.priority]] to the category. It's up to the\r\n   * UI component to make sure that priority is respected - categories with higher priority should appear\r\n   * before or above categories with lower priority.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Controls the value of [[CategoryDescription.expand]] which tells the UI component\r\n   * displaying the category to auto-expand the category.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Custom category [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows\r\n   * assigning a custom category renderer to be used in UI. This specification is used to set up\r\n   * [[CategoryDescription.renderer]] for this category and it's up to the UI component to\r\n   * make sure appropriate renderer is used to render the category.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/presentation-common",
-  "version": "4.1.0-dev.8",
+  "version": "4.1.0-dev.81",
   "description": "Common pieces for iModel.js presentation packages",
   "license": "MIT",
   "repository": {
@@ -22,13 +22,13 @@
   "module": "lib/esm/presentation-common.js",
   "typings": "lib/cjs/presentation-common",
   "peerDependencies": {
-    "@itwin/core-bentley": "^4.1.0-dev.8",
-    "@itwin/core-common": "^4.1.0-dev.8",
-    "@itwin/core-quantity": "^4.1.0-dev.8",
-    "@itwin/ecschema-metadata": "^4.1.0-dev.8"
+    "@itwin/core-bentley": "^4.1.0-dev.81",
+    "@itwin/core-common": "^4.1.0-dev.81",
+    "@itwin/core-quantity": "^4.1.0-dev.81",
+    "@itwin/ecschema-metadata": "^4.1.0-dev.81"
   },
   "devDependencies": {
-    "@itwin/eslint-plugin": "^4.0.0-dev.33",
+    "@itwin/eslint-plugin": "4.0.0-dev.44",
     "@types/chai": "4.3.1",
     "@types/chai-as-promised": "^7",
     "@types/chai-jest-snapshot": "^1.3.0",
@@ -36,7 +36,7 @@
     "@types/deep-equal": "^1",
     "@types/faker": "^4.1.0",
     "@types/mocha": "^8.2.2",
-    "@types/sinon": "^9.0.0",
+    "@types/sinon": "^10.0.15",
     "@types/sinon-chai": "^3.2.0",
     "@types/source-map-support": "^0.4.0",
     "chai": "^4.1.2",
@@ -46,33 +46,27 @@
     "cpx2": "^3.0.0",
     "cross-env": "^5.1.4",
     "deep-equal": "^1",
-    "eslint": "^8.36.0",
+    "eslint": "^8.44.0",
     "faker": "^4.1.0",
     "json-schema-faker": "0.5.0-rc16",
     "mocha": "^10.0.0",
     "nyc": "^15.1.0",
     "rimraf": "^3.0.2",
-    "sinon": "^9.0.2",
+    "sinon": "^15.0.4",
     "sinon-chai": "^3.2.0",
     "typemoq": "^2.1.0",
     "typescript": "~5.0.2",
     "typescript-json-schema": "^0.55.0",
     "yargs": "^17.4.0",
-    "@itwin/core-quantity": "4.1.0-dev.8",
-    "@itwin/build-tools": "4.1.0-dev.8",
-    "@itwin/core-bentley": "4.1.0-dev.8",
-    "@itwin/ecschema-metadata": "4.1.0-dev.8",
-    "@itwin/core-common": "4.1.0-dev.8"
+    "@itwin/build-tools": "4.1.0-dev.81",
+    "@itwin/core-bentley": "4.1.0-dev.81",
+    "@itwin/core-common": "4.1.0-dev.81",
+    "@itwin/ecschema-metadata": "4.1.0-dev.81",
+    "@itwin/core-quantity": "4.1.0-dev.81"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc"
   },
-  "eslintConfig": {
-    "plugins": [
-      "@itwin"
-    ],
-    "extends": "plugin:@itwin/itwinjs-recommended"
-  },
   "scripts": {
     "build": "npm run -s ruleset-json-schema && npm run -s build:assets && npm run -s build:public && npm run -s build:cjs && npm run -s build:esm",
     "build:cjs": "tsc -p tsconfig.cjs.json",