@itwin/core-common 3.6.0 → 3.7.0-dev.1

package/lib/esm/rpc/IModelTileRpcInterface.d.ts

@@ -24,11 +24,11 @@ export declare abstract class IModelTileRpcInterface extends RpcInterface {
     /**
      * Returns connection information for external tile cache or an empty `CloudStorageContainerUrl` if no external tile cache is configured on the backend.
      * @beta
-     * @deprecated in 3.x.
+     * @deprecated in 3.x. Use [[getTileCacheConfig]] instead.
      */
     getTileCacheContainerUrl(_tokenProps: IModelRpcProps, _id: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl>;
     /** Returns true if an external tile cache is configured on the backend.
-     * @internal @deprecated in 3.x.
+     * @internal @deprecated in 3.x. Use [[getTileCacheConfig]] instead.
      */
     isUsingExternalTileCache(): Promise<boolean>;
     /** @internal */

package/lib/esm/rpc/IModelTileRpcInterface.js

@@ -33,13 +33,13 @@ export class IModelTileRpcInterface extends RpcInterface {
     /**
      * Returns connection information for external tile cache or an empty `CloudStorageContainerUrl` if no external tile cache is configured on the backend.
      * @beta
-     * @deprecated in 3.x.
+     * @deprecated in 3.x. Use [[getTileCacheConfig]] instead.
      */
     async getTileCacheContainerUrl(_tokenProps, _id) {
         return this.forward(arguments);
     }
     /** Returns true if an external tile cache is configured on the backend.
-     * @internal @deprecated in 3.x.
+     * @internal @deprecated in 3.x. Use [[getTileCacheConfig]] instead.
      */
     async isUsingExternalTileCache() {
         return this.forward(arguments);

package/lib/esm/rpc/IModelTileRpcInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelTileRpcInterface.js","sourceRoot":"","sources":["../../../src/rpc/IModelTileRpcInterface.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;AAMH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAI3C,cAAc;AACd,MAAM,OAAgB,sBAAuB,SAAQ,YAAY;IACxD,MAAM,CAAC,SAAS,KAA6B,OAAO,UAAU,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAQtH;;;iGAG6F;IAE7F;;;OAGG;IACI,KAAK,CAAC,kBAAkB,CAAC,WAA2B;QACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/C,OAAO,QAAQ,IAAI,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;IAChF,CAAC;IAED;;;;OAIG;IAGI,KAAK,CAAC,wBAAwB,CAAC,WAA2B,EAAE,GAAoC;QACrG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,wBAAwB;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,gBAAgB;IAET,KAAK,CAAC,oBAAoB,CAAC,WAA2B,EAAE,GAAW,IAAkC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE7I;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAAC,SAAyB,EAAE,OAAe,EAAE,UAAkB,EAAE,KAAyB;QACxH,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB,CAAC,SAAyB,EAAE,IAA2B;QACrF,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,gBAAgB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,WAA2B,EAAE,SAAgC,IAAmB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE7I;;;;OAIG;IACI,KAAK,CAAC,sBAAsB,CAAC,SAAyB,EAAE,QAAqC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;;AA9ED,2CAA2C;AACpB,oCAAa,GAAG,wBAAwB,CAAC;AAEhE,6CAA6C;AAC/B,uCAAgB,GAAG,OAAO,CAAC;AAuBzC;IAFC,YAAY,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,8CAA8C;sEAInH;AAWD;IADC,YAAY,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,8CAA8C;kEACyB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module RpcInterface\n */\n\nimport type { TransferConfig } from \"@itwin/object-storage-core/lib/common\";\nimport { Id64Array } from \"@itwin/core-bentley\";\nimport { CloudStorageContainerDescriptor, CloudStorageContainerUrl } from \"../CloudStorage\";\nimport { TileContentIdentifier } from \"../CloudStorageTileCache\";\nimport { RpcResponseCacheControl } from \"./core/RpcConstants\";\nimport { RpcOperation } from \"./core/RpcOperation\";\nimport { IModelRpcProps } from \"../IModel\";\nimport { RpcInterface } from \"../RpcInterface\";\nimport { RpcManager } from \"../RpcManager\";\nimport { ElementGraphicsRequestProps } from \"../tile/ElementGraphics\";\nimport { IModelTileTreeProps, TileContentSource, TileVersionInfo } from \"../TileProps\";\n\n/** @public */\nexport abstract class IModelTileRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\n  public static getClient(): IModelTileRpcInterface { return RpcManager.getClientForInterface(IModelTileRpcInterface); }\n\n  /** The immutable name of the interface. */\n  public static readonly interfaceName = \"IModelTileRpcInterface\";\n\n  /** The semantic version of the interface. */\n  public static interfaceVersion = \"3.2.0\";\n\n  /*===========================================================================================\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\n    NOTE: Please consult the README in this folder for the semantic versioning rules.\n  ===========================================================================================*/\n\n  /**\n   * @returns undefined if the backend does not support caching\n   * @beta\n   */\n  public async getTileCacheConfig(_tokenProps: IModelRpcProps): Promise<TransferConfig | undefined> {\n    const response = await this.forward(arguments);\n    return response && { ...response, expiration: new Date(response.expiration) };\n  }\n\n  /**\n   * Returns connection information for external tile cache or an empty `CloudStorageContainerUrl` if no external tile cache is configured on the backend.\n   * @beta\n   * @deprecated in 3.x.\n   */\n  @RpcOperation.allowResponseCaching(RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation\n  // eslint-disable-next-line deprecation/deprecation\n  public async getTileCacheContainerUrl(_tokenProps: IModelRpcProps, _id: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl> {\n    return this.forward(arguments);\n  }\n\n  /** Returns true if an external tile cache is configured on the backend.\n   * @internal @deprecated in 3.x.\n   */\n  public async isUsingExternalTileCache(): Promise<boolean> { // eslint-disable-line @itwin/prefer-get\n    return this.forward(arguments);\n  }\n\n  /** @internal */\n  @RpcOperation.allowResponseCaching(RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation\n  public async requestTileTreeProps(_tokenProps: IModelRpcProps, _id: string): Promise<IModelTileTreeProps> { return this.forward(arguments); }\n\n  /** Ask the backend to generate content for the specified tile. This function, unlike the deprecated `requestTileContent`, does not check the cloud storage tile cache -\n   * Use `CloudStorageTileCache.retrieve` for that.\n   * @returns TileContentSource - if Backend, use retrieveTileContent. If ExternalCache, use TileAdmin.requestCachedTileContent\n   * @internal\n   */\n  public async generateTileContent(_rpcProps: IModelRpcProps, _treeId: string, _contentId: string, _guid: string | undefined): Promise<TileContentSource> {\n    return this.forward(arguments);\n  }\n\n  /** Retrieves tile content from the backend once it's generated by generateTileContent.\n   *  @internal\n   */\n  public async retrieveTileContent(_rpcProps: IModelRpcProps, _key: TileContentIdentifier): Promise<Uint8Array> {\n    return this.forward(arguments);\n  }\n\n  /** @internal */\n  public async queryVersionInfo(): Promise<TileVersionInfo> {\n    return this.forward(arguments);\n  }\n\n  /** This is a temporary workaround for folks developing authoring applications, to be removed when proper support for such applications is introduced.\n   * Given a set of model Ids, it purges any associated tile tree state on the back-end so that the next request for the tile tree or content will recreate that state.\n   * Invoked after a modification is made to the model(s).\n   * If no array of model Ids is supplied, it purges *all* tile trees, which can be quite inefficient.\n   * @internal\n   */\n  public async purgeTileTrees(_tokenProps: IModelRpcProps, _modelIds: Id64Array | undefined): Promise<void> { return this.forward(arguments); }\n\n  /** Requests graphics for a single element in \"iMdl\" format.\n   * @returns graphics in iMdl format, or `undefined` if the element's geometry produced no graphics or the request was canceled before completion.\n   * @throws IModelError on bad request (nonexistent element, duplicate request Id, etc).\n   * @internal\n   */\n  public async requestElementGraphics(_rpcProps: IModelRpcProps, _request: ElementGraphicsRequestProps): Promise<Uint8Array | undefined> {\n    return this.forward(arguments);\n  }\n}\n"]}
+{"version":3,"file":"IModelTileRpcInterface.js","sourceRoot":"","sources":["../../../src/rpc/IModelTileRpcInterface.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;AAMH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAI3C,cAAc;AACd,MAAM,OAAgB,sBAAuB,SAAQ,YAAY;IACxD,MAAM,CAAC,SAAS,KAA6B,OAAO,UAAU,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAQtH;;;iGAG6F;IAE7F;;;OAGG;IACI,KAAK,CAAC,kBAAkB,CAAC,WAA2B;QACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/C,OAAO,QAAQ,IAAI,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;IAChF,CAAC;IAED;;;;OAIG;IAGI,KAAK,CAAC,wBAAwB,CAAC,WAA2B,EAAE,GAAoC;QACrG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,wBAAwB;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,gBAAgB;IAET,KAAK,CAAC,oBAAoB,CAAC,WAA2B,EAAE,GAAW,IAAkC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE7I;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAAC,SAAyB,EAAE,OAAe,EAAE,UAAkB,EAAE,KAAyB;QACxH,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB,CAAC,SAAyB,EAAE,IAA2B;QACrF,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,gBAAgB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,WAA2B,EAAE,SAAgC,IAAmB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE7I;;;;OAIG;IACI,KAAK,CAAC,sBAAsB,CAAC,SAAyB,EAAE,QAAqC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;;AA9ED,2CAA2C;AACpB,oCAAa,GAAG,wBAAwB,CAAC;AAEhE,6CAA6C;AAC/B,uCAAgB,GAAG,OAAO,CAAC;AAuBzC;IAFC,YAAY,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,8CAA8C;sEAInH;AAWD;IADC,YAAY,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,8CAA8C;kEACyB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module RpcInterface\n */\n\nimport type { TransferConfig } from \"@itwin/object-storage-core/lib/common\";\nimport { Id64Array } from \"@itwin/core-bentley\";\nimport { CloudStorageContainerDescriptor, CloudStorageContainerUrl } from \"../CloudStorage\";\nimport { TileContentIdentifier } from \"../CloudStorageTileCache\";\nimport { RpcResponseCacheControl } from \"./core/RpcConstants\";\nimport { RpcOperation } from \"./core/RpcOperation\";\nimport { IModelRpcProps } from \"../IModel\";\nimport { RpcInterface } from \"../RpcInterface\";\nimport { RpcManager } from \"../RpcManager\";\nimport { ElementGraphicsRequestProps } from \"../tile/ElementGraphics\";\nimport { IModelTileTreeProps, TileContentSource, TileVersionInfo } from \"../TileProps\";\n\n/** @public */\nexport abstract class IModelTileRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\n  public static getClient(): IModelTileRpcInterface { return RpcManager.getClientForInterface(IModelTileRpcInterface); }\n\n  /** The immutable name of the interface. */\n  public static readonly interfaceName = \"IModelTileRpcInterface\";\n\n  /** The semantic version of the interface. */\n  public static interfaceVersion = \"3.2.0\";\n\n  /*===========================================================================================\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\n    NOTE: Please consult the README in this folder for the semantic versioning rules.\n  ===========================================================================================*/\n\n  /**\n   * @returns undefined if the backend does not support caching\n   * @beta\n   */\n  public async getTileCacheConfig(_tokenProps: IModelRpcProps): Promise<TransferConfig | undefined> {\n    const response = await this.forward(arguments);\n    return response && { ...response, expiration: new Date(response.expiration) };\n  }\n\n  /**\n   * Returns connection information for external tile cache or an empty `CloudStorageContainerUrl` if no external tile cache is configured on the backend.\n   * @beta\n   * @deprecated in 3.x. Use [[getTileCacheConfig]] instead.\n   */\n  @RpcOperation.allowResponseCaching(RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation\n  // eslint-disable-next-line deprecation/deprecation\n  public async getTileCacheContainerUrl(_tokenProps: IModelRpcProps, _id: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl> {\n    return this.forward(arguments);\n  }\n\n  /** Returns true if an external tile cache is configured on the backend.\n   * @internal @deprecated in 3.x. Use [[getTileCacheConfig]] instead.\n   */\n  public async isUsingExternalTileCache(): Promise<boolean> { // eslint-disable-line @itwin/prefer-get\n    return this.forward(arguments);\n  }\n\n  /** @internal */\n  @RpcOperation.allowResponseCaching(RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation\n  public async requestTileTreeProps(_tokenProps: IModelRpcProps, _id: string): Promise<IModelTileTreeProps> { return this.forward(arguments); }\n\n  /** Ask the backend to generate content for the specified tile. This function, unlike the deprecated `requestTileContent`, does not check the cloud storage tile cache -\n   * Use `CloudStorageTileCache.retrieve` for that.\n   * @returns TileContentSource - if Backend, use retrieveTileContent. If ExternalCache, use TileAdmin.requestCachedTileContent\n   * @internal\n   */\n  public async generateTileContent(_rpcProps: IModelRpcProps, _treeId: string, _contentId: string, _guid: string | undefined): Promise<TileContentSource> {\n    return this.forward(arguments);\n  }\n\n  /** Retrieves tile content from the backend once it's generated by generateTileContent.\n   *  @internal\n   */\n  public async retrieveTileContent(_rpcProps: IModelRpcProps, _key: TileContentIdentifier): Promise<Uint8Array> {\n    return this.forward(arguments);\n  }\n\n  /** @internal */\n  public async queryVersionInfo(): Promise<TileVersionInfo> {\n    return this.forward(arguments);\n  }\n\n  /** This is a temporary workaround for folks developing authoring applications, to be removed when proper support for such applications is introduced.\n   * Given a set of model Ids, it purges any associated tile tree state on the back-end so that the next request for the tile tree or content will recreate that state.\n   * Invoked after a modification is made to the model(s).\n   * If no array of model Ids is supplied, it purges *all* tile trees, which can be quite inefficient.\n   * @internal\n   */\n  public async purgeTileTrees(_tokenProps: IModelRpcProps, _modelIds: Id64Array | undefined): Promise<void> { return this.forward(arguments); }\n\n  /** Requests graphics for a single element in \"iMdl\" format.\n   * @returns graphics in iMdl format, or `undefined` if the element's geometry produced no graphics or the request was canceled before completion.\n   * @throws IModelError on bad request (nonexistent element, duplicate request Id, etc).\n   * @internal\n   */\n  public async requestElementGraphics(_rpcProps: IModelRpcProps, _request: ElementGraphicsRequestProps): Promise<Uint8Array | undefined> {\n    return this.forward(arguments);\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-common",
-  "version": "3.6.0",
+  "version": "3.7.0-dev.1",
   "description": "iTwin.js components common to frontend and backend",
   "main": "lib/cjs/core-common.js",
   "module": "lib/esm/core-common.js",
@@ -28,14 +28,14 @@
     "js-base64": "^3.6.1"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^3.6.0",
-    "@itwin/core-geometry": "^3.6.0"
+    "@itwin/core-bentley": "^3.7.0-dev.1",
+    "@itwin/core-geometry": "^3.7.0-dev.1"
   },
   "devDependencies": {
-    "@itwin/build-tools": "3.6.0",
-    "@itwin/core-bentley": "3.6.0",
-    "@itwin/core-geometry": "3.6.0",
-    "@itwin/eslint-plugin": "3.6.0",
+    "@itwin/build-tools": "3.7.0-dev.1",
+    "@itwin/core-bentley": "3.7.0-dev.1",
+    "@itwin/core-geometry": "3.7.0-dev.1",
+    "@itwin/eslint-plugin": "3.7.0-dev.1",
     "@types/chai": "4.3.1",
     "@types/flatbuffers": "~1.10.0",
     "@types/mocha": "^8.2.2",