@snap/camera-kit 0.13.0 → 0.13.2

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 (138) hide show
  1. package/README.md +0 -22
  2. package/docs/html/assets/search.js +1 -1
  3. package/docs/html/classes/CameraKit.html +3 -3
  4. package/docs/html/classes/CameraKitSession.html +3 -3
  5. package/docs/html/classes/CameraKitSource.html +3 -3
  6. package/docs/html/classes/LensPerformanceMeasurement.html +3 -3
  7. package/docs/html/classes/LensPerformanceMetrics.html +3 -3
  8. package/docs/html/classes/LensRepository.html +3 -3
  9. package/docs/html/classes/LensSources.html +3 -3
  10. package/docs/html/classes/Transform2D.html +3 -3
  11. package/docs/html/classes/TypedCustomEvent.html +3 -3
  12. package/docs/html/classes/TypedEventTarget.html +3 -3
  13. package/docs/html/functions/Injectable.html +3 -3
  14. package/docs/html/functions/bootstrapCameraKit.html +3 -3
  15. package/docs/html/functions/createExtension.html +3 -3
  16. package/docs/html/functions/createImageSource.html +3 -3
  17. package/docs/html/functions/createMediaStreamSource.html +3 -3
  18. package/docs/html/functions/createUserMediaSource.html +3 -3
  19. package/docs/html/functions/createVideoSource.html +3 -3
  20. package/docs/html/functions/estimateLensPerformance.html +3 -3
  21. package/docs/html/functions/getRequiredBootstrapURLs.html +3 -3
  22. package/docs/html/functions/lensSourcesFactory.html +3 -3
  23. package/docs/html/functions/remoteApiServicesFactory.html +3 -3
  24. package/docs/html/index.html +5 -28
  25. package/docs/html/interfaces/CameraKitBootstrapConfiguration.html +3 -3
  26. package/docs/html/interfaces/CameraKitSourceSubscriber.html +3 -3
  27. package/docs/html/interfaces/ComputedFrameMetrics.html +3 -3
  28. package/docs/html/interfaces/CreateSessionOptions.html +3 -3
  29. package/docs/html/interfaces/EstimatedLensPerformance.html +3 -3
  30. package/docs/html/interfaces/Lens.html +12 -4
  31. package/docs/html/interfaces/LensSource.html +3 -3
  32. package/docs/html/interfaces/MediaStreamSourceOptions.html +3 -3
  33. package/docs/html/interfaces/Preview.html +3 -3
  34. package/docs/html/interfaces/RemoteApiRequest.html +3 -3
  35. package/docs/html/interfaces/RemoteApiResponse.html +3 -3
  36. package/docs/html/interfaces/RemoteApiService.html +3 -3
  37. package/docs/html/interfaces/Snapcode.html +3 -3
  38. package/docs/html/interfaces/UriCancelRequest.html +3 -3
  39. package/docs/html/interfaces/UriRequest.html +3 -3
  40. package/docs/html/interfaces/UriResponse.html +3 -3
  41. package/docs/html/interfaces/VideoSourceOptions.html +3 -3
  42. package/docs/html/modules.html +4 -4
  43. package/docs/html/types/AssetLoader.html +3 -3
  44. package/docs/html/types/AssetTiming.html +3 -3
  45. package/docs/html/types/BenchmarkError.html +3 -3
  46. package/docs/html/types/BootstrapError.html +3 -3
  47. package/docs/html/types/CacheKeyNotFoundError.html +3 -3
  48. package/docs/html/types/CameraKitDeviceInfo.html +3 -3
  49. package/docs/html/types/CameraKitDeviceOptions.html +3 -3
  50. package/docs/html/types/CameraKitSessionEventListener.html +3 -3
  51. package/docs/html/types/CameraKitSessionEvents.html +3 -3
  52. package/docs/html/types/CameraKitSourceError.html +3 -3
  53. package/docs/html/types/CameraKitSourceInfo.html +3 -3
  54. package/docs/html/types/CameraKitSourceOptions.html +3 -3
  55. package/docs/html/types/ConfigurationError.html +3 -3
  56. package/docs/html/types/Keyboard.html +3 -3
  57. package/docs/html/types/KeyboardEvents.html +3 -3
  58. package/docs/html/types/LegalError.html +3 -3
  59. package/docs/html/types/LensAssetError.html +3 -3
  60. package/docs/html/types/LensContentValidationError.html +3 -3
  61. package/docs/html/types/LensError.html +3 -3
  62. package/docs/html/types/LensExecutionError.html +3 -3
  63. package/docs/html/types/LensImagePickerError.html +3 -3
  64. package/docs/html/types/LensLaunchParams.html +3 -3
  65. package/docs/html/types/LensMetricsEvents.html +3 -3
  66. package/docs/html/types/LensPerformanceCluster.html +3 -3
  67. package/docs/html/types/LensView.html +3 -3
  68. package/docs/html/types/LensWait.html +3 -3
  69. package/docs/html/types/PersistentStoreError.html +3 -3
  70. package/docs/html/types/PlatformNotSupportedError.html +3 -3
  71. package/docs/html/types/PublicContainer.html +3 -3
  72. package/docs/html/types/RemoteApiRequestHandler.html +3 -3
  73. package/docs/html/types/RemoteApiServices.html +3 -3
  74. package/docs/html/types/RemoteApiStatus.html +3 -3
  75. package/docs/html/types/RenderTarget.html +3 -3
  76. package/docs/html/types/Uri.html +3 -3
  77. package/docs/html/types/WebGLError.html +3 -3
  78. package/docs/html/variables/extensionRequestContext.html +3 -3
  79. package/docs/md/README.md +0 -22
  80. package/docs/md/classes/CameraKit.md +1 -1
  81. package/docs/md/classes/CameraKitSession.md +1 -1
  82. package/docs/md/classes/CameraKitSource.md +1 -1
  83. package/docs/md/classes/LensPerformanceMeasurement.md +1 -1
  84. package/docs/md/classes/LensPerformanceMetrics.md +1 -1
  85. package/docs/md/classes/LensRepository.md +1 -1
  86. package/docs/md/classes/LensSources.md +1 -1
  87. package/docs/md/classes/Transform2D.md +1 -1
  88. package/docs/md/classes/TypedCustomEvent.md +1 -1
  89. package/docs/md/classes/TypedEventTarget.md +1 -1
  90. package/docs/md/interfaces/CameraKitBootstrapConfiguration.md +1 -1
  91. package/docs/md/interfaces/CameraKitSourceSubscriber.md +1 -1
  92. package/docs/md/interfaces/ComputedFrameMetrics.md +1 -1
  93. package/docs/md/interfaces/CreateSessionOptions.md +1 -1
  94. package/docs/md/interfaces/EstimatedLensPerformance.md +1 -1
  95. package/docs/md/interfaces/Lens.md +10 -1
  96. package/docs/md/interfaces/LensSource.md +1 -1
  97. package/docs/md/interfaces/MediaStreamSourceOptions.md +1 -1
  98. package/docs/md/interfaces/Preview.md +1 -1
  99. package/docs/md/interfaces/RemoteApiRequest.md +1 -1
  100. package/docs/md/interfaces/RemoteApiResponse.md +1 -1
  101. package/docs/md/interfaces/RemoteApiService.md +1 -1
  102. package/docs/md/interfaces/Snapcode.md +1 -1
  103. package/docs/md/interfaces/UriCancelRequest.md +1 -1
  104. package/docs/md/interfaces/UriRequest.md +1 -1
  105. package/docs/md/interfaces/UriResponse.md +1 -1
  106. package/docs/md/interfaces/VideoSourceOptions.md +1 -1
  107. package/docs/md/modules.md +2 -2
  108. package/lib/common/any.d.ts +2 -0
  109. package/lib/common/any.js +23 -6
  110. package/lib/common/any.js.map +1 -1
  111. package/lib/environment.json +1 -1
  112. package/lib/generated-proto/pb_schema/camera_kit/v3/export.d.ts +2 -1
  113. package/lib/generated-proto/pb_schema/camera_kit/v3/export.js +6 -0
  114. package/lib/generated-proto/pb_schema/camera_kit/v3/export.js.map +1 -1
  115. package/lib/generated-proto/pb_schema/camera_kit/v3/features/ranking_info.d.ts +34 -0
  116. package/lib/generated-proto/pb_schema/camera_kit/v3/features/ranking_info.js +43 -0
  117. package/lib/generated-proto/pb_schema/camera_kit/v3/features/ranking_info.js.map +1 -0
  118. package/lib/generated-proto/pb_schema/camera_kit/v3/features/remote_api_info.d.ts +0 -2
  119. package/lib/generated-proto/pb_schema/camera_kit/v3/features/remote_api_info.js +0 -1
  120. package/lib/generated-proto/pb_schema/camera_kit/v3/features/remote_api_info.js.map +1 -1
  121. package/lib/generated-proto/pb_schema/cdp/cof/circumstance_service.d.ts +14346 -3145
  122. package/lib/generated-proto/pb_schema/cdp/cof/config_response.d.ts +1717 -62
  123. package/lib/generated-proto/pb_schema/cdp/cof/config_result.d.ts +6267 -373
  124. package/lib/generated-proto/pb_schema/cdp/cof/config_result.js +159 -4
  125. package/lib/generated-proto/pb_schema/cdp/cof/config_result.js.map +1 -1
  126. package/lib/generated-proto/pb_schema/common/ruid.d.ts +1 -0
  127. package/lib/generated-proto/pb_schema/common/ruid.js +1 -0
  128. package/lib/generated-proto/pb_schema/common/ruid.js.map +1 -1
  129. package/lib/generated-proto/pb_schema/lenses/launchdata.d.ts +31 -0
  130. package/lib/generated-proto/pb_schema/lenses/launchdata.js +143 -1
  131. package/lib/generated-proto/pb_schema/lenses/launchdata.js.map +1 -1
  132. package/lib/index.d.ts +1 -0
  133. package/lib/index.js +1 -0
  134. package/lib/index.js.map +1 -1
  135. package/lib/lens/Lens.d.ts +8 -1
  136. package/lib/lens/Lens.js +11 -3
  137. package/lib/lens/Lens.js.map +1 -1
  138. package/package.json +1 -1
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RenderTarget | CameraKit Web SDK - v0.13.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RenderTarget | CameraKit Web SDK - v0.13.2-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -6,7 +6,7 @@
6
6
  <div id="tsd-toolbar-links"></div></div>
7
7
  <ul class="results">
8
8
  <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v0.13.0-alpha.1</a></div>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v0.13.2-alpha.1</a></div>
10
10
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
11
  <div class="container container-main">
12
12
  <div class="col-content">
@@ -35,7 +35,7 @@ which render target to render, and the result for each target is available as a
35
35
  <div class="tsd-theme-toggle">
36
36
  <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
37
37
  <div class="site-menu">
38
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.0-<wbr/>alpha.1</span></a>
38
+ <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.2-<wbr/>alpha.1</span></a>
39
39
  <ul class="tsd-small-nested-navigation">
40
40
  <li><a href="../classes/CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit</span></a></li>
41
41
  <li><a href="../classes/TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Custom<wbr/>Event</span></a></li>
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Uri | CameraKit Web SDK - v0.13.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Uri | CameraKit Web SDK - v0.13.2-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -6,7 +6,7 @@
6
6
  <div id="tsd-toolbar-links"></div></div>
7
7
  <ul class="results">
8
8
  <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v0.13.0-alpha.1</a></div>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v0.13.2-alpha.1</a></div>
10
10
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
11
  <div class="container container-main">
12
12
  <div class="col-content">
@@ -30,7 +30,7 @@
30
30
  <div class="tsd-theme-toggle">
31
31
  <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
32
32
  <div class="site-menu">
33
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.0-<wbr/>alpha.1</span></a>
33
+ <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.2-<wbr/>alpha.1</span></a>
34
34
  <ul class="tsd-small-nested-navigation">
35
35
  <li><a href="../classes/CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit</span></a></li>
36
36
  <li><a href="../classes/TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Custom<wbr/>Event</span></a></li>
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebGLError | CameraKit Web SDK - v0.13.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebGLError | CameraKit Web SDK - v0.13.2-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -6,7 +6,7 @@
6
6
  <div id="tsd-toolbar-links"></div></div>
7
7
  <ul class="results">
8
8
  <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v0.13.0-alpha.1</a></div>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v0.13.2-alpha.1</a></div>
10
10
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
11
  <div class="container container-main">
12
12
  <div class="col-content">
@@ -30,7 +30,7 @@
30
30
  <div class="tsd-theme-toggle">
31
31
  <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
32
32
  <div class="site-menu">
33
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.0-<wbr/>alpha.1</span></a>
33
+ <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.2-<wbr/>alpha.1</span></a>
34
34
  <ul class="tsd-small-nested-navigation">
35
35
  <li><a href="../classes/CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit</span></a></li>
36
36
  <li><a href="../classes/TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Custom<wbr/>Event</span></a></li>
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>extensionRequestContext | CameraKit Web SDK - v0.13.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>extensionRequestContext | CameraKit Web SDK - v0.13.2-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -6,7 +6,7 @@
6
6
  <div id="tsd-toolbar-links"></div></div>
7
7
  <ul class="results">
8
8
  <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v0.13.0-alpha.1</a></div>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v0.13.2-alpha.1</a></div>
10
10
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
11
  <div class="container container-main">
12
12
  <div class="col-content">
@@ -33,7 +33,7 @@
33
33
  <div class="tsd-theme-toggle">
34
34
  <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
35
35
  <div class="site-menu">
36
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.0-<wbr/>alpha.1</span></a>
36
+ <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.2-<wbr/>alpha.1</span></a>
37
37
  <ul class="tsd-small-nested-navigation">
38
38
  <li><a href="../classes/CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit</span></a></li>
39
39
  <li><a href="../classes/TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Custom<wbr/>Event</span></a></li>
package/docs/md/README.md CHANGED
@@ -344,25 +344,3 @@ cameraKit.metrics.addEventListener('lensView', (event) => {
344
344
  console.debug(event.detail);
345
345
  });
346
346
  ```
347
- <<<<<<< HEAD
348
-
349
- ### Error Handling
350
-
351
- Camera Kit Web SDK methods may throw errors, or return rejected Promises -- these are documented in the [API docs](https://kit.snapchat.com/reference/CameraKit/web/0.11.0/index.html). It is good practice to handle such cases, to provide a good experience to your users.
352
-
353
- Errors may also occur during Lens rendering. For example, if the Lens that has been applied contains a bug -- Lenses have their own internal scripts, which can fail. A rendering error could also occur if a Lens depends on a feature that is not supported by Camera Kit Web SDK.
354
-
355
- When a `LensExecutionError` such as these occurs, the Lens is **automatically removed** from the `CameraKitSession`. An error event is emitted so that your application can respond appropriately. You can listen to these error events like so:
356
-
357
- ```ts
358
- session.events.addEventListener('error', (event) => {
359
- console.error(event.detail.error);
360
-
361
- if (event.detail.error.name === 'LensExecutionError') {
362
- // The currently-applied Lens encountered a problem that is most likely unrecoverable and the Lens has been removed.
363
- // Your application may want to do something to prevent this Lens from being applied again.
364
- }
365
- });
366
- ```
367
- =======
368
- >>>>>>> 76e624ce ([CAMKIT-4384] README: error handling gets greater emphasis)
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / CameraKit
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / CameraKit
2
2
 
3
3
  # Class: CameraKit
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitSession
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitSession
2
2
 
3
3
  # Class: CameraKitSession
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitSource
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitSource
2
2
 
3
3
  # Class: CameraKitSource
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / LensPerformanceMeasurement
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / LensPerformanceMeasurement
2
2
 
3
3
  # Class: LensPerformanceMeasurement
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / LensPerformanceMetrics
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / LensPerformanceMetrics
2
2
 
3
3
  # Class: LensPerformanceMetrics
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / LensRepository
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / LensRepository
2
2
 
3
3
  # Class: LensRepository
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / LensSources
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / LensSources
2
2
 
3
3
  # Class: LensSources
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / Transform2D
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / Transform2D
2
2
 
3
3
  # Class: Transform2D
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / TypedCustomEvent
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / TypedCustomEvent
2
2
 
3
3
  # Class: TypedCustomEvent<N, T\>
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / TypedEventTarget
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / TypedEventTarget
2
2
 
3
3
  # Class: TypedEventTarget<Events\>
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitBootstrapConfiguration
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitBootstrapConfiguration
2
2
 
3
3
  # Interface: CameraKitBootstrapConfiguration
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitSourceSubscriber
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitSourceSubscriber
2
2
 
3
3
  # Interface: CameraKitSourceSubscriber
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / ComputedFrameMetrics
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / ComputedFrameMetrics
2
2
 
3
3
  # Interface: ComputedFrameMetrics
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / CreateSessionOptions
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / CreateSessionOptions
2
2
 
3
3
  # Interface: CreateSessionOptions
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / EstimatedLensPerformance
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / EstimatedLensPerformance
2
2
 
3
3
  # Interface: EstimatedLensPerformance
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / Lens
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / Lens
2
2
 
3
3
  # Interface: Lens
4
4
 
@@ -14,6 +14,7 @@
14
14
  - [preview](Lens.md#preview)
15
15
  - [lensCreator](Lens.md#lenscreator)
16
16
  - [snapcode](Lens.md#snapcode)
17
+ - [featureMetadata](Lens.md#featuremetadata)
17
18
 
18
19
  ## Properties
19
20
 
@@ -93,3 +94,11 @@ ___
93
94
  A [snapcode](https://scan.snapchat.com/snapcodes) that represents the lens if available.
94
95
 
95
96
  The snapcode points to the lens in the Snapchat app, when used on mobile, or a dedicated web page.
97
+
98
+ ___
99
+
100
+ ### featureMetadata
101
+
102
+ • **featureMetadata**: `Any`[]
103
+
104
+ Metadata pertaining to a specific set of lens features
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / LensSource
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / LensSource
2
2
 
3
3
  # Interface: LensSource
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / MediaStreamSourceOptions
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / MediaStreamSourceOptions
2
2
 
3
3
  # Interface: MediaStreamSourceOptions
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / Preview
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / Preview
2
2
 
3
3
  # Interface: Preview
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / RemoteApiRequest
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / RemoteApiRequest
2
2
 
3
3
  # Interface: RemoteApiRequest
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / RemoteApiResponse
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / RemoteApiResponse
2
2
 
3
3
  # Interface: RemoteApiResponse
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / RemoteApiService
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / RemoteApiService
2
2
 
3
3
  # Interface: RemoteApiService
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / Snapcode
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / Snapcode
2
2
 
3
3
  # Interface: Snapcode
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / UriCancelRequest
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / UriCancelRequest
2
2
 
3
3
  # Interface: UriCancelRequest
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / UriRequest
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / UriRequest
2
2
 
3
3
  # Interface: UriRequest
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / UriResponse
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / UriResponse
2
2
 
3
3
  # Interface: UriResponse
4
4
 
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / VideoSourceOptions
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](../README.md) / [Exports](../modules.md) / VideoSourceOptions
2
2
 
3
3
  # Interface: VideoSourceOptions
4
4
 
@@ -1,6 +1,6 @@
1
- [CameraKit Web SDK - v0.13.0-alpha.1](README.md) / Exports
1
+ [CameraKit Web SDK - v0.13.2-alpha.1](README.md) / Exports
2
2
 
3
- # CameraKit Web SDK - v0.13.0-alpha.1
3
+ # CameraKit Web SDK - v0.13.2-alpha.1
4
4
 
5
5
  ## Table of contents
6
6
 
@@ -1,6 +1,8 @@
1
1
  import { Any } from "../generated-proto/pb_schema/google/protobuf/any";
2
2
  export declare const knownAnyTypes: {
3
+ rankingInfo: string;
3
4
  remoteApiInfo: string;
5
+ string: string;
4
6
  };
5
7
  /**
6
8
  * JSON-serialized any message according to spec: https://protobuf.dev/reference/protobuf/google.protobuf/#json
package/lib/common/any.js CHANGED
@@ -1,4 +1,6 @@
1
+ import { RankingInfo } from "../generated-proto/pb_schema/camera_kit/v3/features/ranking_info";
1
2
  import { RemoteApiInfo } from "../generated-proto/pb_schema/camera_kit/v3/features/remote_api_info";
3
+ import { StringValue } from "../generated-proto/pb_schema/google/protobuf/wrappers";
2
4
  // There is a discrepancy in how the CameraKit backend and ts-proto serialize a protobuf message into JSON.
3
5
  // The backend serialization follows the spec outlined here:
4
6
  // https://protobuf.dev/reference/protobuf/google.protobuf/#json
@@ -15,7 +17,9 @@ import { RemoteApiInfo } from "../generated-proto/pb_schema/camera_kit/v3/featur
15
17
  // Ideally, to fix this issue, we want to switch to gRPC web for our backend communication,
16
18
  // similar to how we do it for COF. Ticket: https://jira.sc-corp.net/browse/CAMKIT-4668
17
19
  export const knownAnyTypes = {
20
+ rankingInfo: "type.googleapis.com/com.snap.camerakit.v3.features.RankingInfo",
18
21
  remoteApiInfo: "type.googleapis.com/com.snap.camerakit.v3.features.RemoteApiInfo",
22
+ string: "type.googleapis.com/google.protobuf.StringValue",
19
23
  };
20
24
  /**
21
25
  * Gets JSON-serialized any message and maps it to JS representation of Any type.
@@ -25,12 +29,25 @@ export const knownAnyTypes = {
25
29
  */
26
30
  export function encodeKnownAnyJson(jsonAny) {
27
31
  const typeUrl = jsonAny["@type"];
28
- if (typeUrl === knownAnyTypes.remoteApiInfo) {
29
- return {
30
- typeUrl,
31
- // Safety: we know that spec ensures all message fields to exists
32
- value: RemoteApiInfo.encode(jsonAny).finish(),
33
- };
32
+ switch (typeUrl) {
33
+ case knownAnyTypes.remoteApiInfo:
34
+ return {
35
+ typeUrl,
36
+ // Safety: we know that spec ensures all message fields to exists
37
+ value: RemoteApiInfo.encode(jsonAny).finish(),
38
+ };
39
+ case knownAnyTypes.rankingInfo:
40
+ return {
41
+ typeUrl,
42
+ value: RankingInfo.encode(jsonAny).finish(),
43
+ };
44
+ case knownAnyTypes.string:
45
+ return {
46
+ typeUrl,
47
+ value: StringValue.encode(jsonAny).finish(),
48
+ };
49
+ default:
50
+ break;
34
51
  }
35
52
  }
36
53
  //# sourceMappingURL=any.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"any.js","sourceRoot":"","sources":["../../src/common/any.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAC;AAGpG,2GAA2G;AAC3G,4DAA4D;AAC5D,gEAAgE;AAChE,6EAA6E;AAC7E,gDAAgD;AAChD,sFAAsF;AACtF,6EAA6E;AAC7E,sFAAsF;AACtF,6EAA6E;AAC7E,6DAA6D;AAC7D,0DAA0D;AAC1D,wEAAwE;AACxE,wGAAwG;AACxG,2FAA2F;AAC3F,uFAAuF;AAEvF,MAAM,CAAC,MAAM,aAAa,GAAG;IACzB,aAAa,EAAE,kEAAkE;CACpF,CAAC;AASF;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAgB;IAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjC,IAAI,OAAO,KAAK,aAAa,CAAC,aAAa,EAAE;QACzC,OAAO;YACH,OAAO;YACP,iEAAiE;YACjE,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,OAAmC,CAAC,CAAC,MAAM,EAAE;SAC5E,CAAC;KACL;AACL,CAAC","sourcesContent":["import { RemoteApiInfo } from \"../generated-proto/pb_schema/camera_kit/v3/features/remote_api_info\";\nimport { Any } from \"../generated-proto/pb_schema/google/protobuf/any\";\n\n// There is a discrepancy in how the CameraKit backend and ts-proto serialize a protobuf message into JSON.\n// The backend serialization follows the spec outlined here:\n// https://protobuf.dev/reference/protobuf/google.protobuf/#json\n// According to this specification, the actual message is represented as JSON\n// with an additional @type discriminator field.\n// However, this approach is not consistent with what the client-side expects for Any.\n// It requires it to be in the format { typeUrl: string, value: UInt8Array }.\n// Therefore, we need to map the JSON representation of Any to the actual Any message.\n// This issue only applies to JSON-serialized protos returned by our backend.\n// The JSON serialization of the ts-proto package that we use\n// does not appear to be following the spec regarding Any.\n// Even if it does, the deserialization part has to be handled manually.\n// This issue does not apply to cases where the Lens object is deserialized from a binary proto message.\n// Ideally, to fix this issue, we want to switch to gRPC web for our backend communication,\n// similar to how we do it for COF. Ticket: https://jira.sc-corp.net/browse/CAMKIT-4668\n\nexport const knownAnyTypes = {\n remoteApiInfo: \"type.googleapis.com/com.snap.camerakit.v3.features.RemoteApiInfo\",\n};\n\n/**\n * JSON-serialized any message according to spec: https://protobuf.dev/reference/protobuf/google.protobuf/#json\n */\nexport interface AnyJson extends Record<string, unknown> {\n \"@type\": string;\n}\n\n/**\n * Gets JSON-serialized any message and maps it to JS representation of Any type.\n * @param jsonAny JSON-serialized any message according to spec:\n * https://protobuf.dev/reference/protobuf/google.protobuf/#json\n * @returns JS representation of Any proto message.\n */\nexport function encodeKnownAnyJson(jsonAny: AnyJson): Any | void {\n const typeUrl = jsonAny[\"@type\"];\n if (typeUrl === knownAnyTypes.remoteApiInfo) {\n return {\n typeUrl,\n // Safety: we know that spec ensures all message fields to exists\n value: RemoteApiInfo.encode(jsonAny as unknown as RemoteApiInfo).finish(),\n };\n }\n}\n"]}
1
+ {"version":3,"file":"any.js","sourceRoot":"","sources":["../../src/common/any.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kEAAkE,CAAC;AAC/F,OAAO,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAC;AAEpG,OAAO,EAAE,WAAW,EAAE,MAAM,uDAAuD,CAAC;AAEpF,2GAA2G;AAC3G,4DAA4D;AAC5D,gEAAgE;AAChE,6EAA6E;AAC7E,gDAAgD;AAChD,sFAAsF;AACtF,6EAA6E;AAC7E,sFAAsF;AACtF,6EAA6E;AAC7E,6DAA6D;AAC7D,0DAA0D;AAC1D,wEAAwE;AACxE,wGAAwG;AACxG,2FAA2F;AAC3F,uFAAuF;AAEvF,MAAM,CAAC,MAAM,aAAa,GAAG;IACzB,WAAW,EAAE,gEAAgE;IAC7E,aAAa,EAAE,kEAAkE;IACjF,MAAM,EAAE,iDAAiD;CAC5D,CAAC;AASF;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAgB;IAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjC,QAAQ,OAAO,EAAE;QACb,KAAK,aAAa,CAAC,aAAa;YAC5B,OAAO;gBACH,OAAO;gBACP,iEAAiE;gBACjE,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,OAAmC,CAAC,CAAC,MAAM,EAAE;aAC5E,CAAC;QACN,KAAK,aAAa,CAAC,WAAW;YAC1B,OAAO;gBACH,OAAO;gBACP,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,OAAiC,CAAC,CAAC,MAAM,EAAE;aACxE,CAAC;QACN,KAAK,aAAa,CAAC,MAAM;YACrB,OAAO;gBACH,OAAO;gBACP,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,OAAiC,CAAC,CAAC,MAAM,EAAE;aACxE,CAAC;QACN;YACI,MAAM;KACb;AACL,CAAC","sourcesContent":["import { RankingInfo } from \"../generated-proto/pb_schema/camera_kit/v3/features/ranking_info\";\nimport { RemoteApiInfo } from \"../generated-proto/pb_schema/camera_kit/v3/features/remote_api_info\";\nimport { Any } from \"../generated-proto/pb_schema/google/protobuf/any\";\nimport { StringValue } from \"../generated-proto/pb_schema/google/protobuf/wrappers\";\n\n// There is a discrepancy in how the CameraKit backend and ts-proto serialize a protobuf message into JSON.\n// The backend serialization follows the spec outlined here:\n// https://protobuf.dev/reference/protobuf/google.protobuf/#json\n// According to this specification, the actual message is represented as JSON\n// with an additional @type discriminator field.\n// However, this approach is not consistent with what the client-side expects for Any.\n// It requires it to be in the format { typeUrl: string, value: UInt8Array }.\n// Therefore, we need to map the JSON representation of Any to the actual Any message.\n// This issue only applies to JSON-serialized protos returned by our backend.\n// The JSON serialization of the ts-proto package that we use\n// does not appear to be following the spec regarding Any.\n// Even if it does, the deserialization part has to be handled manually.\n// This issue does not apply to cases where the Lens object is deserialized from a binary proto message.\n// Ideally, to fix this issue, we want to switch to gRPC web for our backend communication,\n// similar to how we do it for COF. Ticket: https://jira.sc-corp.net/browse/CAMKIT-4668\n\nexport const knownAnyTypes = {\n rankingInfo: \"type.googleapis.com/com.snap.camerakit.v3.features.RankingInfo\",\n remoteApiInfo: \"type.googleapis.com/com.snap.camerakit.v3.features.RemoteApiInfo\",\n string: \"type.googleapis.com/google.protobuf.StringValue\",\n};\n\n/**\n * JSON-serialized any message according to spec: https://protobuf.dev/reference/protobuf/google.protobuf/#json\n */\nexport interface AnyJson extends Record<string, unknown> {\n \"@type\": string;\n}\n\n/**\n * Gets JSON-serialized any message and maps it to JS representation of Any type.\n * @param jsonAny JSON-serialized any message according to spec:\n * https://protobuf.dev/reference/protobuf/google.protobuf/#json\n * @returns JS representation of Any proto message.\n */\nexport function encodeKnownAnyJson(jsonAny: AnyJson): Any | void {\n const typeUrl = jsonAny[\"@type\"];\n switch (typeUrl) {\n case knownAnyTypes.remoteApiInfo:\n return {\n typeUrl,\n // Safety: we know that spec ensures all message fields to exists\n value: RemoteApiInfo.encode(jsonAny as unknown as RemoteApiInfo).finish(),\n };\n case knownAnyTypes.rankingInfo:\n return {\n typeUrl,\n value: RankingInfo.encode(jsonAny as unknown as RankingInfo).finish(),\n };\n case knownAnyTypes.string:\n return {\n typeUrl,\n value: StringValue.encode(jsonAny as unknown as StringValue).finish(),\n };\n default:\n break;\n }\n}\n"]}
@@ -1 +1 @@
1
- { "PACKAGE_VERSION": "0.13.0-alpha.1" }
1
+ { "PACKAGE_VERSION": "0.13.2-alpha.1" }
@@ -19,6 +19,7 @@ export interface ExportLensesByIdRequest_Context_Extension {
19
19
  export declare enum ExportLensesByIdRequest_Context_Extension_Name {
20
20
  UNSET = "UNSET",
21
21
  SHOP_KIT = "SHOP_KIT",
22
+ LENS_WEB_BUILDER = "LENS_WEB_BUILDER",
22
23
  UNRECOGNIZED = "UNRECOGNIZED"
23
24
  }
24
25
  export declare function exportLensesByIdRequest_Context_Extension_NameFromJSON(object: any): ExportLensesByIdRequest_Context_Extension_Name;
@@ -440,7 +441,7 @@ export declare const Envelope: {
440
441
  } & {
441
442
  typeUrl?: string | undefined;
442
443
  value?: Uint8Array | undefined;
443
- } & Record<Exclude<keyof I["lenses"][number]["featureMetadata"][number], keyof import("../../google/protobuf/any").Any>, never>)[] & Record<Exclude<keyof I["lenses"][number]["featureMetadata"], keyof {
444
+ } & Record<Exclude<keyof I["lenses"][number]["featureMetadata"][number], keyof import("../../../..").Any>, never>)[] & Record<Exclude<keyof I["lenses"][number]["featureMetadata"], keyof {
444
445
  typeUrl?: string | undefined;
445
446
  value?: Uint8Array | undefined;
446
447
  }[]>, never>) | undefined;
@@ -6,6 +6,7 @@ export var ExportLensesByIdRequest_Context_Extension_Name;
6
6
  (function (ExportLensesByIdRequest_Context_Extension_Name) {
7
7
  ExportLensesByIdRequest_Context_Extension_Name["UNSET"] = "UNSET";
8
8
  ExportLensesByIdRequest_Context_Extension_Name["SHOP_KIT"] = "SHOP_KIT";
9
+ ExportLensesByIdRequest_Context_Extension_Name["LENS_WEB_BUILDER"] = "LENS_WEB_BUILDER";
9
10
  ExportLensesByIdRequest_Context_Extension_Name["UNRECOGNIZED"] = "UNRECOGNIZED";
10
11
  })(ExportLensesByIdRequest_Context_Extension_Name || (ExportLensesByIdRequest_Context_Extension_Name = {}));
11
12
  export function exportLensesByIdRequest_Context_Extension_NameFromJSON(object) {
@@ -16,6 +17,9 @@ export function exportLensesByIdRequest_Context_Extension_NameFromJSON(object) {
16
17
  case 1:
17
18
  case "SHOP_KIT":
18
19
  return ExportLensesByIdRequest_Context_Extension_Name.SHOP_KIT;
20
+ case 2:
21
+ case "LENS_WEB_BUILDER":
22
+ return ExportLensesByIdRequest_Context_Extension_Name.LENS_WEB_BUILDER;
19
23
  case -1:
20
24
  case "UNRECOGNIZED":
21
25
  default:
@@ -28,6 +32,8 @@ export function exportLensesByIdRequest_Context_Extension_NameToNumber(object) {
28
32
  return 0;
29
33
  case ExportLensesByIdRequest_Context_Extension_Name.SHOP_KIT:
30
34
  return 1;
35
+ case ExportLensesByIdRequest_Context_Extension_Name.LENS_WEB_BUILDER:
36
+ return 2;
31
37
  default:
32
38
  return 0;
33
39
  }