@alwaysmeticulous/api 2.250.7 → 2.251.1

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.
package/dist/index.d.ts CHANGED
@@ -6,7 +6,7 @@ export { TestRunChunkStatus } from "./replay/test-run-chunk.types";
6
6
  export * from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
7
7
  export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";
8
8
  export { HarEntry, HarLog, HarRequest, HarResponse, } from "./sdk-bundle-api/sdk-to-bundle/har-log";
9
- export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, SerializedIDBValidKey, IDBObjectStoreMetadata, IDBObjectStoreSnapshot, IDBObjectStoreWithEntries, IDBIndexSnapshot, CustomDataSingletonInternalKey, CustomDataSingletonInternalValues, CustomData, CustomUserEvent, SessionContext, ExpiringImage, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
9
+ export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, SerializedIDBValidKey, IDBObjectStoreMetadata, IDBObjectStoreSnapshot, IDBObjectStoreWithEntries, IDBIndexSnapshot, CustomDataSingletonInternalKey, CustomDataSingletonInternalValues, CustomData, CustomUserEvent, SessionContext, ExpiringImage, CustomRecordingType, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
10
10
  export { SequenceNumber, WebSocketConnectionData, WebSocketConnectionEvent, WebSocketConnectionCreatedEvent, WebSocketConnectionOpenedEvent, EncodedArrayBuffer, EncodedBlob, WebSocketConnectionMessageEvent, WebSocketConnectionErrorEvent, WebSocketConnectionClosedEvent, } from "./sdk-bundle-api/sdk-to-bundle/websocket-data";
11
11
  export * from "./sdk-bundle-api/sdk-to-bundle/event-source-data";
12
12
  export { Replay } from "./replay/replay.types";
@@ -18,3 +18,4 @@ export { ConsoleErrorDivergenceIndicator, Divergence, DivergenceConsoleError, Di
18
18
  export { AssetUploadMetadata } from "./sdk-bundle-api/sdk-to-bundle/asset-upload-metadata";
19
19
  export { S3Location } from "./s3.types";
20
20
  export { CompanionAssetsInfo } from "./sdk-bundle-api/sdk-to-bundle/companion-assets";
21
+ export { DeploymentArchiveType } from "./sdk-bundle-api/sdk-to-bundle/deployment-archive-type";
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAsBA,0DASiC;AAR/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AASrB,sFAAoE;AAQpE,4EAmBqD;AANnD,8HAAA,8BAA8B,OAAA;AAmBhC,mFAAiE"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAsBA,0DASiC;AAR/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AASrB,sFAAoE;AAQpE,4EAoBqD;AAPnD,8HAAA,8BAA8B,OAAA;AAoBhC,mFAAiE"}
@@ -1,3 +1,4 @@
1
+ import { DeploymentArchiveType } from "./deployment-archive-type";
1
2
  /**
2
3
  * Information about companion assets to serve _together_ with a deployment. Note this
3
4
  * is distinct from a static assets deployment, which is _just_ static assets.
@@ -11,4 +12,8 @@ export interface CompanionAssetsInfo {
11
12
  * A regex to match to determine if a path should be served from the companion assets.
12
13
  */
13
14
  regex: string;
15
+ /**
16
+ * File format of the companion asset bundle
17
+ */
18
+ archiveType: DeploymentArchiveType;
14
19
  }
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Type of asset bundle used for static and companion asset deployments.
3
+ *
4
+ * zip: regular zip file.
5
+ *
6
+ * tar.d: tarball, further compressed using the (raw) deflate algorithm.
7
+ * this nonstandard format was chosen because it achieved the best
8
+ * benchmark results for round-robbin compression -> upload ->
9
+ * download -> decompression.
10
+ */
11
+ export type DeploymentArchiveType = "zip" | "tar.d";
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=deployment-archive-type.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"deployment-archive-type.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/sdk-to-bundle/deployment-archive-type.ts"],"names":[],"mappings":""}
@@ -259,12 +259,13 @@ export declare enum CustomDataSingletonInternalKey {
259
259
  */
260
260
  CustomObjectTooLargeToSerialize = "met-custom-object-too-large-to-serialize"
261
261
  }
262
+ export type CustomRecordingType = "context" | "feature-flag" | "user-id" | "user-email" | "singleton" | "array" | "event" | "initial-navigation-response";
262
263
  export type CustomDataSingletonInternalValues = {
263
264
  [CustomDataSingletonInternalKey.SystemThemePreferredColor]: "light" | "dark";
264
265
  [CustomDataSingletonInternalKey.TimezoneName]: string;
265
266
  [CustomDataSingletonInternalKey.Languages]: string;
266
267
  [CustomDataSingletonInternalKey.UserAgent]: string;
267
- [CustomDataSingletonInternalKey.CustomObjectTooLargeToSerialize]: "singleton" | "array" | "event" | "context" | "feature-flag" | "user-id" | "user-email";
268
+ [CustomDataSingletonInternalKey.CustomObjectTooLargeToSerialize]: CustomRecordingType;
268
269
  };
269
270
  export type CustomData = {
270
271
  singletons: Record<string, string> & Partial<CustomDataSingletonInternalValues>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwaysmeticulous/api",
3
- "version": "2.250.7",
3
+ "version": "2.251.1",
4
4
  "description": "Meticulous API types",
5
5
  "license": "ISC",
6
6
  "main": "dist/index.js",
@@ -35,5 +35,5 @@
35
35
  "bugs": {
36
36
  "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
37
37
  },
38
- "gitHead": "9fdfef4b81ed91886c55ac32b87f40274565b84f"
38
+ "gitHead": "a8bf35cabc83fc249b92e5cd91d1522325333b29"
39
39
  }