wip

Author: silesky

.changeset/heavy-taxis-suffer.md

@@ -1,7 +1,7 @@
 ---
 '@segment/analytics-next': minor
 ---
-Add new `additionalHeaders` setting, along with `fetchPriority`.
+Add new `headers` setting, along with `fetchPriority`.
 
 ```ts
 analytics.load("<YOUR_WRITE_KEY>",
@@ -11,7 +11,7 @@ analytics.load("<YOUR_WRITE_KEY>",
         deliveryStrategy: {
           strategy: "standard" // also works for 'batching'
           config: {
-            additionalHeaders: { 'x-api-key': 'foo' } or () => {...}
+            headers: { 'x-api-key': 'foo' } or () => {...}
             fetchPriority: 'low' | 'high', // new setting
           },
         },

packages/browser/src/plugins/segmentio/__tests__/index.test.ts

@@ -65,7 +65,7 @@ describe('Segment.io', () => {
     })
   })
 
-  describe('configuring additionalHeaders', () => {
+  describe('configuring headers', () => {
     it('should accept additional headers', async () => {
       const analytics = new Analytics({ writeKey: 'foo' })
 
@@ -74,7 +74,7 @@ describe('Segment.io', () => {
           apiKey: '',
           deliveryStrategy: {
             config: {
-              additionalHeaders: {
+              headers: {
                 'X-My-Header': 'foo',
               },
             },
@@ -96,7 +96,7 @@ describe('Segment.io', () => {
           apiKey: '',
           deliveryStrategy: {
             config: {
-              additionalHeaders: () => ({
+              headers: () => ({
                 'X-My-Header': 'foo',
               }),
             },
@@ -118,7 +118,7 @@ describe('Segment.io', () => {
           apiKey: '',
           deliveryStrategy: {
             config: {
-              additionalHeaders: () => ({
+              headers: () => ({
                 'Content-Type': 'bar',
               }),
             },

packages/browser/src/plugins/segmentio/batched-dispatcher.ts

@@ -78,7 +78,7 @@ export default function batch(
 
     return fetch(`https://${apiHost}/b`, {
       keepalive: config?.keepalive || pageUnloaded,
-      headers: createHeaders(config?.additionalHeaders),
+      headers: createHeaders(config?.headers),
       ...(config?.fetchPriority ? { priority: config?.fetchPriority } : {}),
       method: 'post',
       body: JSON.stringify({

packages/browser/src/plugins/segmentio/fetch-dispatcher.ts

@@ -9,7 +9,7 @@ export default function (config?: StandardDispatcherConfig): {
   function dispatch(url: string, body: object): Promise<unknown> {
     return fetch(url, {
       keepalive: config?.keepalive,
-      headers: createHeaders(config?.additionalHeaders),
+      headers: createHeaders(config?.headers),
       method: 'post',
       body: JSON.stringify(body),
       ...(config?.fetchPriority ? { priority: config?.fetchPriority } : {}),

packages/browser/src/plugins/segmentio/shared-dispatcher.ts

@@ -34,7 +34,7 @@ interface DispatchConfig {
    * If a function is provided, it will be called before each request.
    * @example { 'Content-Type': 'application/json' } or () => { 'Content-Type': 'application/json' }
    */
-  additionalHeaders?: AdditionalHeaders
+  headers?: AdditionalHeaders
   /**
    * 'Fetch Priority' of the request (chrome-only).
    */