@itwin/presentation-shared - npm Package Compare versions

Comparing version 0.3.1 to 0.3.2

CHANGELOG.md

 # @itwin/presentation-shared
 
+## 0.3.2
+
+### Patch Changes
+
+- [#655](https://github.com/iTwin/presentation/pull/655): Remove exposed internal APIs.
+
 ## 0.3.1
@@ -4,0 +10,0 @@

lib/cjs/shared/ecsql-snippets/ECSqlJoinSnippets.d.ts

 import { ECSchemaProvider, RelationshipPath, RelationshipPathStep } from "../Metadata";
 /**
  * Describes a single JOIN step from source to target through a relationship.
+ * @beta
  */
@@ -13,2 +14,3 @@ interface JoinRelationshipPathStep extends RelationshipPathStep {
  * Describes a path of JOINs from source to target.
+ * @beta
  */
@@ -18,2 +20,3 @@ type JoinRelationshipPath = RelationshipPath<JoinRelationshipPathStep>;
  * Props for `createRelationshipPathJoinClause`.
+ * @beta
  */
@@ -20,0 +23,0 @@ interface CreateRelationshipPathJoinClauseProps {

lib/cjs/shared/ecsql-snippets/ECSqlValueSelectorSnippets.d.ts

@@ -7,2 +7,3 @@ import { PrimitiveValueType } from "../Metadata";
  * get a meaningful value.
+ * @beta
  */
@@ -14,3 +15,5 @@ type SpecialPropertyType = "Navigation" | "Guid" | "Point2d" | "Point3d";
  * It's recommended to only select properties with metadata only when they need additional formatting and
- * otherwise use `createPropertyValueSelector` to select their value.
+ * otherwise use `createRawPropertyValueSelector` to select their value.
+ *
+ * @beta
  */
@@ -29,2 +32,3 @@ interface PropertyValueSelectClauseProps {
  * Props for selecting a primitive value using given ECSQL selector.
+ * @beta
  */
@@ -39,12 +43,9 @@ interface PrimitiveValueSelectorProps {
  * A union of prop types for selecting a value and its metadata in ECSQL query.
- * @internal This is an internal type used in public API.
+ * @beta
  */
 export type TypedValueSelectClauseProps = PropertyValueSelectClauseProps | TypedPrimitiveValue | PrimitiveValueSelectorProps;
-/** @internal */
+/** @beta */
 export declare namespace TypedValueSelectClauseProps {
-    /** @internal */
     function isPropertySelector(props: TypedValueSelectClauseProps): props is PropertyValueSelectClauseProps;
-    /** @internal */
     function isPrimitiveValue(props: TypedValueSelectClauseProps): props is TypedPrimitiveValue;
-    /** @internal */
     function isPrimitiveValueSelector(props: TypedValueSelectClauseProps): props is PrimitiveValueSelectorProps;
@@ -51,0 +52,0 @@ }

lib/cjs/shared/ecsql-snippets/ECSqlValueSelectorSnippets.js

@@ -10,7 +10,6 @@ "use strict";
 const Values_1 = require("../Values");
-/** @internal */
+/** @beta */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 var TypedValueSelectClauseProps;
 (function (TypedValueSelectClauseProps) {
-    /** @internal */
     function isPropertySelector(props) {
@@ -20,3 +19,2 @@ return !!props.propertyName;
     TypedValueSelectClauseProps.isPropertySelector = isPropertySelector;
-    /** @internal */
     function isPrimitiveValue(props) {
@@ -26,3 +24,2 @@ return !!props.value;
     TypedValueSelectClauseProps.isPrimitiveValue = isPrimitiveValue;
-    /** @internal */
     function isPrimitiveValueSelector(props) {
@@ -29,0 +26,0 @@ return !!props.selector;

lib/cjs/shared/ECSqlCore.d.ts

@@ -58,2 +58,3 @@ import { Id64String } from "@itwin/core-bentley";
  * @see [QueryRowFormat](https://www.itwinjs.org/reference/core-common/imodels/queryrowformat/)
+ * @beta
  */
@@ -82,2 +83,3 @@ type ECSqlQueryRowFormat = "ECSqlPropertyNames" | "Indexes";
  * @see [ECSqlReader](https://www.itwinjs.org/reference/core-common/imodels/ecsqlreader/)
+ * @beta
  */
@@ -84,0 +86,0 @@ type ECSqlQueryReader = AsyncIterableIterator<ECSqlQueryRow>;

lib/cjs/shared/Formatting.d.ts

@@ -24,14 +24,22 @@ import { ConcatenatedValue } from "./ConcatenatedValue";
  * A values' formatter that knows how to format the following types:
+ *
  * - `Boolean` values are formatted to either "true" or "false".
+ *
  * - `Integer` and `Long` values are rounded to the closest integer.
+ *
  * - `Double` values are rounded to 2 decimal places.
+ *
  * - `DateTime` values accept 2 formats in addition to `Date`:
  *   - if the value is numeric, assume it's a julian day format,
  *   - if the value is string, assume it's an ISO 8601 format.
+ *
  *   If extended type is set to `ShortDate`, the date is formatted as locale date string. Otherwise, it's
  *   formatted as locale date + time string.
+ *
  * - `Point2d` values are formatted in `(x, y)` format.
+ *
  * - `Point3d` values are formatted in `(x, y, z)` format.
- * - `String` and `Id` values are turned as-is.
  *
+ * - `String` and `Id` values are returned as-is.
+ *
  * @beta
@@ -38,0 +46,0 @@ */

lib/cjs/shared/Formatting.js

@@ -65,14 +65,22 @@ "use strict";
  * A values' formatter that knows how to format the following types:
+ *
  * - `Boolean` values are formatted to either "true" or "false".
+ *
  * - `Integer` and `Long` values are rounded to the closest integer.
+ *
  * - `Double` values are rounded to 2 decimal places.
+ *
  * - `DateTime` values accept 2 formats in addition to `Date`:
  *   - if the value is numeric, assume it's a julian day format,
  *   - if the value is string, assume it's an ISO 8601 format.
+ *
  *   If extended type is set to `ShortDate`, the date is formatted as locale date string. Otherwise, it's
  *   formatted as locale date + time string.
+ *
  * - `Point2d` values are formatted in `(x, y)` format.
+ *
  * - `Point3d` values are formatted in `(x, y, z)` format.
- * - `String` and `Id` values are turned as-is.
  *
+ * - `String` and `Id` values are returned as-is.
+ *
  * @beta
@@ -79,0 +87,0 @@ */

lib/cjs/shared/InstanceLabelSelectClauseFactory.d.ts

@@ -6,2 +6,3 @@ import { ConcatenatedValue } from "./ConcatenatedValue";
  * Props for `IInstanceLabelSelectClauseFactory.createSelectClause`.
+ * @beta
  */
@@ -85,2 +86,3 @@ interface CreateInstanceLabelSelectClauseProps {
  * An association of a class and an instance label select clause factory method.
+ * @beta
  */
@@ -95,2 +97,3 @@ interface ClassBasedLabelSelectClause {
  * Props for `createClassBasedInstanceLabelSelectClauseFactory`.
+ * @beta
  */
@@ -121,2 +124,3 @@ interface ClassBasedInstanceLabelSelectClauseFactoryProps {
  * Props for `createBisInstanceLabelSelectClauseFactory`.
+ * @beta
  */
@@ -123,0 +127,0 @@ interface BisInstanceLabelSelectClauseFactoryProps {

lib/cjs/shared/Metadata.d.ts

@@ -236,3 +236,3 @@ /**
  * An identifiers' union of all supported primitive value types.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -242,3 +242,3 @@ export type PrimitiveValueType = "Id" | Exclude<EC.PrimitiveType, "Binary" | "IGeometry">;
  * Describes a single step through an ECRelationship from source ECClass to target ECClass.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -261,3 +261,3 @@ export interface RelationshipPathStep {
  * Describes a path from source ECClass to target ECClass through multiple ECRelationships.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -264,0 +264,0 @@ export type RelationshipPath<TStep extends RelationshipPathStep = RelationshipPathStep> = TStep[];

lib/cjs/shared/Values.d.ts

@@ -31,3 +31,3 @@ import { Id64String } from "@itwin/core-bentley";
  * A data structure for a 2d point.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -40,3 +40,3 @@ export interface Point2d {
  * A data structure for a 3d point.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -111,3 +111,3 @@ export interface Point3d {
  * A type for a primitive property value and its metadata - property name and its class full name.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -114,0 +114,0 @@ export interface PrimitivePropertyValue {

lib/esm/shared/ecsql-snippets/ECSqlJoinSnippets.d.ts

 import { ECSchemaProvider, RelationshipPath, RelationshipPathStep } from "../Metadata";
 /**
  * Describes a single JOIN step from source to target through a relationship.
+ * @beta
  */
@@ -13,2 +14,3 @@ interface JoinRelationshipPathStep extends RelationshipPathStep {
  * Describes a path of JOINs from source to target.
+ * @beta
  */
@@ -18,2 +20,3 @@ type JoinRelationshipPath = RelationshipPath<JoinRelationshipPathStep>;
  * Props for `createRelationshipPathJoinClause`.
+ * @beta
  */
@@ -20,0 +23,0 @@ interface CreateRelationshipPathJoinClauseProps {

lib/esm/shared/ecsql-snippets/ECSqlValueSelectorSnippets.d.ts

@@ -7,2 +7,3 @@ import { PrimitiveValueType } from "../Metadata";
  * get a meaningful value.
+ * @beta
  */
@@ -14,3 +15,5 @@ type SpecialPropertyType = "Navigation" | "Guid" | "Point2d" | "Point3d";
  * It's recommended to only select properties with metadata only when they need additional formatting and
- * otherwise use `createPropertyValueSelector` to select their value.
+ * otherwise use `createRawPropertyValueSelector` to select their value.
+ *
+ * @beta
  */
@@ -29,2 +32,3 @@ interface PropertyValueSelectClauseProps {
  * Props for selecting a primitive value using given ECSQL selector.
+ * @beta
  */
@@ -39,12 +43,9 @@ interface PrimitiveValueSelectorProps {
  * A union of prop types for selecting a value and its metadata in ECSQL query.
- * @internal This is an internal type used in public API.
+ * @beta
  */
 export type TypedValueSelectClauseProps = PropertyValueSelectClauseProps | TypedPrimitiveValue | PrimitiveValueSelectorProps;
-/** @internal */
+/** @beta */
 export declare namespace TypedValueSelectClauseProps {
-    /** @internal */
     function isPropertySelector(props: TypedValueSelectClauseProps): props is PropertyValueSelectClauseProps;
-    /** @internal */
     function isPrimitiveValue(props: TypedValueSelectClauseProps): props is TypedPrimitiveValue;
-    /** @internal */
     function isPrimitiveValueSelector(props: TypedValueSelectClauseProps): props is PrimitiveValueSelectorProps;
@@ -51,0 +52,0 @@ }

lib/esm/shared/ecsql-snippets/ECSqlValueSelectorSnippets.js

@@ -7,7 +7,6 @@ /*---------------------------------------------------------------------------------------------
 import { PrimitiveValue } from "../Values";
-/** @internal */
+/** @beta */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export var TypedValueSelectClauseProps;
 (function (TypedValueSelectClauseProps) {
-    /** @internal */
     function isPropertySelector(props) {
@@ -17,3 +16,2 @@ return !!props.propertyName;
     TypedValueSelectClauseProps.isPropertySelector = isPropertySelector;
-    /** @internal */
     function isPrimitiveValue(props) {
@@ -23,3 +21,2 @@ return !!props.value;
     TypedValueSelectClauseProps.isPrimitiveValue = isPrimitiveValue;
-    /** @internal */
     function isPrimitiveValueSelector(props) {
@@ -26,0 +23,0 @@ return !!props.selector;

lib/esm/shared/ECSqlCore.d.ts

@@ -58,2 +58,3 @@ import { Id64String } from "@itwin/core-bentley";
  * @see [QueryRowFormat](https://www.itwinjs.org/reference/core-common/imodels/queryrowformat/)
+ * @beta
  */
@@ -82,2 +83,3 @@ type ECSqlQueryRowFormat = "ECSqlPropertyNames" | "Indexes";
  * @see [ECSqlReader](https://www.itwinjs.org/reference/core-common/imodels/ecsqlreader/)
+ * @beta
  */
@@ -84,0 +86,0 @@ type ECSqlQueryReader = AsyncIterableIterator<ECSqlQueryRow>;

lib/esm/shared/Formatting.d.ts

@@ -24,14 +24,22 @@ import { ConcatenatedValue } from "./ConcatenatedValue";
  * A values' formatter that knows how to format the following types:
+ *
  * - `Boolean` values are formatted to either "true" or "false".
+ *
  * - `Integer` and `Long` values are rounded to the closest integer.
+ *
  * - `Double` values are rounded to 2 decimal places.
+ *
  * - `DateTime` values accept 2 formats in addition to `Date`:
  *   - if the value is numeric, assume it's a julian day format,
  *   - if the value is string, assume it's an ISO 8601 format.
+ *
  *   If extended type is set to `ShortDate`, the date is formatted as locale date string. Otherwise, it's
  *   formatted as locale date + time string.
+ *
  * - `Point2d` values are formatted in `(x, y)` format.
+ *
  * - `Point3d` values are formatted in `(x, y, z)` format.
- * - `String` and `Id` values are turned as-is.
  *
+ * - `String` and `Id` values are returned as-is.
+ *
  * @beta
@@ -38,0 +46,0 @@ */

lib/esm/shared/Formatting.js

@@ -61,14 +61,22 @@ /*---------------------------------------------------------------------------------------------
  * A values' formatter that knows how to format the following types:
+ *
  * - `Boolean` values are formatted to either "true" or "false".
+ *
  * - `Integer` and `Long` values are rounded to the closest integer.
+ *
  * - `Double` values are rounded to 2 decimal places.
+ *
  * - `DateTime` values accept 2 formats in addition to `Date`:
  *   - if the value is numeric, assume it's a julian day format,
  *   - if the value is string, assume it's an ISO 8601 format.
+ *
  *   If extended type is set to `ShortDate`, the date is formatted as locale date string. Otherwise, it's
  *   formatted as locale date + time string.
+ *
  * - `Point2d` values are formatted in `(x, y)` format.
+ *
  * - `Point3d` values are formatted in `(x, y, z)` format.
- * - `String` and `Id` values are turned as-is.
  *
+ * - `String` and `Id` values are returned as-is.
+ *
  * @beta
@@ -75,0 +83,0 @@ */

lib/esm/shared/InstanceLabelSelectClauseFactory.d.ts

@@ -6,2 +6,3 @@ import { ConcatenatedValue } from "./ConcatenatedValue";
  * Props for `IInstanceLabelSelectClauseFactory.createSelectClause`.
+ * @beta
  */
@@ -85,2 +86,3 @@ interface CreateInstanceLabelSelectClauseProps {
  * An association of a class and an instance label select clause factory method.
+ * @beta
  */
@@ -95,2 +97,3 @@ interface ClassBasedLabelSelectClause {
  * Props for `createClassBasedInstanceLabelSelectClauseFactory`.
+ * @beta
  */
@@ -121,2 +124,3 @@ interface ClassBasedInstanceLabelSelectClauseFactoryProps {
  * Props for `createBisInstanceLabelSelectClauseFactory`.
+ * @beta
  */
@@ -123,0 +127,0 @@ interface BisInstanceLabelSelectClauseFactoryProps {

lib/esm/shared/Metadata.d.ts

@@ -236,3 +236,3 @@ /**
  * An identifiers' union of all supported primitive value types.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -242,3 +242,3 @@ export type PrimitiveValueType = "Id" | Exclude<EC.PrimitiveType, "Binary" | "IGeometry">;
  * Describes a single step through an ECRelationship from source ECClass to target ECClass.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -261,3 +261,3 @@ export interface RelationshipPathStep {
  * Describes a path from source ECClass to target ECClass through multiple ECRelationships.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -264,0 +264,0 @@ export type RelationshipPath<TStep extends RelationshipPathStep = RelationshipPathStep> = TStep[];

lib/esm/shared/Values.d.ts

@@ -31,3 +31,3 @@ import { Id64String } from "@itwin/core-bentley";
  * A data structure for a 2d point.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -40,3 +40,3 @@ export interface Point2d {
  * A data structure for a 3d point.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -111,3 +111,3 @@ export interface Point3d {
  * A type for a primitive property value and its metadata - property name and its class full name.
- * @internal This is an internal type used in public API.
+ * @beta
  */
@@ -114,0 +114,0 @@ export interface PrimitivePropertyValue {

package.json

 {
   "name": "@itwin/presentation-shared",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "The package contains types and utilities used across different iTwin.js Presentation packages.",
@@ -30,3 +30,3 @@ "license": "MIT",
   "devDependencies": {
-    "@itwin/build-tools": "^4.6.0",
+    "@itwin/build-tools": "^4.7.1",
     "@itwin/eslint-plugin": "^4.0.0",
@@ -50,2 +50,3 @@ "@types/chai": "^4.3.14",
     "typescript": "~5.4.5",
+    "presentation-build-tools": "^0.0.0",
     "presentation-test-utilities": "^0.0.0"
@@ -62,5 +63,5 @@ },
     "test": "mocha --enable-source-maps --config ./.mocharc.json \"./lib/cjs/test/**/*.test.js\"",
-    "extract-api": "betools extract-api --entry=presentation-shared --apiReportFolder=./api --apiReportTempFolder=./api/temp --apiSummaryFolder=./api",
+    "extract-api": "extract-api --entry=presentation-shared --apiReportFolder=./api --apiReportTempFolder=./api/temp --apiSummaryFolder=./api",
     "check-internal": "node ../../scripts/checkInternal.js --apiSummary ./api/presentation-shared.api.md"
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

4178

increased by1.11%

Worsened metrics

Total package byte prevSize

291033

decreased by-0.2%

Dev dependency count

21

increased by5%

No dependency changes