@cognite/reveal 4.0.0-dev.20221129 → 4.0.0-dev.20221201

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +6 -0
  2. package/dist/api-entry-points/core.d.ts +1 -1
  3. package/dist/index.js +6 -6
  4. package/dist/index.js.map +1 -1
  5. package/dist/packages/360-images/index.d.ts +1 -0
  6. package/dist/packages/360-images/src/Image360.d.ts +17 -0
  7. package/dist/packages/360-images/src/Image360Entity.d.ts +4 -3
  8. package/dist/packages/360-images/src/Image360Visualization.d.ts +3 -13
  9. package/dist/packages/api/src/api-helpers/Image360ApiHelper.d.ts +2 -1
  10. package/dist/packages/api/src/public/migration/Cognite3DViewer.d.ts +4 -4
  11. package/dist/packages/metrics/src/MetricsLogger.d.ts +1 -0
  12. package/package.json +9 -7
package/README.md CHANGED
@@ -153,6 +153,12 @@ Add the following script to your package's `package.json`:
153
153
  Running the command `yarn start` will host a localhost site with a template HTML that includes the `/app/index.ts` script that has been transpiled to javascript.
154
154
  To see an example of this check out the `packages/camera-manager` package.
155
155
 
156
+ ## API Extractor
157
+
158
+ The `viewer/reveal.api.md` file contains a description of the public API of Reveal. In the CI pipeline, the `reveal.api.md` file is checked to be up-to-date by API extractor.
159
+
160
+ In order to update this file locally, run `yarn run update-api` *after* having run the build script. This will update the API file with any changes, which should be added and commited in the same PR.
161
+
156
162
  ## Debugging
157
163
 
158
164
  ### Worker source maps
package/dist/api-entry-points/core.d.ts CHANGED
@@ -13,4 +13,4 @@ export { PointCloudObjectMetadata } from '../packages/data-providers';
13
13
  export { CogniteCadModel, BoundingBoxClipper, GeometryFilter, WellKnownUnit } from '../packages/cad-model';
14
14
  export { CognitePointCloudModel } from '../packages/pointclouds';
15
15
  export { CompletePointCloudAppearance, PointCloudAppearance, PointCloudObjectCollection, AnnotationIdPointCloudObjectCollection, DefaultPointCloudAppearance, StyledPointCloudObjectCollection } from '../packages/pointcloud-styling';
16
- export { Image360Entity, Image360Visualization } from '../packages/360-images';
16
+ export { Image360, Image360Visualization } from '../packages/360-images';