snack-sdk 3.8.0 → 3.9.0

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 (57) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/build/DependencyResolver.d.ts +26 -26
  3. package/build/DependencyResolver.js +258 -258
  4. package/build/DevSession.d.ts +20 -20
  5. package/build/DevSession.js +203 -203
  6. package/build/FileUploader.d.ts +23 -23
  7. package/build/FileUploader.js +174 -174
  8. package/build/Logger.d.ts +11 -11
  9. package/build/Logger.js +33 -33
  10. package/build/Session.d.ts +301 -301
  11. package/build/Session.js +1172 -1171
  12. package/build/Session.js.map +1 -1
  13. package/build/State.d.ts +16 -16
  14. package/build/State.js +90 -90
  15. package/build/WantedVersions.d.ts +40 -17
  16. package/build/WantedVersions.js +156 -93
  17. package/build/WantedVersions.js.map +1 -1
  18. package/build/defaultConfig.d.ts +12 -12
  19. package/build/defaultConfig.js +29 -29
  20. package/build/index.d.ts +7 -7
  21. package/build/index.js +30 -30
  22. package/build/transports/CodeMessageBuilder.d.ts +31 -31
  23. package/build/transports/CodeMessageBuilder.js +196 -196
  24. package/build/transports/Protocol.d.ts +64 -64
  25. package/build/transports/Protocol.js +2 -2
  26. package/build/transports/Transport.d.ts +28 -27
  27. package/build/transports/Transport.js +303 -298
  28. package/build/transports/Transport.js.map +1 -1
  29. package/build/transports/index.d.ts +3 -3
  30. package/build/transports/index.js +22 -22
  31. package/build/transports/types.d.ts +63 -63
  32. package/build/transports/types.js +2 -2
  33. package/build/transports/webPlayer.d.ts +12 -12
  34. package/build/transports/webPlayer.js +70 -70
  35. package/build/types.d.ts +185 -185
  36. package/build/types.js +2 -2
  37. package/build/utils.d.ts +17 -17
  38. package/build/utils.js +68 -68
  39. package/package.json +11 -4
  40. package/src/DependencyResolver.ts +0 -218
  41. package/src/DevSession.ts +0 -159
  42. package/src/FileUploader.ts +0 -135
  43. package/src/Logger.ts +0 -33
  44. package/src/Session.ts +0 -1293
  45. package/src/State.ts +0 -98
  46. package/src/WantedVersions.ts +0 -57
  47. package/src/defaultConfig.ts +0 -33
  48. package/src/index.ts +0 -59
  49. package/src/transports/CodeMessageBuilder.ts +0 -226
  50. package/src/transports/Protocol.ts +0 -78
  51. package/src/transports/Transport.ts +0 -270
  52. package/src/transports/index.ts +0 -8
  53. package/src/transports/types.ts +0 -89
  54. package/src/transports/webPlayer.ts +0 -93
  55. package/src/types.ts +0 -223
  56. package/src/utils.ts +0 -71
  57. package/tsconfig.json +0 -28
package/src/State.ts DELETED
@@ -1,98 +0,0 @@
1
- import isEqual from 'lodash/isEqual';
2
- import { isModulePreloaded } from 'snack-content';
3
-
4
- import { SnackState } from './types';
5
-
6
- export type StateObject<T> = {
7
- [key: string]: T;
8
- };
9
-
10
- export function addObjects<T>(
11
- state: StateObject<T>,
12
- content: { [key: string]: T },
13
- filter?: (a: T, b: T) => boolean
14
- ): StateObject<T> {
15
- let newState: StateObject<T> | null = null;
16
- for (const key in content) {
17
- if (filter ? filter(content[key], state[key]) : !isEqual(content[key], state[key])) {
18
- newState = newState ?? { ...state };
19
- newState[key] = content[key];
20
- }
21
- }
22
- return newState ?? state;
23
- }
24
-
25
- export function addObject<T>(
26
- state: StateObject<T>,
27
- key: string,
28
- content: T,
29
- filter?: (a: T, b: T) => boolean
30
- ): StateObject<T> {
31
- return addObjects(state, { [key]: content }, filter);
32
- }
33
-
34
- export function removeObjects<T>(state: StateObject<T>, keys: string[]): StateObject<T> {
35
- if (!keys.length) return state;
36
- let newState: StateObject<T> | null = null;
37
- keys.forEach((key) => {
38
- if (state[key]) {
39
- newState = newState ?? { ...state };
40
- delete newState[key];
41
- }
42
- });
43
- return newState ?? state;
44
- }
45
-
46
- export function removeObject<T>(state: StateObject<T>, key: string): StateObject<T> {
47
- return removeObjects(state, [key]);
48
- }
49
-
50
- export function updateObjects<T>(
51
- state: StateObject<T>,
52
- content: { [key: string]: T | null },
53
- compareFn: (a: T, b: T) => boolean = isEqual
54
- ): StateObject<T> {
55
- let newState: StateObject<T> | null = null;
56
- for (const key in content) {
57
- const val = content[key];
58
- if (val === null) {
59
- if (state[key]) {
60
- newState = newState ?? { ...state };
61
- delete newState[key];
62
- }
63
- } else if (!compareFn(val, state[key])) {
64
- newState = newState ?? { ...state };
65
- newState[key] = val;
66
- }
67
- }
68
- return newState ?? state;
69
- }
70
-
71
- export function isBusy(state: SnackState): boolean {
72
- return (
73
- !!Object.keys(state.dependencies).find(
74
- (name) => !state.dependencies[name].handle && !isModulePreloaded(name, state.sdkVersion)
75
- ) ||
76
- !!Object.values(state.files).find(
77
- (file) => file.type === 'ASSET' && typeof file.contents !== 'string'
78
- )
79
- );
80
- }
81
-
82
- export function isCodeChanged(state: SnackState, prevState: SnackState) {
83
- return (
84
- state.dependencies !== prevState.dependencies ||
85
- state.files !== prevState.files ||
86
- state.sdkVersion !== prevState.sdkVersion
87
- );
88
- }
89
-
90
- export function isUnsaved(state: SnackState, prevState: SnackState) {
91
- return (
92
- state.dependencies !== prevState.dependencies ||
93
- state.files !== prevState.files ||
94
- state.sdkVersion !== prevState.sdkVersion ||
95
- state.name !== prevState.name ||
96
- state.description !== prevState.description
97
- );
98
- }
@@ -1,57 +0,0 @@
1
- import { SDKVersion, SnackDependencyVersions, sdks } from 'snack-content';
2
-
3
- import { Logger } from './Logger';
4
- import { SnackError } from './types';
5
- import { fetch } from './utils';
6
-
7
- export type WantedDependencyVersionsCallback = (
8
- sdkVersion: SDKVersion,
9
- result?: SnackDependencyVersions,
10
- error?: SnackError
11
- ) => any;
12
-
13
- export class WantedDependencyVersions {
14
- private readonly callback: WantedDependencyVersionsCallback;
15
- private readonly logger?: Logger;
16
- private sdkVersion?: SDKVersion;
17
- private promise: Promise<any>;
18
-
19
- constructor(options: { logger?: Logger; callback: WantedDependencyVersionsCallback }) {
20
- this.logger = options.logger;
21
- this.callback = options.callback;
22
- this.promise = Promise.resolve();
23
- }
24
-
25
- setSDKVersion(sdkVersion: SDKVersion) {
26
- if (this.sdkVersion !== sdkVersion) {
27
- this.sdkVersion = sdkVersion;
28
- this.promise = this._fetch(sdkVersion);
29
- }
30
- }
31
-
32
- waitForCompletion() {
33
- return this.promise;
34
- }
35
-
36
- private async _fetch(sdkVersion: SDKVersion): Promise<any> {
37
- let json: any;
38
- try {
39
- this.logger?.module('fetching bundledNativeModules for SDK', sdkVersion, '...');
40
- const url = `https://cdn.jsdelivr.net/npm/expo@${encodeURIComponent(
41
- sdks[sdkVersion]?.version || sdkVersion
42
- )}/bundledNativeModules.json`;
43
- const response = await fetch(url);
44
- json = await response.json();
45
- } catch (e) {
46
- if (this.sdkVersion === sdkVersion) {
47
- this.logger?.error(e);
48
- this.callback(sdkVersion, undefined, e);
49
- }
50
- return;
51
- }
52
- if (this.sdkVersion === sdkVersion) {
53
- this.logger?.module('fetched bundledNativeModules for SDK', sdkVersion, json);
54
- this.callback(sdkVersion, json);
55
- }
56
- }
57
- }
@@ -1,33 +0,0 @@
1
- import { defaultSdkVersion } from 'snack-content';
2
-
3
- import { SnackState } from './types';
4
-
5
- export const apiURL: string = 'https://exp.host';
6
- export const snackagerURL: string = 'https://snackager.expo.io';
7
- export const webPlayerURL: string =
8
- 'https://snack-web-player.s3.us-west-1.amazonaws.com/v2/%%SDK_VERSION%%';
9
-
10
- export const SnackIdentityState: SnackState = {
11
- sdkVersion: defaultSdkVersion,
12
- name: '',
13
- description: '',
14
- dependencies: {},
15
- missingDependencies: {},
16
- files: {},
17
- connectedClients: {},
18
- transports: {},
19
- disabled: false,
20
- unsaved: false,
21
- online: false,
22
- url: '',
23
- channel: '',
24
- };
25
-
26
- const defaultConfig = {
27
- apiURL,
28
- snackagerURL,
29
- sdkVersion: defaultSdkVersion,
30
- webPlayerURL,
31
- };
32
-
33
- export default defaultConfig;
package/src/index.ts DELETED
@@ -1,59 +0,0 @@
1
- import {
2
- SDKFeature,
3
- SDKVersion,
4
- SnackAssetFile,
5
- SnackCodeFile,
6
- SnackFile,
7
- SnackFiles,
8
- SnackDependency,
9
- SnackDependencyVersions,
10
- SnackDependencies,
11
- SnackMissingDependency,
12
- SnackMissingDependencies,
13
- isModulePreloaded,
14
- getPreloadedModules,
15
- isValidSemver,
16
- getSupportedSDKVersions,
17
- isFeatureSupported,
18
- standardizeDependencies,
19
- getDeprecatedModule,
20
- } from 'snack-content';
21
-
22
- import Snack, {
23
- SnackOptions,
24
- SnackSaveOptions,
25
- SnackStateListener,
26
- SnackLogListener,
27
- } from './Session';
28
- import defaultConfig from './defaultConfig';
29
-
30
- export * from './transports';
31
- export * from './types';
32
- export type {
33
- SnackOptions,
34
- SnackSaveOptions,
35
- SnackStateListener,
36
- SnackLogListener,
37
- SDKFeature,
38
- SDKVersion,
39
- SnackAssetFile,
40
- SnackCodeFile,
41
- SnackFile,
42
- SnackFiles,
43
- SnackDependency,
44
- SnackDependencyVersions,
45
- SnackDependencies,
46
- SnackMissingDependency,
47
- SnackMissingDependencies,
48
- };
49
- export {
50
- isModulePreloaded,
51
- getPreloadedModules,
52
- isValidSemver,
53
- getSupportedSDKVersions,
54
- isFeatureSupported,
55
- standardizeDependencies,
56
- getDeprecatedModule,
57
- defaultConfig,
58
- Snack,
59
- };
@@ -1,226 +0,0 @@
1
- import { createPatch } from 'diff';
2
- import {
3
- SnackFiles,
4
- SDKVersion,
5
- SnackCodeFile,
6
- SnackDependencies,
7
- isModulePreloaded,
8
- } from 'snack-content';
9
- import { UAParser } from 'ua-parser-js';
10
-
11
- import FileUploader, { FileUploaderCallback } from '../FileUploader';
12
- import { Logger } from '../Logger';
13
- import { SnackIdentityState } from '../defaultConfig';
14
- import { ProtocolCodeMessage, ProtocolCodeMessageDependencies } from './Protocol';
15
-
16
- export type SnackCode = {
17
- files: SnackFiles;
18
- dependencies: SnackDependencies;
19
- sdkVersion: SDKVersion;
20
- };
21
-
22
- const SnackIdentityCode: SnackCode = {
23
- files: SnackIdentityState.files,
24
- dependencies: SnackIdentityState.dependencies,
25
- sdkVersion: SnackIdentityState.sdkVersion,
26
- };
27
-
28
- export type CodeMessageBuilderCallback = (codeMessage: ProtocolCodeMessage, code: SnackCode) => any;
29
-
30
- export function getFileDiff(oldCode: string, newCode: string): string {
31
- const patch = createPatch('code', oldCode, newCode, '', '', {
32
- context: 0,
33
- });
34
- if (patch) {
35
- return patch;
36
- } else {
37
- throw new Error('Error creating a file diff');
38
- }
39
- }
40
-
41
- const PLACEHOLDER_URL =
42
- 'https://snack-code-uploads.s3.us-west-1.amazonaws.com/~asset/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
43
-
44
- export default class CodeMessageBuilder {
45
- private callback: CodeMessageBuilderCallback;
46
- private code: SnackCode = SnackIdentityCode;
47
- private codeMessage?: ProtocolCodeMessage;
48
- private logger?: Logger;
49
- private codeUploader?: FileUploader;
50
- private maxDiffPlaceholder?: string;
51
- private placeholderURLs: { [path: string]: string } = {};
52
- private uploadedURLs: { [path: string]: string } = {};
53
- private verifyCodeMessageSize: (message: ProtocolCodeMessage) => boolean;
54
-
55
- constructor(options: {
56
- callback: CodeMessageBuilderCallback;
57
- verifyCodeMessageSize: (message: ProtocolCodeMessage) => boolean;
58
- apiURL?: string;
59
- logger?: Logger;
60
- maxDiffPlaceholder?: string;
61
- }) {
62
- this.logger = options.logger;
63
- this.callback = options.callback;
64
- this.verifyCodeMessageSize = options.verifyCodeMessageSize;
65
- this.maxDiffPlaceholder = options.maxDiffPlaceholder;
66
- this.codeUploader = options.apiURL
67
- ? new FileUploader({
68
- apiURL: options.apiURL,
69
- logger: options.logger,
70
- callback: this.onFileUploaded,
71
- })
72
- : undefined;
73
- }
74
-
75
- setCode(code: SnackCode) {
76
- if (code === this.code) {
77
- return;
78
- }
79
-
80
- const prevCode = this.code;
81
- const { files } = code;
82
- this.code = code;
83
-
84
- // Cancel any uploads for files that were removed or changed
85
- for (const path in prevCode.files) {
86
- if (prevCode.files[path].contents !== files[path]?.contents) {
87
- delete this.placeholderURLs[path];
88
- delete this.uploadedURLs[path];
89
- this.codeUploader?.remove(path, prevCode.files[path]);
90
- }
91
- }
92
-
93
- // Generate code message
94
- const codeMessage = this.createCodeMessage(code, this.codeMessage, prevCode);
95
- this.codeMessage = codeMessage;
96
-
97
- // When the code message size is valid and there are no pending
98
- // uploads, then fire the callback immediately
99
- if (this.verifyCodeMessageSize(codeMessage)) {
100
- if (!Object.keys(this.placeholderURLs).length) {
101
- this.callback(codeMessage, code);
102
- }
103
- return;
104
- }
105
-
106
- // Upload files if the code message exceeds the limit
107
- // Sort code files by size
108
- if (this.codeUploader) {
109
- const paths = Object.keys(files)
110
- .filter((path) => files[path].type === 'CODE')
111
- // @ts-ignore
112
- .sort((a, b) => files[b].contents.length - files[a].contents.length);
113
-
114
- // Upload the largest file
115
- for (let i = 0; i < paths.length; i++) {
116
- const path = paths[i];
117
- if (!this.uploadedURLs[path] && !this.placeholderURLs[path]) {
118
- const file: SnackCodeFile = files[path] as any;
119
- this.placeholderURLs[path] = PLACEHOLDER_URL;
120
- // this.logger?.comm('Uploading file', path, `, ${file.contents.length} bytes ...`);
121
- this.codeUploader.add(path, file);
122
- codeMessage.diff[path] = '';
123
- codeMessage.s3url[path] = this.placeholderURLs[path];
124
- if (this.verifyCodeMessageSize(codeMessage)) {
125
- // Message size is now valid. When the upload completes, it
126
- // will try to call the callback
127
- return;
128
- }
129
- }
130
- }
131
- }
132
-
133
- // Message is still too large
134
- this.logger?.error('Message size is too large');
135
- }
136
-
137
- private createCodeMessage(
138
- code: SnackCode,
139
- prevCodeMessage?: ProtocolCodeMessage,
140
- prevCode?: SnackCode
141
- ): ProtocolCodeMessage {
142
- const { files, dependencies, sdkVersion } = code;
143
-
144
- const diff: any = { ...files };
145
- const s3url: any = {};
146
- for (const path in files) {
147
- const file = files[path];
148
- if (this.uploadedURLs[path] || this.placeholderURLs[path]) {
149
- diff[path] = '';
150
- s3url[path] = this.uploadedURLs[path] || this.placeholderURLs[path];
151
- } else {
152
- if (file.type === 'CODE') {
153
- if (
154
- prevCodeMessage?.diff[path] &&
155
- prevCode?.files[path].contents === code.files[path].contents
156
- ) {
157
- diff[path] = prevCodeMessage.diff[path];
158
- } else {
159
- if (this.maxDiffPlaceholder && file.contents.length >= this.maxDiffPlaceholder.length) {
160
- diff[path] = this.maxDiffPlaceholder;
161
- } else {
162
- diff[path] = getFileDiff('', file.contents);
163
- }
164
- }
165
- } else {
166
- diff[path] = '';
167
- }
168
- if (file.type === 'ASSET' && typeof file.contents === 'string') {
169
- s3url[path] = file.contents;
170
- }
171
- }
172
- }
173
-
174
- const deps: ProtocolCodeMessageDependencies = {};
175
- for (const name in dependencies) {
176
- const dep = dependencies[name];
177
- if (dep.handle && !isModulePreloaded(name, sdkVersion)) {
178
- deps[name] = {
179
- version: dep.version,
180
- handle: dep.handle,
181
- // Resolved has been replaced by handle. It is still needed for pre SDK 37 runtimes
182
- resolved: dep.handle.substring(dep.handle.lastIndexOf('@') + 1),
183
- };
184
- }
185
- }
186
-
187
- const metadata: any = {
188
- expoSDKVersion: code.sdkVersion,
189
- // TODO: restore sdk version field
190
- // webSnackSDKVersion: require('../../package.json').version,
191
- };
192
- if (typeof navigator !== 'undefined' && navigator.userAgent) {
193
- const ua = new UAParser(navigator.userAgent).getResult();
194
- metadata.webHostName = window.location.hostname;
195
- metadata.webOSArchitecture = ua.cpu.architecture;
196
- metadata.webOSFamily = ua.os.name;
197
- metadata.webOSVersion = ua.os.version;
198
- metadata.webLayoutEngine = ua.engine.name;
199
- metadata.webDeviceType = ua.device.type;
200
- metadata.webBrowser = ua.browser.name;
201
- metadata.webBrowserVersion = ua.browser.version;
202
- }
203
-
204
- return {
205
- type: 'CODE',
206
- diff,
207
- s3url,
208
- dependencies: deps,
209
- metadata,
210
- };
211
- }
212
-
213
- private onFileUploaded: FileUploaderCallback = (request, resultURL, _error) => {
214
- const { path } = request;
215
- delete this.placeholderURLs[path];
216
- if (resultURL) {
217
- this.uploadedURLs[path] = resultURL;
218
- if (!Object.keys(this.placeholderURLs).length) {
219
- const codeMessage = this.createCodeMessage(this.code, this.codeMessage, this.code);
220
- if (this.verifyCodeMessageSize(codeMessage)) {
221
- this.callback(codeMessage, this.code);
222
- }
223
- }
224
- }
225
- };
226
- }
@@ -1,78 +0,0 @@
1
- import { SDKVersion } from 'snack-content';
2
-
3
- export type Device = {
4
- name: string;
5
- id: string;
6
- platform: string;
7
- };
8
-
9
- export type ProtocolConsoleMessage = {
10
- type: 'CONSOLE';
11
- device: Device;
12
- method: 'log' | 'error' | 'warn';
13
- payload: any[];
14
- };
15
-
16
- export type ProtocolErrorMessage = {
17
- type: 'ERROR';
18
- error: string; // e.g. `{message: "my error", stack: "..."}`
19
- device: Device;
20
- };
21
-
22
- export type ProtocolResendCodeMessage = {
23
- type: 'RESEND_CODE';
24
- device: Device;
25
- };
26
-
27
- export type ProtocolCodeMessageDependencies = {
28
- [name: string]: {
29
- version: string; // original version
30
- resolved: string; // resolved version
31
- handle: string; // snackager handle
32
- };
33
- };
34
-
35
- export type ProtocolCodeMessage = {
36
- type: 'CODE';
37
- diff: { [path: string]: string };
38
- s3url: { [path: string]: string };
39
- dependencies: ProtocolCodeMessageDependencies;
40
- metadata: {
41
- expoSDKVersion: SDKVersion;
42
- webSnackSDKVersion: string;
43
- webHostname?: string; // window.location.hostname,
44
- webOSArchitecture?: string; // os.architecture,
45
- webOSFamily?: string; // os.family,
46
- webOSVersion?: string; // os.version,
47
- webLayoutEngine?: string; // platformInfo.layout,
48
- webDeviceType?: string; // platformInfo.product,
49
- webBrowser?: string; // platformInfo.name,
50
- webBrowserVersion?: string; // platformInfo.version,
51
- webDescription?: string; // platformInfo.description,
52
- };
53
- };
54
-
55
- export type ProtocolReloadMessage = {
56
- type: 'RELOAD_SNACK';
57
- };
58
-
59
- export type ProtocolRequestStatusMessage = {
60
- type: 'REQUEST_STATUS';
61
- };
62
-
63
- export type ProtocolStatusMessage = {
64
- type: 'STATUS_REPORT';
65
- previewLocation: string;
66
- status: 'FAILURE' | 'SUCCESS';
67
- };
68
-
69
- export type ProtocolOutgoingMessage =
70
- | ProtocolCodeMessage
71
- | ProtocolReloadMessage
72
- | ProtocolRequestStatusMessage;
73
-
74
- export type ProtocolIncomingMessage =
75
- | ProtocolConsoleMessage
76
- | ProtocolErrorMessage
77
- | ProtocolResendCodeMessage
78
- | ProtocolStatusMessage;