@itwin/frontend-tiles 4.8.0-dev.3 → 4.8.0-dev.32

package/lib/cjs/FrontendTiles.js

@@ -5,52 +5,49 @@
 *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initializeFrontendTiles = exports.frontendTilesOptions = exports.obtainMeshExportTilesetUrl = exports.queryMeshExports = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
 const core_frontend_1 = require("@itwin/core-frontend");
-const LoggerCategory_1 = require("./LoggerCategory");
 const BatchedSpatialTileTreeRefs_1 = require("./BatchedSpatialTileTreeRefs");
-function createMeshExportServiceQueryUrl(args) {
-    const prefix = args.urlPrefix ?? "";
-    let url = `https://${prefix}api.bentley.com/mesh-export/?iModelId=${args.iModelId}&$orderBy=date:desc`;
-    if (args.changesetId)
-        url = `${url}&changesetId=${args.changesetId}`;
-    if (args.enableCDN)
-        url = `${url}&cdn=1`;
-    url = `${url}&tileVersion=1&exportType=IMODEL`;
-    return url;
-}
+const GraphicRepresentationProvider_1 = require("./GraphicsProvider/GraphicRepresentationProvider");
+const GraphicsProvider_1 = require("./GraphicsProvider/GraphicsProvider");
 /** Query the [mesh export service](https://developer.bentley.com/apis/mesh-export/operations/get-exports/) for exports of type "IMODEL" matching
  * the specified criteria.
  * The exports are sorted from most-recently- to least-recently-produced.
  * @beta
  */
 async function* queryMeshExports(args) {
-    const headers = {
-        /* eslint-disable-next-line @typescript-eslint/naming-convention */
-        Authorization: args.accessToken ?? await core_frontend_1.IModelApp.getAccessToken(),
-        /* eslint-disable-next-line @typescript-eslint/naming-convention */
-        Accept: "application/vnd.bentley.itwin-platform.v1+json",
-        /* eslint-disable-next-line @typescript-eslint/naming-convention */
-        Prefer: "return=representation",
-        /* eslint-disable-next-line @typescript-eslint/naming-convention */
-        SessionId: core_frontend_1.IModelApp.sessionId,
+    const graphicsArgs = {
+        accessToken: args.accessToken,
+        sessionId: core_frontend_1.IModelApp.sessionId,
+        dataSource: {
+            iTwinId: args.iTwinId,
+            id: args.iModelId,
+            changeId: args.changesetId,
+            type: "IMODEL",
+        },
+        format: "IMDL",
+        urlPrefix: args.urlPrefix,
+        enableCDN: args.enableCDN,
     };
-    let url = createMeshExportServiceQueryUrl(args);
-    while (url) {
-        let result;
-        try {
-            const response = await fetch(url, { headers });
-            result = await response.json();
-        }
-        catch (err) {
-            core_bentley_1.Logger.logException(LoggerCategory_1.loggerCategory, err);
-            core_bentley_1.Logger.logError(LoggerCategory_1.loggerCategory, `Failed loading exports for iModel ${args.iModelId}`);
-            break;
-        }
-        const foundExports = result.exports.filter((x) => x.request.exportType === "IMODEL" && (args.includeIncomplete || x.status === "Complete"));
-        for (const foundExport of foundExports)
-            yield foundExport;
-        url = result._links.next?.href;
+    for await (const data of (0, GraphicRepresentationProvider_1.queryGraphicRepresentations)(graphicsArgs)) {
+        const meshExport = {
+            id: data.representationId,
+            displayName: data.displayName,
+            status: "Complete",
+            request: {
+                iModelId: data.dataSource.id,
+                changesetId: data.dataSource.changeId ?? "",
+                exportType: data.dataSource.type,
+                geometryOptions: {},
+                viewDefinitionFilter: {},
+            },
+            /* eslint-disable-next-line @typescript-eslint/naming-convention */
+            _links: {
+                mesh: {
+                    href: data.url ?? "",
+                },
+            },
+        };
+        yield meshExport;
     }
 }
 exports.queryMeshExports = queryMeshExports;
@@ -61,37 +58,7 @@ exports.queryMeshExports = queryMeshExports;
  * @beta
  */
 async function obtainMeshExportTilesetUrl(args) {
-    if (!args.iModel.iModelId) {
-        core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, "Cannot obtain exports for an iModel with no iModelId");
-        return undefined;
-    }
-    const queryArgs = {
-        accessToken: args.accessToken,
-        iModelId: args.iModel.iModelId,
-        changesetId: args.iModel.changeset.id,
-        urlPrefix: args.urlPrefix,
-        enableCDN: args.enableCDN,
-    };
-    let selectedExport;
-    for await (const exp of queryMeshExports(queryArgs)) {
-        selectedExport = exp;
-        break;
-    }
-    if (!selectedExport && !args.requireExactChangeset) {
-        queryArgs.changesetId = undefined;
-        for await (const exp of queryMeshExports(queryArgs)) {
-            selectedExport = exp;
-            core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, `No exports for iModel ${args.iModel.iModelId} for changeset ${args.iModel.changeset.id}; falling back to most recent`);
-            break;
-        }
-    }
-    if (!selectedExport) {
-        core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, `No exports available for iModel ${args.iModel.iModelId}`);
-        return undefined;
-    }
-    const url = new URL(selectedExport._links.mesh.href);
-    url.pathname = `${url.pathname}/tileset.json`;
-    return url;
+    return (0, GraphicsProvider_1.obtainIModelTilesetUrl)(args);
 }
 exports.obtainMeshExportTilesetUrl = obtainMeshExportTilesetUrl;
 /** Global configuration initialized by [[initializeFrontendTiles]].
@@ -113,7 +80,7 @@ function initializeFrontendTiles(options) {
     if (options.useIndexedDBCache)
         exports.frontendTilesOptions.useIndexedDBCache = true;
     const computeUrl = options.computeSpatialTilesetBaseUrl ?? (async (iModel) => obtainMeshExportTilesetUrl({ iModel, accessToken: await core_frontend_1.IModelApp.getAccessToken(), enableCDN: options.enableCDN }));
-    core_frontend_1.SpatialTileTreeReferences.create = (view) => (0, BatchedSpatialTileTreeRefs_1.createBatchedSpatialTileTreeReferences)(view, computeUrl);
+    core_frontend_1.SpatialTileTreeReferences.create = (view) => (0, BatchedSpatialTileTreeRefs_1.createBatchedSpatialTileTreeReferences)(view, computeUrl, options.nopFallback ?? false);
 }
 exports.initializeFrontendTiles = initializeFrontendTiles;
 //# sourceMappingURL=FrontendTiles.js.map

package/lib/cjs/FrontendTiles.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrontendTiles.js","sourceRoot":"","sources":["../../src/FrontendTiles.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAA0D;AAC1D,wDAAgH;AAChH,qDAAkD;AAClD,6EAAsF;AAUtF,SAAS,+BAA+B,CAAC,IAAyF;IAChI,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;IACpC,IAAI,GAAG,GAAG,WAAW,MAAM,yCAAyC,IAAI,CAAC,QAAQ,qBAAqB,CAAC;IACvG,IAAI,IAAI,CAAC,WAAW;QAClB,GAAG,GAAG,GAAG,GAAG,gBAAgB,IAAI,CAAC,WAAW,EAAE,CAAC;IAEjD,IAAI,IAAI,CAAC,SAAS;QAChB,GAAG,GAAG,GAAG,GAAG,QAAQ,CAAC;IAEvB,GAAG,GAAG,GAAG,GAAG,kCAAkC,CAAC;IAE/C,OAAO,GAAG,CAAC;AACb,CAAC;AA0DD;;;;GAIG;AACI,KAAK,SAAS,CAAC,CAAC,gBAAgB,CAAC,IAA0B;IAChE,MAAM,OAAO,GAAG;QACd,mEAAmE;QACnE,aAAa,EAAE,IAAI,CAAC,WAAW,IAAI,MAAM,yBAAS,CAAC,cAAc,EAAE;QACnE,mEAAmE;QACnE,MAAM,EAAE,gDAAgD;QACxD,mEAAmE;QACnE,MAAM,EAAE,uBAAuB;QAC/B,mEAAmE;QACnE,SAAS,EAAE,yBAAS,CAAC,SAAS;KAC/B,CAAC;IAEF,IAAI,GAAG,GAAuB,+BAA+B,CAAC,IAAI,CAAC,CAAC;IACpE,OAAO,GAAG,EAAE,CAAC;QACX,IAAI,MAAM,CAAC;QACX,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAC/C,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAiB,CAAC;QAChD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,qBAAM,CAAC,YAAY,CAAC,+BAAc,EAAE,GAAG,CAAC,CAAC;YACzC,qBAAM,CAAC,QAAQ,CAAC,+BAAc,EAAE,qCAAqC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YACtF,MAAM;QACR,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC;QAC5I,KAAK,MAAM,WAAW,IAAI,YAAY;YACpC,MAAM,WAAW,CAAC;QAEpB,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC;IACjC,CAAC;AACH,CAAC;AA9BD,4CA8BC;AAoBD;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAAC,IAAoC;IACnF,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC1B,qBAAM,CAAC,OAAO,CAAC,+BAAc,EAAE,sDAAsD,CAAC,CAAC;QACvF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GAAyB;QACtC,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;QAC9B,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;QACrC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC;IAEF,IAAI,cAAc,CAAC;IACnB,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;QACpD,cAAc,GAAG,GAAG,CAAC;QACrB,MAAM;IACR,CAAC;IAED,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACnD,SAAS,CAAC,WAAW,GAAG,SAAS,CAAC;QAClC,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;YACpD,cAAc,GAAG,GAAG,CAAC;YACrB,qBAAM,CAAC,OAAO,CAAC,+BAAc,EAAE,yBAAyB,IAAI,CAAC,MAAM,CAAC,QAAQ,kBAAkB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,+BAA+B,CAAC,CAAC;YACvJ,MAAM;QACR,CAAC;IACH,CAAC;IAED,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,qBAAM,CAAC,OAAO,CAAC,+BAAc,EAAE,mCAAmC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrD,GAAG,CAAC,QAAQ,GAAG,GAAG,GAAG,CAAC,QAAQ,eAAe,CAAC;IAC9C,OAAO,GAAG,CAAC;AACb,CAAC;AArCD,gEAqCC;AAsCD;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAClC,eAAe,EAAE,CAAC;IAClB,WAAW,EAAE,KAAK;IAClB,iBAAiB,EAAE,KAAK;CACzB,CAAC;AAEF;;GAEG;AACH,SAAgB,uBAAuB,CAAC,OAA6B;IACnE,IAAI,SAAS,KAAK,OAAO,CAAC,eAAe,IAAI,OAAO,CAAC,eAAe,IAAI,CAAC;QACvE,4BAAoB,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAEjE,IAAI,OAAO,CAAC,WAAW;QACrB,4BAAoB,CAAC,WAAW,GAAG,IAAI,CAAC;IAE1C,IAAI,OAAO,CAAC,iBAAiB;QAC3B,4BAAoB,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAEhD,MAAM,UAAU,GAAG,OAAO,CAAC,4BAA4B,IAAI,CACzD,KAAK,EAAE,MAAwB,EAAE,EAAE,CAAC,0BAA0B,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,yBAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CACxJ,CAAC;IAEF,yCAAyB,CAAC,MAAM,GAAG,CAAC,IAAsB,EAAE,EAAE,CAAC,IAAA,mEAAsC,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAC1H,CAAC;AAfD,0DAeC","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\r\nimport { AccessToken, Logger } from \"@itwin/core-bentley\";\r\nimport { IModelApp, IModelConnection, SpatialTileTreeReferences, SpatialViewState } from \"@itwin/core-frontend\";\r\nimport { loggerCategory } from \"./LoggerCategory\";\r\nimport { createBatchedSpatialTileTreeReferences } from \"./BatchedSpatialTileTreeRefs\";\r\n\r\n/** A function that can provide the base URL where a tileset representing all of the spatial models in a given iModel are stored.\r\n * The tileset is expected to reside at \"baseUrl/tileset.json\" and to have been produced by the [mesh export service](https://developer.bentley.com/apis/mesh-export/).\r\n * If no such tileset exists for the given iModel, return `undefined`.\r\n * @see [[FrontendTilesOptions.computeSpatialTilesetBaseUrl]].\r\n * @beta\r\n */\r\nexport type ComputeSpatialTilesetBaseUrl = (iModel: IModelConnection) => Promise<URL | undefined>;\r\n\r\nfunction createMeshExportServiceQueryUrl(args: { iModelId: string, urlPrefix?: string, changesetId?: string, enableCDN?: boolean }): string {\r\n  const prefix = args.urlPrefix ?? \"\";\r\n  let url = `https://${prefix}api.bentley.com/mesh-export/?iModelId=${args.iModelId}&$orderBy=date:desc`;\r\n  if (args.changesetId)\r\n    url = `${url}&changesetId=${args.changesetId}`;\r\n\r\n  if (args.enableCDN)\r\n    url = `${url}&cdn=1`;\r\n\r\n  url = `${url}&tileVersion=1&exportType=IMODEL`;\r\n\r\n  return url;\r\n}\r\n\r\n/** Represents the result of a [mesh export](https://developer.bentley.com/apis/mesh-export/operations/get-export/#export).\r\n * @see [[queryCompletedMeshExports]].\r\n * @beta\r\n */\r\nexport interface MeshExport {\r\n  id: string;\r\n  displayName: string;\r\n  status: string;\r\n  request: {\r\n    iModelId: string;\r\n    changesetId: string;\r\n    exportType: string;\r\n    geometryOptions: any;\r\n    viewDefinitionFilter: any;\r\n  };\r\n\r\n  /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n  _links: {\r\n    mesh: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n\r\n/** Exposed strictly for tests.\r\n * @internal\r\n */\r\nexport interface MeshExports {\r\n  exports: MeshExport[];\r\n\r\n  /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n  _links: {\r\n    next?: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n\r\n/** Arguments supplied to [[queryMeshExports]].\r\n * @beta\r\n */\r\nexport interface QueryMeshExportsArgs {\r\n  /** The token used to access the mesh export service. */\r\n  accessToken: AccessToken;\r\n  /** The Id of the iModel for which to query exports. */\r\n  iModelId: string;\r\n  /** If defined, constrains the query to exports produced from the specified changeset. */\r\n  changesetId?: string;\r\n  /** Chiefly used in testing environments. */\r\n  urlPrefix?: string;\r\n  /** If true, exports whose status is not \"Complete\" (indicating the export successfully finished) will be included in the results. */\r\n  includeIncomplete?: boolean;\r\n  /** If true, enables a CDN (content delivery network) to access tiles faster. */\r\n  enableCDN?: boolean;\r\n}\r\n\r\n/** Query the [mesh export service](https://developer.bentley.com/apis/mesh-export/operations/get-exports/) for exports of type \"IMODEL\" matching\r\n * the specified criteria.\r\n * The exports are sorted from most-recently- to least-recently-produced.\r\n * @beta\r\n */\r\nexport async function* queryMeshExports(args: QueryMeshExportsArgs): AsyncIterableIterator<MeshExport> {\r\n  const headers = {\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    Authorization: args.accessToken ?? await IModelApp.getAccessToken(),\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    Accept: \"application/vnd.bentley.itwin-platform.v1+json\",\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    Prefer: \"return=representation\",\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    SessionId: IModelApp.sessionId,\r\n  };\r\n\r\n  let url: string | undefined = createMeshExportServiceQueryUrl(args);\r\n  while (url) {\r\n    let result;\r\n    try {\r\n      const response = await fetch(url, { headers });\r\n      result = await response.json() as MeshExports;\r\n    } catch (err) {\r\n      Logger.logException(loggerCategory, err);\r\n      Logger.logError(loggerCategory, `Failed loading exports for iModel ${args.iModelId}`);\r\n      break;\r\n    }\r\n\r\n    const foundExports = result.exports.filter((x) => x.request.exportType === \"IMODEL\" && (args.includeIncomplete || x.status === \"Complete\"));\r\n    for (const foundExport of foundExports)\r\n      yield foundExport;\r\n\r\n    url = result._links.next?.href;\r\n  }\r\n}\r\n\r\n/** Arguments supplied  to [[obtainMeshExportTilesetUrl]].\r\n * @beta\r\n */\r\nexport interface ObtainMeshExportTilesetUrlArgs {\r\n  /** The iModel for which to obtain a tileset URl. */\r\n  iModel: IModelConnection;\r\n  /** The token used to access the mesh export service. */\r\n  accessToken: AccessToken;\r\n  /** Chiefly used in testing environments. */\r\n  urlPrefix?: string;\r\n  /** If true, only exports produced for `iModel`'s specific changeset will be considered; otherwise, if no exports are found for the changeset,\r\n   * the most recent export for any changeset will be used.\r\n   */\r\n  requireExactChangeset?: boolean;\r\n  /** If true, enables a CDN (content delivery network) to access tiles faster. */\r\n  enableCDN?: boolean;\r\n}\r\n\r\n/** Obtains a URL pointing to a tileset appropriate for visualizing a specific iModel.\r\n * [[queryCompletedMeshExports]] is used to obtain a list of available exports. By default, the list is sorted from most to least recently-exported.\r\n * The first export matching the iModel's changeset is selected; or, if no such export exists, the first export in the list is selected.\r\n * @returns A URL from which the tileset can be loaded, or `undefined` if no appropriate URL could be obtained.\r\n * @beta\r\n */\r\nexport async function obtainMeshExportTilesetUrl(args: ObtainMeshExportTilesetUrlArgs): Promise<URL | undefined> {\r\n  if (!args.iModel.iModelId) {\r\n    Logger.logInfo(loggerCategory, \"Cannot obtain exports for an iModel with no iModelId\");\r\n    return undefined;\r\n  }\r\n\r\n  const queryArgs: QueryMeshExportsArgs = {\r\n    accessToken: args.accessToken,\r\n    iModelId: args.iModel.iModelId,\r\n    changesetId: args.iModel.changeset.id,\r\n    urlPrefix: args.urlPrefix,\r\n    enableCDN: args.enableCDN,\r\n  };\r\n\r\n  let selectedExport;\r\n  for await (const exp of queryMeshExports(queryArgs)) {\r\n    selectedExport = exp;\r\n    break;\r\n  }\r\n\r\n  if (!selectedExport && !args.requireExactChangeset) {\r\n    queryArgs.changesetId = undefined;\r\n    for await (const exp of queryMeshExports(queryArgs)) {\r\n      selectedExport = exp;\r\n      Logger.logInfo(loggerCategory, `No exports for iModel ${args.iModel.iModelId} for changeset ${args.iModel.changeset.id}; falling back to most recent`);\r\n      break;\r\n    }\r\n  }\r\n\r\n  if (!selectedExport) {\r\n    Logger.logInfo(loggerCategory, `No exports available for iModel ${args.iModel.iModelId}`);\r\n    return undefined;\r\n  }\r\n\r\n  const url = new URL(selectedExport._links.mesh.href);\r\n  url.pathname = `${url.pathname}/tileset.json`;\r\n  return url;\r\n}\r\n\r\n/** Options supplied to [[initializeFrontendTiles]].\r\n * @beta\r\n */\r\nexport interface FrontendTilesOptions {\r\n  /** Provide the base URL for the pre-published tileset for a given iModel.\r\n   * If omitted, [[obtainMeshExportTilesetUrl]] will be invoked with default arguments, using the access token provided by [[IModelApp]].\r\n   */\r\n  computeSpatialTilesetBaseUrl?: ComputeSpatialTilesetBaseUrl;\r\n  /** The maximum number of levels in the tile tree to skip loading if they do not provide the desired level of detail for the current view.\r\n   * Default: 4.\r\n   * Reducing this value will load more intermediate tiles, which causes more gradual refinement: low-resolution tiles will display quickly, followed more gradually by\r\n   * successively higher-resolution ones.\r\n   * Increasing the value jumps more directly to tiles of the exact level of detail desired, which may load more, smaller tiles up-front, leaving some areas of the view\r\n   * vacant for longer; and when zooming out some newly-exposed areas of the view may remain vacant for longer because no lower-resolution tiles are initially available to\r\n   * fill them. However, tiles close to the viewer (and therefore likely of most interest to them) will refine to an appropriate level of detail more quickly.\r\n   */\r\n  maxLevelsToSkip?: number;\r\n  /** Specifies whether to permit the user to enable visible edges or wireframe mode for batched tiles.\r\n   * The currently-deployed mesh export service does not produce edges, so this currently defaults to `false` to avoid user confusion.\r\n   * Set it to `true` if you are loading tiles created with a version of the exporter that does produce edges.\r\n   * ###TODO delete this option once we deploy an edge-producing version of the exporter to production.\r\n   * @internal\r\n   */\r\n  enableEdges?: boolean;\r\n  /** Specifies whether to enable a CDN (content delivery network) to access tiles faster.\r\n   * This option is only used if computeSpatialTilesetBaseUrl is not defined.\r\n   * @beta\r\n   */\r\n  enableCDN?: boolean;\r\n  /** Specifies whether to enable an IndexedDB database for use as a local cache.\r\n  * Requested tiles will then first be search for in the database, and if not found, fetched as normal.\r\n  * @internal\r\n  */\r\n  useIndexedDBCache?: boolean;\r\n}\r\n\r\n/** Global configuration initialized by [[initializeFrontendTiles]].\r\n * @internal\r\n */\r\nexport const frontendTilesOptions = {\r\n  maxLevelsToSkip: 4,\r\n  enableEdges: false,\r\n  useIndexedDBCache: false,\r\n};\r\n\r\n/** Initialize the frontend-tiles package to obtain tiles for spatial views.\r\n * @beta\r\n */\r\nexport function initializeFrontendTiles(options: FrontendTilesOptions): void {\r\n  if (undefined !== options.maxLevelsToSkip && options.maxLevelsToSkip >= 0)\r\n    frontendTilesOptions.maxLevelsToSkip = options.maxLevelsToSkip;\r\n\r\n  if (options.enableEdges)\r\n    frontendTilesOptions.enableEdges = true;\r\n\r\n  if (options.useIndexedDBCache)\r\n    frontendTilesOptions.useIndexedDBCache = true;\r\n\r\n  const computeUrl = options.computeSpatialTilesetBaseUrl ?? (\r\n    async (iModel: IModelConnection) => obtainMeshExportTilesetUrl({ iModel, accessToken: await IModelApp.getAccessToken(), enableCDN: options.enableCDN })\r\n  );\r\n\r\n  SpatialTileTreeReferences.create = (view: SpatialViewState) => createBatchedSpatialTileTreeReferences(view, computeUrl);\r\n}\r\n"]}
+{"version":3,"file":"FrontendTiles.js","sourceRoot":"","sources":["../../src/FrontendTiles.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,wDAAgH;AAChH,6EAAsF;AACtF,oGAA+F;AAE/F,0EAAwG;AAoExG;;;;GAIG;AACI,KAAK,SAAS,CAAC,CAAC,gBAAgB,CAAC,IAA0B;IAChE,MAAM,YAAY,GAAG;QACnB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,SAAS,EAAE,yBAAS,CAAC,SAAS;QAC9B,UAAU,EAAE;YACV,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,EAAE,EAAE,IAAI,CAAC,QAAQ;YACjB,QAAQ,EAAE,IAAI,CAAC,WAAW;YAC1B,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC;IAEF,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAA,2DAA2B,EAAC,YAAY,CAAC,EAAC,CAAC;QAClE,MAAM,UAAU,GAAG;YACjB,EAAE,EAAE,IAAI,CAAC,gBAAgB;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE;gBACP,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC5B,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,EAAE;gBAC3C,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;gBAChC,eAAe,EAAE,EAAE;gBACnB,oBAAoB,EAAE,EAAE;aACzB;YAED,mEAAmE;YACnE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,IAAI,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE;iBACrB;aACF;SACF,CAAC;QAEF,MAAM,UAAU,CAAC;IACnB,CAAC;AACH,CAAC;AAtCD,4CAsCC;AAOD;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAAC,IAAoC;IACnF,OAAO,IAAA,yCAAsB,EAAC,IAAI,CAAC,CAAC;AACtC,CAAC;AAFD,gEAEC;AA2CD;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAClC,eAAe,EAAE,CAAC;IAClB,WAAW,EAAE,KAAK;IAClB,iBAAiB,EAAE,KAAK;CACzB,CAAC;AAEF;;GAEG;AACH,SAAgB,uBAAuB,CAAC,OAA6B;IACnE,IAAI,SAAS,KAAK,OAAO,CAAC,eAAe,IAAI,OAAO,CAAC,eAAe,IAAI,CAAC;QACvE,4BAAoB,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAEjE,IAAI,OAAO,CAAC,WAAW;QACrB,4BAAoB,CAAC,WAAW,GAAG,IAAI,CAAC;IAE1C,IAAI,OAAO,CAAC,iBAAiB;QAC3B,4BAAoB,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAEhD,MAAM,UAAU,GAAG,OAAO,CAAC,4BAA4B,IAAI,CACzD,KAAK,EAAE,MAAwB,EAAE,EAAE,CAAC,0BAA0B,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,yBAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CACxJ,CAAC;IAEF,yCAAyB,CAAC,MAAM,GAAG,CAAC,IAAsB,EAAE,EAAE,CAAC,IAAA,mEAAsC,EAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,WAAW,IAAI,KAAK,CAAC,CAAC;AACxJ,CAAC;AAfD,0DAeC","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\r\nimport { IModelApp, IModelConnection, SpatialTileTreeReferences, SpatialViewState } from \"@itwin/core-frontend\";\r\nimport { createBatchedSpatialTileTreeReferences } from \"./BatchedSpatialTileTreeRefs\";\r\nimport { queryGraphicRepresentations } from \"./GraphicsProvider/GraphicRepresentationProvider\";\r\nimport { AccessToken } from \"@itwin/core-bentley\";\r\nimport { obtainIModelTilesetUrl, ObtainIModelTilesetUrlArgs} from \"./GraphicsProvider/GraphicsProvider\";\r\n\r\n/** A function that can provide the base URL where a tileset representing all of the spatial models in a given iModel are stored.\r\n * The tileset is expected to reside at \"baseUrl/tileset.json\" and to have been produced by the [mesh export service](https://developer.bentley.com/apis/mesh-export/).\r\n * If no such tileset exists for the given iModel, return `undefined`.\r\n * @see [[FrontendTilesOptions.computeSpatialTilesetBaseUrl]].\r\n * @beta\r\n */\r\nexport type ComputeSpatialTilesetBaseUrl = (iModel: IModelConnection) => Promise<URL | undefined>;\r\n\r\n/** Represents the result of a [mesh export](https://developer.bentley.com/apis/mesh-export/operations/get-export/#export).\r\n * @see [[queryCompletedMeshExports]].\r\n * @beta\r\n */\r\nexport interface MeshExport {\r\n  id: string;\r\n  displayName: string;\r\n  status: string;\r\n  request: {\r\n    iModelId: string;\r\n    changesetId: string;\r\n    exportType: string;\r\n    geometryOptions: any;\r\n    viewDefinitionFilter: any;\r\n  };\r\n\r\n  /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n  _links: {\r\n    mesh: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n\r\n/** Exposed strictly for tests.\r\n * @internal\r\n */\r\nexport interface MeshExports {\r\n  exports: MeshExport[];\r\n\r\n  /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n  _links: {\r\n    next?: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n\r\n/** Arguments supplied to [[queryMeshExports]].\r\n * @beta\r\n */\r\nexport interface QueryMeshExportsArgs {\r\n  /** The token used to access the mesh export service. */\r\n  accessToken: AccessToken;\r\n  /** The iTwinId associated with the Mesh Export */\r\n  iTwinId: string;\r\n  /** The Id of the iModel for which to query exports. */\r\n  iModelId: string;\r\n  /** If defined, constrains the query to exports produced from the specified changeset. */\r\n  changesetId?: string;\r\n  /** Chiefly used in testing environments. */\r\n  urlPrefix?: string;\r\n  /** If true, exports whose status is not \"Complete\" (indicating the export successfully finished) will be included in the results. */\r\n  includeIncomplete?: boolean;\r\n  /** If true, enables a CDN (content delivery network) to access tiles faster. */\r\n  enableCDN?: boolean;\r\n}\r\n\r\n/** Query the [mesh export service](https://developer.bentley.com/apis/mesh-export/operations/get-exports/) for exports of type \"IMODEL\" matching\r\n * the specified criteria.\r\n * The exports are sorted from most-recently- to least-recently-produced.\r\n * @beta\r\n */\r\nexport async function* queryMeshExports(args: QueryMeshExportsArgs): AsyncIterableIterator<MeshExport> {\r\n  const graphicsArgs = {\r\n    accessToken: args.accessToken,\r\n    sessionId: IModelApp.sessionId,\r\n    dataSource: {\r\n      iTwinId: args.iTwinId,\r\n      id: args.iModelId,\r\n      changeId: args.changesetId,\r\n      type: \"IMODEL\",\r\n    },\r\n    format: \"IMDL\",\r\n    urlPrefix: args.urlPrefix,\r\n    enableCDN: args.enableCDN,\r\n  };\r\n\r\n  for await (const data of queryGraphicRepresentations(graphicsArgs)){\r\n    const meshExport = {\r\n      id: data.representationId,\r\n      displayName: data.displayName,\r\n      status: \"Complete\",\r\n      request: {\r\n        iModelId: data.dataSource.id,\r\n        changesetId: data.dataSource.changeId ?? \"\",\r\n        exportType: data.dataSource.type,\r\n        geometryOptions: {},\r\n        viewDefinitionFilter: {},\r\n      },\r\n\r\n      /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n      _links: {\r\n        mesh: {\r\n          href: data.url ?? \"\",\r\n        },\r\n      },\r\n    };\r\n\r\n    yield meshExport;\r\n  }\r\n}\r\n\r\n/** Arguments supplied  to [[obtainMeshExportTilesetUrl]].\r\n * @beta\r\n */\r\nexport type ObtainMeshExportTilesetUrlArgs = ObtainIModelTilesetUrlArgs;\r\n\r\n/** Obtains a URL pointing to a tileset appropriate for visualizing a specific iModel.\r\n * [[queryCompletedMeshExports]] is used to obtain a list of available exports. By default, the list is sorted from most to least recently-exported.\r\n * The first export matching the iModel's changeset is selected; or, if no such export exists, the first export in the list is selected.\r\n * @returns A URL from which the tileset can be loaded, or `undefined` if no appropriate URL could be obtained.\r\n * @beta\r\n */\r\nexport async function obtainMeshExportTilesetUrl(args: ObtainMeshExportTilesetUrlArgs): Promise<URL | undefined> {\r\n  return obtainIModelTilesetUrl(args);\r\n}\r\n/** Options supplied to [[initializeFrontendTiles]].\r\n * @beta\r\n */\r\nexport interface FrontendTilesOptions {\r\n  /** Provide the base URL for the pre-published tileset for a given iModel.\r\n   * If omitted, [[obtainMeshExportTilesetUrl]] will be invoked with default arguments, using the access token provided by [[IModelApp]].\r\n   */\r\n  computeSpatialTilesetBaseUrl?: ComputeSpatialTilesetBaseUrl;\r\n  /** The maximum number of levels in the tile tree to skip loading if they do not provide the desired level of detail for the current view.\r\n   * Default: 4.\r\n   * Reducing this value will load more intermediate tiles, which causes more gradual refinement: low-resolution tiles will display quickly, followed more gradually by\r\n   * successively higher-resolution ones.\r\n   * Increasing the value jumps more directly to tiles of the exact level of detail desired, which may load more, smaller tiles up-front, leaving some areas of the view\r\n   * vacant for longer; and when zooming out some newly-exposed areas of the view may remain vacant for longer because no lower-resolution tiles are initially available to\r\n   * fill them. However, tiles close to the viewer (and therefore likely of most interest to them) will refine to an appropriate level of detail more quickly.\r\n   */\r\n  maxLevelsToSkip?: number;\r\n  /** Specifies whether to permit the user to enable visible edges or wireframe mode for batched tiles.\r\n   * The currently-deployed mesh export service does not produce edges, so this currently defaults to `false` to avoid user confusion.\r\n   * Set it to `true` if you are loading tiles created with a version of the exporter that does produce edges.\r\n   * ###TODO delete this option once we deploy an edge-producing version of the exporter to production.\r\n   * @internal\r\n   */\r\n  enableEdges?: boolean;\r\n  /** Specifies whether to enable a CDN (content delivery network) to access tiles faster.\r\n   * This option is only used if computeSpatialTilesetBaseUrl is not defined.\r\n   * @beta\r\n   */\r\n  enableCDN?: boolean;\r\n  /** Specifies whether to enable an IndexedDB database for use as a local cache.\r\n  * Requested tiles will then first be search for in the database, and if not found, fetched as normal.\r\n  * @internal\r\n  */\r\n  useIndexedDBCache?: boolean;\r\n\r\n  /** If true, an empty tile tree will be used as fallback if the tileset is not found or invalid.\r\n   * If false or not defined, the default tiles will be used as a fallback.\r\n   * @internal\r\n   */\r\n  nopFallback?: boolean;\r\n}\r\n\r\n/** Global configuration initialized by [[initializeFrontendTiles]].\r\n * @internal\r\n */\r\nexport const frontendTilesOptions = {\r\n  maxLevelsToSkip: 4,\r\n  enableEdges: false,\r\n  useIndexedDBCache: false,\r\n};\r\n\r\n/** Initialize the frontend-tiles package to obtain tiles for spatial views.\r\n * @beta\r\n */\r\nexport function initializeFrontendTiles(options: FrontendTilesOptions): void {\r\n  if (undefined !== options.maxLevelsToSkip && options.maxLevelsToSkip >= 0)\r\n    frontendTilesOptions.maxLevelsToSkip = options.maxLevelsToSkip;\r\n\r\n  if (options.enableEdges)\r\n    frontendTilesOptions.enableEdges = true;\r\n\r\n  if (options.useIndexedDBCache)\r\n    frontendTilesOptions.useIndexedDBCache = true;\r\n\r\n  const computeUrl = options.computeSpatialTilesetBaseUrl ?? (\r\n    async (iModel: IModelConnection) => obtainMeshExportTilesetUrl({ iModel, accessToken: await IModelApp.getAccessToken(), enableCDN: options.enableCDN })\r\n  );\r\n\r\n  SpatialTileTreeReferences.create = (view: SpatialViewState) => createBatchedSpatialTileTreeReferences(view, computeUrl, options.nopFallback ?? false);\r\n}\r\n"]}

package/lib/cjs/GraphicsProvider/GraphicRepresentationProvider.d.ts

@@ -0,0 +1,124 @@
+import { AccessToken } from "@itwin/core-bentley";
+/** The expected format of the Graphic Representation
+ * @beta
+ */
+export type GraphicRepresentationFormat = "IMDL" | "3DTILES" | string;
+/** Graphic representations are generated from Data Sources.
+ * The status of a Graphic Representation indicates the progress of that generation process.
+ * @beta
+ */
+export declare enum GraphicRepresentationStatus {
+    InProgress = "In progress",
+    Complete = "Complete",
+    NotStarted = "Not started",
+    Failed = "Failed"
+}
+/**
+ * Represents a data source for a graphic representation.
+ * A data source is usually higher-fidelity and contains more information, but may not be as well suited for visualization
+ * as a graphic representation.
+ * @beta
+ */
+export interface DataSource {
+    /** The iTwinId associated with the DataSource */
+    iTwinId: string;
+    /** The unique identifier of a DataSource.
+     * For example, a DataSource of type "IMODEL" has an iModelId which would be attributed to this value.
+     */
+    id: string;
+    /** The unique identifier for a specific version of a DataSource.
+     * For example, if a specific version of an iModel is desired, the iModel's changesetId would be attributed to this value.
+    */
+    changeId?: string;
+    /** The type of the data source. For example, a DataSource can be of type "IMODEL" or "RealityData" */
+    type: string;
+}
+/** Represents a visual representation of a data source, for example a 3d tileset.
+ * A data source can be an iModel, reality data, or other kind of graphical data.
+ * @see [[queryGraphicRepresentations]] for its construction as a representation of the data produced by a query of data sources.
+ * @beta
+ */
+export type GraphicRepresentation = {
+    /** The display name of the Graphic Representation */
+    displayName: string;
+    /** The unique identifier for the Graphic Representation */
+    representationId: string;
+    /** The status of the generation of the Graphic Representation from its Data Source.
+     * @see [[GraphicRepresentationStatus]] for possible values.
+     */
+    status: GraphicRepresentationStatus;
+    /** The expected format of the Graphic Representation
+     * @see [[GraphicRepresentationFormat]] for possible values.
+     */
+    format: GraphicRepresentationFormat;
+    /** The data source that the representation originates from.
+     * For example, a GraphicRepresentation in the 3D Tiles format might have a dataSource that is a specific iModel changeset.
+     */
+    dataSource: DataSource;
+} & ({
+    status: Omit<GraphicRepresentationStatus, GraphicRepresentationStatus.Complete>;
+    url?: string;
+} | {
+    status: GraphicRepresentationStatus.Complete;
+    url: string;
+});
+/** Arguments supplied to [[queryGraphicRepresentations]].
+ * @beta
+ */
+export interface QueryGraphicRepresentationsArgs {
+    /** The token used to access the data source provider. */
+    accessToken: AccessToken;
+    /** The unique identifier for the session in which this data source was queried.
+     * A possible value is IModelApp.sessionId.
+     */
+    sessionId: string;
+    /** The Data Source for which to query the graphic representations */
+    dataSource: DataSource;
+    /** The expected format of the graphic representations
+     * @see [[GraphicRepresentationFormat]] for possible values.
+     */
+    format: GraphicRepresentationFormat;
+    /** Chiefly used in testing environments. */
+    urlPrefix?: string;
+    /** If true, exports whose status is not "Complete" (indicating the export successfully finished) will be included in the results */
+    includeIncomplete?: boolean;
+    /** If true, enables a CDN (content delivery network) to access tiles faster. */
+    enableCDN?: boolean;
+}
+/** Query Graphic Representations matching the specified criteria, sorted from most-recently- to least-recently-produced.
+ * @beta
+ */
+export declare function queryGraphicRepresentations(args: QueryGraphicRepresentationsArgs): AsyncIterableIterator<GraphicRepresentation>;
+/** Arguments supplied  to [[obtainGraphicRepresentationUrl]].
+ * @beta
+ */
+export interface ObtainGraphicRepresentationUrlArgs {
+    /** The token used to access the mesh export service. */
+    accessToken: AccessToken;
+    /** The unique identifier for the session in which this data source was queried.
+     * A possible value is IModelApp.sessionId.
+     */
+    sessionId: string;
+    /** The data source for which to query the graphic representations */
+    dataSource: DataSource;
+    /** The expected format of the graphic representations
+     * @see [[GraphicRepresentationFormat]] for possible values.
+     */
+    format: GraphicRepresentationFormat;
+    /** Chiefly used in testing environments. */
+    urlPrefix?: string;
+    /** If true, only data produced for a specific data source version will be considered;
+     * otherwise, if no data sources are found with the specified version,the most recent data source version will be used.
+     */
+    requireExactVersion?: boolean;
+    /** If true, enables a CDN (content delivery network) to access tiles faster. */
+    enableCDN?: boolean;
+}
+/** Obtains a URL pointing to a Graphic Representation.
+ * [[queryGraphicRepresentations]] is used to obtain a list of available representations. By default, the list is sorted from most to least recently-created.
+ * The first representation matching the source version is selected; or, if no such representation exists, the first representation in the list is selected.
+ * @returns A URL from which the tileset can be loaded, or `undefined` if no appropriate URL could be obtained.
+ * @beta
+ */
+export declare function obtainGraphicRepresentationUrl(args: ObtainGraphicRepresentationUrlArgs): Promise<URL | undefined>;
+//# sourceMappingURL=GraphicRepresentationProvider.d.ts.map

package/lib/cjs/GraphicsProvider/GraphicRepresentationProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphicRepresentationProvider.d.ts","sourceRoot":"","sources":["../../../src/GraphicsProvider/GraphicRepresentationProvider.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAS,MAAM,qBAAqB,CAAC;AAIzD;;GAEG;AAEH,MAAM,MAAM,2BAA2B,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC;AAEtE;;;GAGG;AACH,oBAAY,2BAA2B;IACrC,UAAU,gBAAgB;IAC1B,QAAQ,aAAa;IACrB,UAAU,gBAAgB;IAC1B,MAAM,WAAW;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;MAEE;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sGAAsG;IACtG,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,qDAAqD;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC;IACpC;;OAEG;IACH,MAAM,EAAG,2BAA2B,CAAC;IACrC;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CAKxB,GAAG,CAAC;IACH,MAAM,EAAE,IAAI,CAAC,2BAA2B,EAAE,2BAA2B,CAAC,QAAQ,CAAC,CAAC;IAChF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GAAG;IACF,MAAM,EAAE,2BAA2B,CAAC,QAAQ,CAAC;IAC7C,GAAG,EAAE,MAAM,CAAC;CACb,CAAC,CAAC;AAkBH;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,yDAAyD;IACzD,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,MAAM,EAAG,2BAA2B,CAAC;IACrC,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oIAAoI;IACpI,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gFAAgF;IAChF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,wBAAuB,2BAA2B,CAAC,IAAI,EAAE,+BAA+B,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,CA4EtI;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,wDAAwD;IACxD,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,MAAM,EAAG,2BAA2B,CAAC;IACrC,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,gFAAgF;IAChF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;GAKG;AACH,wBAAsB,8BAA8B,CAAC,IAAI,EAAE,kCAAkC,GAAG,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC,CAsCvH"}

package/lib/cjs/GraphicsProvider/GraphicRepresentationProvider.js

@@ -0,0 +1,122 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.obtainGraphicRepresentationUrl = exports.queryGraphicRepresentations = exports.GraphicRepresentationStatus = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const LoggerCategory_1 = require("../LoggerCategory");
+const core_frontend_1 = require("@itwin/core-frontend");
+/** Graphic representations are generated from Data Sources.
+ * The status of a Graphic Representation indicates the progress of that generation process.
+ * @beta
+ */
+var GraphicRepresentationStatus;
+(function (GraphicRepresentationStatus) {
+    GraphicRepresentationStatus["InProgress"] = "In progress";
+    GraphicRepresentationStatus["Complete"] = "Complete";
+    GraphicRepresentationStatus["NotStarted"] = "Not started";
+    GraphicRepresentationStatus["Failed"] = "Failed";
+})(GraphicRepresentationStatus || (exports.GraphicRepresentationStatus = GraphicRepresentationStatus = {}));
+/** Creates a URL used to query for Graphic Representations */
+function createGraphicRepresentationsQueryUrl(args) {
+    const prefix = args.urlPrefix ?? "";
+    let url = `https://${prefix}api.bentley.com/mesh-export/?iModelId=${args.sourceId}&$orderBy=date:desc`;
+    if (args.changeId)
+        url = `${url}&changesetId=${args.changeId}`;
+    if (args.enableCDN)
+        url = `${url}&cdn=1`;
+    const tileVersion = core_frontend_1.IModelApp.tileAdmin.maximumMajorTileFormatVersion.toString();
+    url = `${url}&tileVersion=${tileVersion}&iTwinJS=${core_frontend_1.ITWINJS_CORE_VERSION}&exportType=${args.sourceType}`;
+    return url;
+}
+/** Query Graphic Representations matching the specified criteria, sorted from most-recently- to least-recently-produced.
+ * @beta
+ */
+async function* queryGraphicRepresentations(args) {
+    const headers = {
+        /* eslint-disable-next-line @typescript-eslint/naming-convention */
+        Authorization: args.accessToken,
+        /* eslint-disable-next-line @typescript-eslint/naming-convention */
+        Accept: "application/vnd.bentley.itwin-platform.v1+json",
+        /* eslint-disable-next-line @typescript-eslint/naming-convention */
+        Prefer: "return=representation",
+        /* eslint-disable-next-line @typescript-eslint/naming-convention */
+        SessionId: args.sessionId,
+    };
+    let url = createGraphicRepresentationsQueryUrl({ sourceId: args.dataSource.id, sourceType: args.dataSource.type, urlPrefix: args.urlPrefix, changeId: args.dataSource.changeId, enableCDN: args.enableCDN });
+    while (url) {
+        let result;
+        try {
+            const response = await fetch(url, { headers });
+            result = await response.json();
+        }
+        catch (err) {
+            core_bentley_1.Logger.logException(LoggerCategory_1.loggerCategory, err);
+            core_bentley_1.Logger.logError(LoggerCategory_1.loggerCategory, `Failed loading Graphics Data for Source ${args.dataSource.id}`);
+            break;
+        }
+        const foundSources = result.exports.filter((x) => x.request.exportType === args.dataSource.type && (args.includeIncomplete || x.status === GraphicRepresentationStatus.Complete));
+        for (const foundSource of foundSources) {
+            const graphicRepresentation = {
+                displayName: foundSource.displayName,
+                representationId: foundSource.id,
+                status: foundSource.status,
+                format: args.format,
+                url: foundSource._links.mesh.href,
+                dataSource: {
+                    iTwinId: args.dataSource.iTwinId,
+                    id: foundSource.request.iModelId,
+                    versionId: foundSource.request.changesetId,
+                    type: foundSource.request.exportType,
+                },
+            };
+            yield graphicRepresentation;
+        }
+        url = result._links.next?.href;
+    }
+}
+exports.queryGraphicRepresentations = queryGraphicRepresentations;
+/** Obtains a URL pointing to a Graphic Representation.
+ * [[queryGraphicRepresentations]] is used to obtain a list of available representations. By default, the list is sorted from most to least recently-created.
+ * The first representation matching the source version is selected; or, if no such representation exists, the first representation in the list is selected.
+ * @returns A URL from which the tileset can be loaded, or `undefined` if no appropriate URL could be obtained.
+ * @beta
+ */
+async function obtainGraphicRepresentationUrl(args) {
+    if (!args.dataSource.id) {
+        core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, "Cannot obtain Graphics Data from a source without an Id");
+        return undefined;
+    }
+    const queryArgs = {
+        accessToken: args.accessToken,
+        sessionId: args.sessionId,
+        dataSource: args.dataSource,
+        format: args.format,
+        urlPrefix: args.urlPrefix,
+        enableCDN: args.enableCDN,
+    };
+    let selectedData;
+    for await (const data of queryGraphicRepresentations(queryArgs)) {
+        selectedData = data;
+        break;
+    }
+    if (!selectedData && !args.requireExactVersion) {
+        queryArgs.dataSource.changeId = undefined;
+        for await (const data of queryGraphicRepresentations(queryArgs)) {
+            selectedData = data;
+            core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, `No data for Data Source ${args.dataSource.id} for version ${args.dataSource.changeId}; falling back to most recent`);
+            break;
+        }
+    }
+    if ((!selectedData) || (!selectedData.url)) {
+        core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, `No data available for Data Source ${args.dataSource.id}`);
+        return undefined;
+    }
+    const url = new URL(selectedData.url);
+    url.pathname = `${url.pathname}/tileset.json`;
+    return url;
+}
+exports.obtainGraphicRepresentationUrl = obtainGraphicRepresentationUrl;
+//# sourceMappingURL=GraphicRepresentationProvider.js.map

package/lib/cjs/GraphicsProvider/GraphicRepresentationProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphicRepresentationProvider.js","sourceRoot":"","sources":["../../../src/GraphicsProvider/GraphicRepresentationProvider.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,sDAAyD;AACzD,sDAAkD;AAClD,wDAAuE;AAQvE;;;GAGG;AACH,IAAY,2BAKX;AALD,WAAY,2BAA2B;IACrC,yDAA0B,CAAA;IAC1B,oDAAqB,CAAA;IACrB,yDAA0B,CAAA;IAC1B,gDAAiB,CAAA;AACnB,CAAC,EALW,2BAA2B,2CAA3B,2BAA2B,QAKtC;AAyDD,8DAA8D;AAC9D,SAAS,oCAAoC,CAAC,IAA0G;IACtJ,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;IACpC,IAAI,GAAG,GAAG,WAAW,MAAM,yCAAyC,IAAI,CAAC,QAAQ,qBAAqB,CAAC;IACvG,IAAI,IAAI,CAAC,QAAQ;QACf,GAAG,GAAG,GAAG,GAAG,gBAAgB,IAAI,CAAC,QAAQ,EAAE,CAAC;IAE9C,IAAI,IAAI,CAAC,SAAS;QAChB,GAAG,GAAG,GAAG,GAAG,QAAQ,CAAC;IAEvB,MAAM,WAAW,GAAG,yBAAS,CAAC,SAAS,CAAC,6BAA6B,CAAC,QAAQ,EAAE,CAAC;IACjF,GAAG,GAAG,GAAG,GAAG,gBAAgB,WAAW,YAAY,oCAAoB,eAAe,IAAI,CAAC,UAAU,EAAE,CAAC;IAExG,OAAO,GAAG,CAAC;AACb,CAAC;AA0BD;;GAEG;AACI,KAAK,SAAS,CAAC,CAAC,2BAA2B,CAAC,IAAqC;IAgCtF,MAAM,OAAO,GAAG;QACd,mEAAmE;QACnE,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,mEAAmE;QACnE,MAAM,EAAE,gDAAgD;QACxD,mEAAmE;QACnE,MAAM,EAAE,uBAAuB;QAC/B,mEAAmE;QACnE,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC;IAEF,IAAI,GAAG,GAAuB,oCAAoC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IACjO,OAAO,GAAG,EAAE,CAAC;QACX,IAAI,MAAM,CAAC;QACX,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAC/C,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAA0B,CAAC;QACzD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,qBAAM,CAAC,YAAY,CAAC,+BAAc,EAAE,GAAG,CAAC,CAAC;YACzC,qBAAM,CAAC,QAAQ,CAAC,+BAAc,EAAE,2CAA2C,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;YACjG,MAAM;QACR,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC,MAAM,KAAK,2BAA2B,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClL,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;YACvC,MAAM,qBAAqB,GAAG;gBAC5B,WAAW,EAAE,WAAW,CAAC,WAAW;gBACpC,gBAAgB,EAAE,WAAW,CAAC,EAAE;gBAChC,MAAM,EAAE,WAAW,CAAC,MAAM;gBAC1B,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI;gBACjC,UAAU,EAAE;oBACV,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO;oBAChC,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ;oBAChC,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,WAAW;oBAC1C,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,UAAU;iBACrC;aACF,CAAC;YAEF,MAAM,qBAAqB,CAAC;QAC9B,CAAC;QAED,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC;IACjC,CAAC;AACH,CAAC;AA5ED,kEA4EC;AA4BD;;;;;GAKG;AACI,KAAK,UAAU,8BAA8B,CAAC,IAAwC;IAC3F,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACxB,qBAAM,CAAC,OAAO,CAAC,+BAAc,EAAE,yDAAyD,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GAAoC;QACjD,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC;IAEF,IAAI,YAAY,CAAC;IACjB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,2BAA2B,CAAC,SAAS,CAAC,EAAE,CAAC;QAChE,YAAY,GAAG,IAAI,CAAC;QACpB,MAAM;IACR,CAAC;IAED,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC/C,SAAS,CAAC,UAAU,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,2BAA2B,CAAC,SAAS,CAAC,EAAE,CAAC;YAChE,YAAY,GAAG,IAAI,CAAC;YACpB,qBAAM,CAAC,OAAO,CAAC,+BAAc,EAAE,2BAA2B,IAAI,CAAC,UAAU,CAAC,EAAE,gBAAgB,IAAI,CAAC,UAAU,CAAC,QAAQ,+BAA+B,CAAC,CAAC;YACrJ,MAAM;QACR,CAAC;IACH,CAAC;IAED,IAAI,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,qBAAM,CAAC,OAAO,CAAC,+BAAc,EAAE,qCAAqC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACtC,GAAG,CAAC,QAAQ,GAAG,GAAG,GAAG,CAAC,QAAQ,eAAe,CAAC;IAC9C,OAAO,GAAG,CAAC;AACb,CAAC;AAtCD,wEAsCC","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\r\nimport { AccessToken, Logger} from \"@itwin/core-bentley\";\r\nimport { loggerCategory} from \"../LoggerCategory\";\r\nimport { IModelApp, ITWINJS_CORE_VERSION } from \"@itwin/core-frontend\";\r\n\r\n/** The expected format of the Graphic Representation\r\n * @beta\r\n */\r\n/* eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents */\r\nexport type GraphicRepresentationFormat = \"IMDL\" | \"3DTILES\" | string;\r\n\r\n/** Graphic representations are generated from Data Sources.\r\n * The status of a Graphic Representation indicates the progress of that generation process.\r\n * @beta\r\n */\r\nexport enum GraphicRepresentationStatus {\r\n  InProgress = \"In progress\",\r\n  Complete = \"Complete\",\r\n  NotStarted = \"Not started\",\r\n  Failed = \"Failed\",\r\n}\r\n\r\n/**\r\n * Represents a data source for a graphic representation.\r\n * A data source is usually higher-fidelity and contains more information, but may not be as well suited for visualization\r\n * as a graphic representation.\r\n * @beta\r\n */\r\nexport interface DataSource {\r\n  /** The iTwinId associated with the DataSource */\r\n  iTwinId: string;\r\n  /** The unique identifier of a DataSource.\r\n   * For example, a DataSource of type \"IMODEL\" has an iModelId which would be attributed to this value.\r\n   */\r\n  id: string;\r\n  /** The unique identifier for a specific version of a DataSource.\r\n   * For example, if a specific version of an iModel is desired, the iModel's changesetId would be attributed to this value.\r\n  */\r\n  changeId?: string;\r\n  /** The type of the data source. For example, a DataSource can be of type \"IMODEL\" or \"RealityData\" */\r\n  type: string;\r\n}\r\n\r\n/** Represents a visual representation of a data source, for example a 3d tileset.\r\n * A data source can be an iModel, reality data, or other kind of graphical data.\r\n * @see [[queryGraphicRepresentations]] for its construction as a representation of the data produced by a query of data sources.\r\n * @beta\r\n */\r\nexport type GraphicRepresentation = {\r\n  /** The display name of the Graphic Representation */\r\n  displayName: string;\r\n  /** The unique identifier for the Graphic Representation */\r\n  representationId: string;\r\n  /** The status of the generation of the Graphic Representation from its Data Source.\r\n   * @see [[GraphicRepresentationStatus]] for possible values.\r\n   */\r\n  status: GraphicRepresentationStatus;\r\n  /** The expected format of the Graphic Representation\r\n   * @see [[GraphicRepresentationFormat]] for possible values.\r\n   */\r\n  format:  GraphicRepresentationFormat;\r\n  /** The data source that the representation originates from.\r\n   * For example, a GraphicRepresentation in the 3D Tiles format might have a dataSource that is a specific iModel changeset.\r\n   */\r\n  dataSource: DataSource;\r\n  /** The url of the graphic representation\r\n   * @note The url can only be guaranteed to be valid if the status is complete.\r\n   * Therefore, the url is optional if the status is not complete, and required if the status is complete.\r\n   */\r\n} & ({\r\n  status: Omit<GraphicRepresentationStatus, GraphicRepresentationStatus.Complete>;\r\n  url?: string;\r\n} | {\r\n  status: GraphicRepresentationStatus.Complete;\r\n  url: string;\r\n});\r\n\r\n/** Creates a URL used to query for Graphic Representations */\r\nfunction createGraphicRepresentationsQueryUrl(args: { sourceId: string, sourceType: string, urlPrefix?: string, changeId?: string, enableCDN?: boolean }): string {\r\n  const prefix = args.urlPrefix ?? \"\";\r\n  let url = `https://${prefix}api.bentley.com/mesh-export/?iModelId=${args.sourceId}&$orderBy=date:desc`;\r\n  if (args.changeId)\r\n    url = `${url}&changesetId=${args.changeId}`;\r\n\r\n  if (args.enableCDN)\r\n    url = `${url}&cdn=1`;\r\n\r\n  const tileVersion = IModelApp.tileAdmin.maximumMajorTileFormatVersion.toString();\r\n  url = `${url}&tileVersion=${tileVersion}&iTwinJS=${ITWINJS_CORE_VERSION}&exportType=${args.sourceType}`;\r\n\r\n  return url;\r\n}\r\n\r\n/** Arguments supplied to [[queryGraphicRepresentations]].\r\n * @beta\r\n */\r\nexport interface QueryGraphicRepresentationsArgs {\r\n  /** The token used to access the data source provider. */\r\n  accessToken: AccessToken;\r\n  /** The unique identifier for the session in which this data source was queried.\r\n   * A possible value is IModelApp.sessionId.\r\n   */\r\n  sessionId: string;\r\n  /** The Data Source for which to query the graphic representations */\r\n  dataSource: DataSource;\r\n  /** The expected format of the graphic representations\r\n   * @see [[GraphicRepresentationFormat]] for possible values.\r\n   */\r\n  format:  GraphicRepresentationFormat;\r\n  /** Chiefly used in testing environments. */\r\n  urlPrefix?: string;\r\n  /** If true, exports whose status is not \"Complete\" (indicating the export successfully finished) will be included in the results */\r\n  includeIncomplete?: boolean;\r\n  /** If true, enables a CDN (content delivery network) to access tiles faster. */\r\n  enableCDN?: boolean;\r\n}\r\n\r\n/** Query Graphic Representations matching the specified criteria, sorted from most-recently- to least-recently-produced.\r\n * @beta\r\n */\r\nexport async function* queryGraphicRepresentations(args: QueryGraphicRepresentationsArgs): AsyncIterableIterator<GraphicRepresentation> {\r\n  interface ServiceJsonResponse {\r\n    id: string;\r\n    displayName: string;\r\n    status: GraphicRepresentationStatus;\r\n    request: {\r\n      iModelId: string;\r\n      changesetId: string;\r\n      exportType: string;\r\n      geometryOptions: any;\r\n      viewDefinitionFilter: any;\r\n    };\r\n\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    _links: {\r\n      mesh: {\r\n        href: string;\r\n      };\r\n    };\r\n  }\r\n\r\n  interface ServiceJsonResponses {\r\n    exports: ServiceJsonResponse[];\r\n\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    _links: {\r\n      next?: {\r\n        href: string;\r\n      };\r\n    };\r\n  }\r\n\r\n  const headers = {\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    Authorization: args.accessToken,\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    Accept: \"application/vnd.bentley.itwin-platform.v1+json\",\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    Prefer: \"return=representation\",\r\n    /* eslint-disable-next-line @typescript-eslint/naming-convention */\r\n    SessionId: args.sessionId,\r\n  };\r\n\r\n  let url: string | undefined = createGraphicRepresentationsQueryUrl({ sourceId: args.dataSource.id, sourceType: args.dataSource.type, urlPrefix: args.urlPrefix, changeId: args.dataSource.changeId, enableCDN: args.enableCDN });\r\n  while (url) {\r\n    let result;\r\n    try {\r\n      const response = await fetch(url, { headers });\r\n      result = await response.json() as ServiceJsonResponses;\r\n    } catch (err) {\r\n      Logger.logException(loggerCategory, err);\r\n      Logger.logError(loggerCategory, `Failed loading Graphics Data for Source ${args.dataSource.id}`);\r\n      break;\r\n    }\r\n\r\n    const foundSources = result.exports.filter((x) => x.request.exportType === args.dataSource.type && (args.includeIncomplete || x.status === GraphicRepresentationStatus.Complete));\r\n    for (const foundSource of foundSources) {\r\n      const graphicRepresentation = {\r\n        displayName: foundSource.displayName,\r\n        representationId: foundSource.id,\r\n        status: foundSource.status,\r\n        format: args.format,\r\n        url: foundSource._links.mesh.href,\r\n        dataSource: {\r\n          iTwinId: args.dataSource.iTwinId,\r\n          id: foundSource.request.iModelId,\r\n          versionId: foundSource.request.changesetId,\r\n          type: foundSource.request.exportType,\r\n        },\r\n      };\r\n\r\n      yield graphicRepresentation;\r\n    }\r\n\r\n    url = result._links.next?.href;\r\n  }\r\n}\r\n\r\n/** Arguments supplied  to [[obtainGraphicRepresentationUrl]].\r\n * @beta\r\n */\r\nexport interface ObtainGraphicRepresentationUrlArgs {\r\n  /** The token used to access the mesh export service. */\r\n  accessToken: AccessToken;\r\n  /** The unique identifier for the session in which this data source was queried.\r\n   * A possible value is IModelApp.sessionId.\r\n   */\r\n  sessionId: string;\r\n  /** The data source for which to query the graphic representations */\r\n  dataSource: DataSource;\r\n  /** The expected format of the graphic representations\r\n   * @see [[GraphicRepresentationFormat]] for possible values.\r\n   */\r\n  format:  GraphicRepresentationFormat;\r\n  /** Chiefly used in testing environments. */\r\n  urlPrefix?: string;\r\n  /** If true, only data produced for a specific data source version will be considered;\r\n   * otherwise, if no data sources are found with the specified version,the most recent data source version will be used.\r\n   */\r\n  requireExactVersion?: boolean;\r\n  /** If true, enables a CDN (content delivery network) to access tiles faster. */\r\n  enableCDN?: boolean;\r\n}\r\n\r\n/** Obtains a URL pointing to a Graphic Representation.\r\n * [[queryGraphicRepresentations]] is used to obtain a list of available representations. By default, the list is sorted from most to least recently-created.\r\n * The first representation matching the source version is selected; or, if no such representation exists, the first representation in the list is selected.\r\n * @returns A URL from which the tileset can be loaded, or `undefined` if no appropriate URL could be obtained.\r\n * @beta\r\n */\r\nexport async function obtainGraphicRepresentationUrl(args: ObtainGraphicRepresentationUrlArgs): Promise<URL | undefined> {\r\n  if (!args.dataSource.id) {\r\n    Logger.logInfo(loggerCategory, \"Cannot obtain Graphics Data from a source without an Id\");\r\n    return undefined;\r\n  }\r\n\r\n  const queryArgs: QueryGraphicRepresentationsArgs = {\r\n    accessToken: args.accessToken,\r\n    sessionId: args.sessionId,\r\n    dataSource: args.dataSource,\r\n    format: args.format,\r\n    urlPrefix: args.urlPrefix,\r\n    enableCDN: args.enableCDN,\r\n  };\r\n\r\n  let selectedData;\r\n  for await (const data of queryGraphicRepresentations(queryArgs)) {\r\n    selectedData = data;\r\n    break;\r\n  }\r\n\r\n  if (!selectedData && !args.requireExactVersion) {\r\n    queryArgs.dataSource.changeId = undefined;\r\n    for await (const data of queryGraphicRepresentations(queryArgs)) {\r\n      selectedData = data;\r\n      Logger.logInfo(loggerCategory, `No data for Data Source ${args.dataSource.id} for version ${args.dataSource.changeId}; falling back to most recent`);\r\n      break;\r\n    }\r\n  }\r\n\r\n  if ((!selectedData) || (!selectedData.url)) {\r\n    Logger.logInfo(loggerCategory, `No data available for Data Source ${args.dataSource.id}`);\r\n    return undefined;\r\n  }\r\n\r\n  const url = new URL(selectedData.url);\r\n  url.pathname = `${url.pathname}/tileset.json`;\r\n  return url;\r\n}\r\n"]}

package/lib/cjs/GraphicsProvider/GraphicsProvider.d.ts

@@ -0,0 +1,27 @@
+import { AccessToken } from "@itwin/core-bentley";
+import { IModelConnection } from "@itwin/core-frontend";
+/** Arguments supplied  to [[obtainMeshExportTilesetUrl]].
+ * @beta
+ */
+export interface ObtainIModelTilesetUrlArgs {
+    /** The iModel for which to obtain a tileset URl. */
+    iModel: IModelConnection;
+    /** The token used to access the mesh export service. */
+    accessToken: AccessToken;
+    /** Chiefly used in testing environments. */
+    urlPrefix?: string;
+    /** If true, only exports produced for `iModel`'s specific changeset will be considered; otherwise, if no exports are found for the changeset,
+     * the most recent export for any changeset will be used.
+     */
+    requireExactChangeset?: boolean;
+    /** If true, enables a CDN (content delivery network) to access tiles faster. */
+    enableCDN?: boolean;
+}
+/** Obtains a URL pointing to a tileset appropriate for visualizing a specific iModel.
+ * [[queryCompletedMeshExports]] is used to obtain a list of available exports. By default, the list is sorted from most to least recently-exported.
+ * The first export matching the iModel's changeset is selected; or, if no such export exists, the first export in the list is selected.
+ * @returns A URL from which the tileset can be loaded, or `undefined` if no appropriate URL could be obtained.
+ * @beta
+ */
+export declare function obtainIModelTilesetUrl(args: ObtainIModelTilesetUrlArgs): Promise<URL | undefined>;
+//# sourceMappingURL=GraphicsProvider.d.ts.map

package/lib/cjs/GraphicsProvider/GraphicsProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphicsProvider.d.ts","sourceRoot":"","sources":["../../../src/GraphicsProvider/GraphicsProvider.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAS,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAa,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAIlE;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,oDAAoD;IACpD,MAAM,EAAE,gBAAgB,CAAC;IACzB,wDAAwD;IACxD,WAAW,EAAE,WAAW,CAAC;IACzB,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,gFAAgF;IAChF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;GAKG;AACH,wBAAsB,sBAAsB,CAAC,IAAI,EAAE,0BAA0B,GAC7E,OAAO,CAAC,GAAG,GAAC,SAAS,CAAC,CA2BrB"}

package/lib/cjs/GraphicsProvider/GraphicsProvider.js

@@ -0,0 +1,44 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.obtainIModelTilesetUrl = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_frontend_1 = require("@itwin/core-frontend");
+const GraphicRepresentationProvider_1 = require("./GraphicRepresentationProvider");
+const LoggerCategory_1 = require("../LoggerCategory");
+/** Obtains a URL pointing to a tileset appropriate for visualizing a specific iModel.
+ * [[queryCompletedMeshExports]] is used to obtain a list of available exports. By default, the list is sorted from most to least recently-exported.
+ * The first export matching the iModel's changeset is selected; or, if no such export exists, the first export in the list is selected.
+ * @returns A URL from which the tileset can be loaded, or `undefined` if no appropriate URL could be obtained.
+ * @beta
+ */
+async function obtainIModelTilesetUrl(args) {
+    if (!args.iModel.iModelId) {
+        core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, "Cannot obtain Graphics Data for an iModel with no iModelId");
+        return undefined;
+    }
+    if (!args.iModel.iTwinId) {
+        core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, "Cannot obtain Graphics Data for an iModel with no iTwinId");
+        return undefined;
+    }
+    const graphicsArgs = {
+        accessToken: args.accessToken,
+        sessionId: core_frontend_1.IModelApp.sessionId,
+        dataSource: {
+            iTwinId: args.iModel.iTwinId,
+            id: args.iModel.iModelId,
+            changeId: args.iModel.changeset.id,
+            type: "IMODEL",
+        },
+        format: "IMDL",
+        urlPrefix: args.urlPrefix,
+        requireExactVersion: args.requireExactChangeset,
+        enableCDN: args.enableCDN,
+    };
+    return (0, GraphicRepresentationProvider_1.obtainGraphicRepresentationUrl)(graphicsArgs);
+}
+exports.obtainIModelTilesetUrl = obtainIModelTilesetUrl;
+//# sourceMappingURL=GraphicsProvider.js.map

package/lib/cjs/GraphicsProvider/GraphicsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphicsProvider.js","sourceRoot":"","sources":["../../../src/GraphicsProvider/GraphicsProvider.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,sDAAyD;AACzD,wDAAkE;AAClE,mFAAgF;AAChF,sDAAkD;AAoBlD;;;;;GAKG;AACI,KAAK,UAAU,sBAAsB,CAAC,IAAgC;IAE3E,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC1B,qBAAM,CAAC,OAAO,CAAC,+BAAc,EAAE,4DAA4D,CAAC,CAAC;QAC7F,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACzB,qBAAM,CAAC,OAAO,CAAC,+BAAc,EAAE,2DAA2D,CAAC,CAAC;QAC5F,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,YAAY,GAAG;QACnB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,SAAS,EAAE,yBAAS,CAAC,SAAS;QAC9B,UAAU,EAAE;YACV,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC5B,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YACxB,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;YAClC,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,mBAAmB,EAAE,IAAI,CAAC,qBAAqB;QAC/C,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC;IAEF,OAAO,IAAA,8DAA8B,EAAC,YAAY,CAAC,CAAC;AACtD,CAAC;AA5BD,wDA4BC","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\r\nimport { AccessToken, Logger} from \"@itwin/core-bentley\";\r\nimport { IModelApp, IModelConnection} from \"@itwin/core-frontend\";\r\nimport { obtainGraphicRepresentationUrl} from \"./GraphicRepresentationProvider\";\r\nimport { loggerCategory} from \"../LoggerCategory\";\r\n\r\n/** Arguments supplied  to [[obtainMeshExportTilesetUrl]].\r\n * @beta\r\n */\r\nexport interface ObtainIModelTilesetUrlArgs {\r\n  /** The iModel for which to obtain a tileset URl. */\r\n  iModel: IModelConnection;\r\n  /** The token used to access the mesh export service. */\r\n  accessToken: AccessToken;\r\n  /** Chiefly used in testing environments. */\r\n  urlPrefix?: string;\r\n  /** If true, only exports produced for `iModel`'s specific changeset will be considered; otherwise, if no exports are found for the changeset,\r\n   * the most recent export for any changeset will be used.\r\n   */\r\n  requireExactChangeset?: boolean;\r\n  /** If true, enables a CDN (content delivery network) to access tiles faster. */\r\n  enableCDN?: boolean;\r\n}\r\n\r\n/** Obtains a URL pointing to a tileset appropriate for visualizing a specific iModel.\r\n * [[queryCompletedMeshExports]] is used to obtain a list of available exports. By default, the list is sorted from most to least recently-exported.\r\n * The first export matching the iModel's changeset is selected; or, if no such export exists, the first export in the list is selected.\r\n * @returns A URL from which the tileset can be loaded, or `undefined` if no appropriate URL could be obtained.\r\n * @beta\r\n */\r\nexport async function obtainIModelTilesetUrl(args: ObtainIModelTilesetUrlArgs):\r\nPromise<URL|undefined> {\r\n  if (!args.iModel.iModelId) {\r\n    Logger.logInfo(loggerCategory, \"Cannot obtain Graphics Data for an iModel with no iModelId\");\r\n    return undefined;\r\n  }\r\n\r\n  if (!args.iModel.iTwinId) {\r\n    Logger.logInfo(loggerCategory, \"Cannot obtain Graphics Data for an iModel with no iTwinId\");\r\n    return undefined;\r\n  }\r\n\r\n  const graphicsArgs = {\r\n    accessToken: args.accessToken,\r\n    sessionId: IModelApp.sessionId,\r\n    dataSource: {\r\n      iTwinId: args.iModel.iTwinId,\r\n      id: args.iModel.iModelId,\r\n      changeId: args.iModel.changeset.id,\r\n      type: \"IMODEL\",\r\n    },\r\n    format: \"IMDL\",\r\n    urlPrefix: args.urlPrefix,\r\n    requireExactVersion: args.requireExactChangeset,\r\n    enableCDN: args.enableCDN,\r\n  };\r\n\r\n  return obtainGraphicRepresentationUrl(graphicsArgs);\r\n}\r\n"]}

package/lib/cjs/GraphicsProvider/tileset-creators/GeoscienceTileset.d.ts

@@ -0,0 +1,11 @@
+import { BaseGeoscienceArgs } from "../url-providers/GeoscienceUrlProvider";
+/**
+ * Represents the arguments required to initialize geoscience tileset.
+ * @alpha
+ */
+export type AttachGeoscienceTilesetArgs = BaseGeoscienceArgs;
+/** Initialize the geoscience tileset by attaching it as a Reality Model.
+ * @alpha
+ */
+export declare function attachGeoscienceTileset(args: AttachGeoscienceTilesetArgs): Promise<void>;
+//# sourceMappingURL=GeoscienceTileset.d.ts.map

package/lib/cjs/GraphicsProvider/tileset-creators/GeoscienceTileset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GeoscienceTileset.d.ts","sourceRoot":"","sources":["../../../../src/GraphicsProvider/tileset-creators/GeoscienceTileset.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,kBAAkB,EAA2B,MAAM,wCAAwC,CAAC;AAErG;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,kBAAkB,CAAC;AAE7D;;GAEG;AACH,wBAAsB,uBAAuB,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC,CAmB9F"}

package/lib/cjs/GraphicsProvider/tileset-creators/GeoscienceTileset.js

@@ -0,0 +1,37 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.attachGeoscienceTileset = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_frontend_1 = require("@itwin/core-frontend");
+const LoggerCategory_1 = require("../../LoggerCategory");
+const GeoscienceUrlProvider_1 = require("../url-providers/GeoscienceUrlProvider");
+/** Initialize the geoscience tileset by attaching it as a Reality Model.
+ * @alpha
+ */
+async function attachGeoscienceTileset(args) {
+    try {
+        const url = await (0, GeoscienceUrlProvider_1.getGeoscienceTilesetUrl)(args);
+        if (!url) {
+            core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, `No data available for Geoscience Object ${args.geoscienceObjectId}`);
+            return;
+        }
+        else {
+            const vp = core_frontend_1.IModelApp.viewManager.selectedView;
+            if (!vp) {
+                core_bentley_1.Logger.logInfo(LoggerCategory_1.loggerCategory, "Reality Model not successfully attached.");
+                return;
+            }
+            vp.displayStyle.attachRealityModel({ tilesetUrl: url });
+            return;
+        }
+    }
+    catch (error) {
+        throw error;
+    }
+}
+exports.attachGeoscienceTileset = attachGeoscienceTileset;
+//# sourceMappingURL=GeoscienceTileset.js.map