snack-sdk 3.8.0 → 3.10.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 (58) hide show
  1. package/CHANGELOG.md +27 -1
  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 +305 -301
  11. package/build/Session.js +1198 -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 +189 -185
  36. package/build/types.js +2 -2
  37. package/build/types.js.map +1 -1
  38. package/build/utils.d.ts +17 -17
  39. package/build/utils.js +68 -68
  40. package/package.json +11 -4
  41. package/src/DependencyResolver.ts +0 -218
  42. package/src/DevSession.ts +0 -159
  43. package/src/FileUploader.ts +0 -135
  44. package/src/Logger.ts +0 -33
  45. package/src/Session.ts +0 -1293
  46. package/src/State.ts +0 -98
  47. package/src/WantedVersions.ts +0 -57
  48. package/src/defaultConfig.ts +0 -33
  49. package/src/index.ts +0 -59
  50. package/src/transports/CodeMessageBuilder.ts +0 -226
  51. package/src/transports/Protocol.ts +0 -78
  52. package/src/transports/Transport.ts +0 -270
  53. package/src/transports/index.ts +0 -8
  54. package/src/transports/types.ts +0 -89
  55. package/src/transports/webPlayer.ts +0 -93
  56. package/src/types.ts +0 -223
  57. package/src/utils.ts +0 -71
  58. package/tsconfig.json +0 -28
@@ -1,218 +0,0 @@
1
- import semver from 'semver';
2
- import {
3
- SDKVersion,
4
- SnackDependencies,
5
- SnackMissingDependencies,
6
- SnackDependencyVersions,
7
- isModulePreloaded,
8
- isValidSemver,
9
- } from 'snack-content';
10
- import validate from 'validate-npm-package-name';
11
-
12
- import { Logger } from './Logger';
13
- import { SnackError } from './types';
14
- import { fetch, createError } from './utils';
15
-
16
- export type DependencyResolverCallback = (
17
- request: {
18
- name: string;
19
- version: string;
20
- sdkVersion: SDKVersion;
21
- },
22
- result?: any,
23
- error?: SnackError
24
- ) => any;
25
-
26
- function getKey(name: string, version: string) {
27
- return version ? `${name}@${version}` : name;
28
- }
29
-
30
- export default class DependencyResolver {
31
- private snackagerURL: string;
32
- private logger?: Logger;
33
- private status: { [key: string]: Promise<any> } = {};
34
- private callback: DependencyResolverCallback;
35
-
36
- constructor(options: {
37
- snackagerURL: string;
38
- logger?: Logger;
39
- callback: DependencyResolverCallback;
40
- }) {
41
- this.snackagerURL = options.snackagerURL;
42
- this.logger = options.logger;
43
- this.callback = options.callback;
44
- }
45
-
46
- add(name: string, version: string, sdkVersion: SDKVersion) {
47
- const key = getKey(name, version);
48
- this.status[key] = this.status[key] || this.resolve(key, name, version, sdkVersion);
49
- return this.status[key];
50
- }
51
-
52
- remove(name: string, version: string, _sdkVersion: string) {
53
- delete this.status[getKey(name, version)];
54
- }
55
-
56
- async waitForCompletion() {
57
- let promises = Object.values(this.status);
58
- while (promises.length) {
59
- await Promise.all(promises);
60
- promises = Object.values(this.status);
61
- }
62
- }
63
-
64
- private async resolve(
65
- key: string,
66
- name: string,
67
- version: string,
68
- sdkVersion: SDKVersion
69
- ): Promise<any> {
70
- const versionSnackager = sdkVersion >= '37.0.0' ? 'version_snackager=true&' : '';
71
- const url = `${this.snackagerURL}/bundle/${key}?${versionSnackager}platforms=ios,android,web`;
72
- this.logger?.module('Resolving dependency', key, '...');
73
- try {
74
- for (let i = 0; i < 30; i++) {
75
- const res = await fetch(url);
76
- if (!this.status[key]) {
77
- return;
78
- }
79
- if (res.status === 200) {
80
- const data = await res.json();
81
- if (data.pending) {
82
- this.logger?.module('Dependency is still being bundled', key, 'trying again shortly');
83
- await new Promise((resolve) => setTimeout(resolve, 5000));
84
- if (!this.status[key]) {
85
- return;
86
- }
87
- } else {
88
- this.logger?.module('Resolved dependency', key, data);
89
- delete this.status[key];
90
- try {
91
- this.callback(
92
- {
93
- name,
94
- version,
95
- sdkVersion,
96
- },
97
- data
98
- );
99
- return;
100
- } catch (e) {
101
- return Promise.reject(e);
102
- }
103
- }
104
- } else {
105
- const error = await res.text();
106
- throw new Error(error);
107
- }
108
- }
109
- } catch (e) {
110
- const error = createError({
111
- message: `Failed to resolve dependency '${key}' (${e.message})`,
112
- fileName: key,
113
- });
114
- this.logger?.error(error);
115
- // TypeScript thinks we need to await this promise, but we are actually checking if there is a promise or not. TS2801
116
- // ESLint doesn't like when we cast to a boolean inside of an if statement. no-extra-boolean-cast
117
- const promiseExists = !!this.status[key];
118
- if (promiseExists) {
119
- delete this.status[key];
120
- this.callback(
121
- {
122
- name,
123
- version,
124
- sdkVersion,
125
- },
126
- undefined,
127
- error
128
- );
129
- }
130
- }
131
- }
132
- }
133
-
134
- export function getMissingDependencies(
135
- dependencies: SnackDependencies,
136
- sdkVersion: SDKVersion,
137
- wantedDependencyVersions?: SnackDependencyVersions
138
- ): SnackMissingDependencies {
139
- const result: SnackMissingDependencies = {};
140
- for (const name in dependencies) {
141
- const dep = dependencies[name];
142
- if (dep.peerDependencies) {
143
- for (const peerName in dep.peerDependencies) {
144
- if (!isModulePreloaded(peerName, sdkVersion, true) && !dependencies[peerName]) {
145
- if (!result[peerName]) {
146
- result[peerName] = {
147
- dependents: [name],
148
- wantedVersion:
149
- wantedDependencyVersions?.[peerName] ?? dep.peerDependencies[peerName] ?? '*',
150
- };
151
- } else {
152
- let wantedVersion: string | undefined = wantedDependencyVersions?.[peerName];
153
- if (!wantedVersion) {
154
- wantedVersion = result[peerName].wantedVersion;
155
- const version = dep.peerDependencies[peerName] || '*';
156
- // Select the highest most specific version
157
- if (
158
- wantedVersion === '*' ||
159
- (version === 'latest' && wantedVersion === 'latest') ||
160
- (version !== '*' &&
161
- version !== 'latest' &&
162
- (wantedVersion === 'latest' ||
163
- semver.gt(semver.coerce(version)!, semver.coerce(wantedVersion!)!)))
164
- ) {
165
- wantedVersion = version;
166
- }
167
- }
168
- result[peerName] = {
169
- dependents: [...result[peerName].dependents, name],
170
- wantedVersion,
171
- };
172
- }
173
- }
174
- }
175
- }
176
- }
177
- return result;
178
- }
179
-
180
- export function verifyDependency(name: string, version: string): SnackError | undefined {
181
- let { validForOldPackages, errors } = validate(name);
182
- if (!validForOldPackages) {
183
- // Also support code inside packages such as "react-native-gesture-handler/DrawerLayout"
184
- const names = name.split('/');
185
- if (names.length >= 2 && !name.startsWith('@')) {
186
- const result = validate(names[0]);
187
- validForOldPackages = result.validForNewPackages;
188
- errors = result.errors;
189
- } else if (names.length >= 2 && name.startsWith('@')) {
190
- const result = validate(names[0] + '/' + names[1]);
191
- validForOldPackages = result.validForNewPackages;
192
- errors = result.errors;
193
- }
194
-
195
- if (!validForOldPackages) {
196
- return createError({
197
- message: `Invalid dependency '${name}' ${errors?.length ? `(${errors[0]})` : ''}`,
198
- fileName: name,
199
- });
200
- }
201
- }
202
- if (!isValidSemver(version)) {
203
- return createError({
204
- message: `Invalid dependency '${name}' (version '${version}' is not a valid semver)`,
205
- fileName: name,
206
- });
207
- }
208
- return undefined;
209
- }
210
-
211
- export function getPackageName(name: string): string {
212
- const names = name.split('/');
213
- if (names[0].startsWith('@') && names.length >= 2) {
214
- return `${names[0]}/${names[1]}`;
215
- } else {
216
- return names[0];
217
- }
218
- }
package/src/DevSession.ts DELETED
@@ -1,159 +0,0 @@
1
- import { Logger } from './Logger';
2
- import { SnackState, SnackUser, SnackSendBeaconRequest } from './types';
3
- import { createUserHeader, fetch } from './utils';
4
-
5
- export default class DevSession {
6
- private apiURL: string;
7
- private logger?: Logger;
8
- private onSendBeaconCloseRequest: (request: SnackSendBeaconRequest) => any;
9
- private notifyInterval: number = 40000;
10
- private notifyTimer?: any;
11
- private focusedAt?: number;
12
-
13
- constructor(options: {
14
- apiURL: string;
15
- logger?: Logger;
16
- onSendBeaconCloseRequest: (request: SnackSendBeaconRequest) => any;
17
- }) {
18
- this.apiURL = options.apiURL;
19
- this.logger = options.logger;
20
- this.onSendBeaconCloseRequest = options.onSendBeaconCloseRequest;
21
- }
22
-
23
- setState(state: SnackState, prevState: SnackState) {
24
- // Notify or close the session , when either:
25
- // 1. session-url has changed
26
- // 2. user has changed
27
- // 3. device-id has hanged
28
-
29
- // Close
30
- const isCloseUser =
31
- prevState.user &&
32
- (!state.online || state.url !== prevState.url || state.user !== prevState.user);
33
- const isCloseDevice =
34
- prevState.deviceId &&
35
- (!state.online || state.url !== prevState.url || state.deviceId !== prevState.deviceId);
36
- if (prevState.online && (isCloseUser || isCloseDevice)) {
37
- this.close(
38
- prevState.url,
39
- isCloseUser ? prevState.user : undefined,
40
- isCloseDevice ? prevState.deviceId : undefined
41
- );
42
- }
43
-
44
- // Notify
45
- if (
46
- state.user !== prevState.user ||
47
- state.online !== prevState.online ||
48
- state.url !== prevState.url ||
49
- state.deviceId !== prevState.deviceId ||
50
- state.onlineName !== prevState.onlineName
51
- ) {
52
- this.notify(state);
53
- }
54
- }
55
-
56
- setFocus(state: SnackState) {
57
- this.notify(state, true);
58
- }
59
-
60
- private getRequest(close: boolean, user?: SnackUser, deviceId?: string) {
61
- const suffix = deviceId ? `?deviceId=${deviceId}` : '';
62
- const endpoint = close ? 'notify-close' : 'notify-alive';
63
- const url = `${this.apiURL}/--/api/v2/development-sessions/${endpoint}${suffix}`;
64
-
65
- return {
66
- url,
67
- method: 'post',
68
- headers: {
69
- 'Content-Type': 'application/json',
70
- ...createUserHeader(user),
71
- },
72
- };
73
- }
74
-
75
- private async notify(state: SnackState, setFocus?: boolean) {
76
- const { user, online, url: onlineURL, deviceId, onlineName } = state;
77
-
78
- if (this.notifyTimer) {
79
- clearTimeout(this.notifyTimer);
80
- this.notifyTimer = undefined;
81
- }
82
-
83
- if (!online || (!user && !deviceId)) {
84
- this.focusedAt = undefined;
85
- return;
86
- }
87
-
88
- if (!this.focusedAt || setFocus) {
89
- this.focusedAt = Date.now();
90
- }
91
-
92
- if (!this.notifyTimer) {
93
- this.notifyTimer = setTimeout(() => this.notify(state), this.notifyInterval);
94
- }
95
-
96
- try {
97
- const { url, ...data } = this.getRequest(false, user, deviceId);
98
- const response = await fetch(url, {
99
- ...data,
100
- body: JSON.stringify({
101
- data: {
102
- session: {
103
- description: onlineName,
104
- hostname: 'snack',
105
- config: {},
106
- url: onlineURL,
107
- source: 'snack',
108
- openedAt: this.focusedAt,
109
- },
110
- },
111
- }),
112
- });
113
- if (!response.ok) {
114
- throw Error(response.statusText);
115
- }
116
-
117
- const json = await response.json();
118
- this.onSendBeaconCloseRequest({
119
- url: this.getRequest(true, undefined, deviceId).url,
120
- data: new Blob(
121
- [
122
- JSON.stringify({
123
- session: {
124
- url: onlineURL,
125
- },
126
- ...(json.data?.auth
127
- ? {
128
- auth: json.data.auth,
129
- }
130
- : {}),
131
- }),
132
- ],
133
- { type: 'text/plain' }
134
- ),
135
- });
136
- } catch (e) {
137
- this.logger?.error('Failed to advertise', e);
138
- }
139
- }
140
-
141
- private async close(onlineURL: string, user?: SnackUser, deviceId?: string) {
142
- try {
143
- const { url, ...data } = this.getRequest(true, user, deviceId);
144
- const response = await fetch(url, {
145
- ...data,
146
- body: JSON.stringify({
147
- session: {
148
- url: onlineURL,
149
- },
150
- }),
151
- });
152
- if (!response.ok) {
153
- throw Error(response.statusText);
154
- }
155
- } catch (e) {
156
- this.logger?.error('Failed to advertise close', e);
157
- }
158
- }
159
- }
@@ -1,135 +0,0 @@
1
- import { SnackFile } from 'snack-content';
2
-
3
- import { Logger } from './Logger';
4
- import { SnackError } from './types';
5
- import { fetch, createError } from './utils';
6
-
7
- export type FileUploaderRequest = {
8
- path: string;
9
- file: SnackFile;
10
- };
11
-
12
- export type FileUploaderCallback = (
13
- request: FileUploaderRequest,
14
- resultURL?: string,
15
- error?: SnackError
16
- ) => any;
17
-
18
- export default class FileUploader {
19
- private apiURL: string;
20
- private logger?: Logger;
21
- private status: {
22
- [path: string]: {
23
- file: SnackFile;
24
- promise: Promise<any>;
25
- };
26
- } = {};
27
- private callback: FileUploaderCallback;
28
-
29
- constructor(options: { apiURL: string; callback: FileUploaderCallback; logger?: Logger }) {
30
- this.apiURL = options.apiURL;
31
- this.callback = options.callback;
32
- this.logger = options.logger;
33
- }
34
-
35
- add(path: string, file: SnackFile) {
36
- const status = this.status[path];
37
- if (status && status.file === file) {
38
- return status.promise;
39
- }
40
- this.status[path] = {
41
- file,
42
- promise: this.upload(path, file),
43
- };
44
- return this.status[path].promise;
45
- }
46
-
47
- remove(path: string, file?: SnackFile) {
48
- if (!file || this.status[path]?.file === file) {
49
- delete this.status[path];
50
- }
51
- }
52
-
53
- async waitForCompletion() {
54
- let promises = Object.values(this.status).map((status) => status.promise);
55
- while (promises.length) {
56
- await Promise.all(promises);
57
- promises = Object.values(this.status).map((status) => status.promise);
58
- }
59
- }
60
-
61
- private async upload(path: string, file: SnackFile): Promise<any> {
62
- try {
63
- this.logger?.module('Uploading file', path, '...');
64
- let url: string;
65
- let input;
66
- switch (file.type) {
67
- case 'CODE':
68
- url = `${this.apiURL}/--/api/v2/snack/uploadCode`;
69
- input = {
70
- method: 'POST',
71
- body: JSON.stringify({ code: file.contents }),
72
- headers: { 'Content-Type': 'application/json' },
73
- };
74
- break;
75
- case 'ASSET':
76
- url = `${this.apiURL}/--/api/v2/snack/uploadAsset`;
77
- if (
78
- (typeof FormData !== 'undefined' && file.contents instanceof FormData) ||
79
- (typeof file.contents === 'object' && file.contents.constructor?.name === 'FormData')
80
- ) {
81
- input = {
82
- method: 'POST',
83
- body: file.contents,
84
- };
85
- } else if (typeof FormData !== 'undefined') {
86
- const formData = new FormData();
87
- // @ts-expect-error: file.contents can be both File or Blob
88
- formData.append('asset', file.contents, file.contents?.name || path);
89
- input = {
90
- method: 'POST',
91
- body: formData,
92
- };
93
- } else {
94
- // TODO: Add support for uploading files using ArrayBuffer in body to the /snack/uploadAsset end-point
95
- // That way it's no longer neccessary to polyfill FormData is environments such as node.
96
- throw new Error(
97
- 'Uploading assets is not supported in this environment. Make sure FormData is polyfilled or provide the data as a FormData object'
98
- );
99
- }
100
- break;
101
- default:
102
- // @ts-ignore: Property 'type' does not exist on type 'never'
103
- throw new Error(`Invalid file type ${file.type}`);
104
- }
105
-
106
- const response = await fetch(url, input);
107
- if (!response.ok) {
108
- const text = await response.text();
109
- throw new Error(text);
110
- }
111
- const result = await response.json();
112
- const resultURL = result.url;
113
-
114
- if (this.status[path]?.file === file) {
115
- this.logger?.module('Uploaded file', path, resultURL);
116
- delete this.status[path];
117
- try {
118
- this.callback({ path, file }, resultURL);
119
- } catch (e) {
120
- return Promise.reject(e);
121
- }
122
- }
123
- } catch (e) {
124
- const error = createError({
125
- message: `Failed to upload file ${path} (${e.message})`,
126
- fileName: path,
127
- });
128
- this.logger?.error(error);
129
- if (this.status[path]?.file === file) {
130
- delete this.status[path];
131
- this.callback({ path, file }, undefined, error);
132
- }
133
- }
134
- }
135
- }
package/src/Logger.ts DELETED
@@ -1,33 +0,0 @@
1
- type LogFn = (...messages: unknown[]) => void;
2
-
3
- export interface Logger {
4
- info: LogFn;
5
- warn: LogFn;
6
- error: LogFn;
7
- comm: LogFn;
8
- comm_recv: LogFn;
9
- module: LogFn;
10
- }
11
-
12
- function logFn(isEnabled: boolean, type: string, color: string, textColor?: string) {
13
- return (...messages: any[]) => {
14
- if (isEnabled) {
15
- console.log(
16
- `%c ${type.toUpperCase()} `,
17
- `background: ${color}; color: ${textColor ?? '#fff'}`,
18
- ...messages
19
- );
20
- }
21
- };
22
- }
23
-
24
- export function createLogger(isEnabled: boolean): Logger {
25
- return {
26
- info: logFn(isEnabled, 'info', '#2196f3'),
27
- warn: logFn(isEnabled, 'warn', '#FF9800'),
28
- error: logFn(isEnabled, 'error', '#f44336'),
29
- comm: logFn(isEnabled, 'comm', '#DBD64E'),
30
- comm_recv: logFn(isEnabled, 'comm', '#DBD64E', '#000'),
31
- module: logFn(isEnabled, 'module', '#DB14C7'),
32
- };
33
- }