@disconnectme/lightbox-sdk 0.1.1 → 0.1.2

package/dist/index.cjs

@@ -173,6 +173,51 @@ var LightboxClient = class {
       }
     }
   };
+  /**
+   * Web traffic API methods
+   */
+  web = {
+    sites: {
+      /**
+       * Get HTTP requests observed when visiting a specific site.
+       */
+      requests: (site, params) => {
+        return this.request(
+          `/v1/web/sites/${encodeURIComponent(site)}/requests`,
+          params
+        );
+      },
+      /**
+       * Get cookies observed when visiting a specific site.
+       */
+      cookies: (site, params) => {
+        return this.request(
+          `/v1/web/sites/${encodeURIComponent(site)}/cookies`,
+          params
+        );
+      }
+    },
+    domains: {
+      /**
+       * Get HTTP requests made to a specific destination domain.
+       */
+      requests: (domain, params) => {
+        return this.request(
+          `/v1/web/domains/${encodeURIComponent(domain)}/requests`,
+          params
+        );
+      },
+      /**
+       * Get cookies set by a specific domain.
+       */
+      cookies: (domain, params) => {
+        return this.request(
+          `/v1/web/domains/${encodeURIComponent(domain)}/cookies`,
+          params
+        );
+      }
+    }
+  };
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.d.cts

@@ -151,6 +151,42 @@ interface AppFilesData {
     };
     files: AppFile[];
 }
+type ScopeMode = "auto" | "root" | "host";
+interface WebRequest {
+    id: string;
+    site_etld1: string;
+    request_etld1: string;
+    url: string;
+    method: string;
+    resource_type: string | null;
+    timestamp: string;
+    is_third_party: boolean;
+}
+interface WebRequestCollectionData {
+    type: "http_request_collection";
+    summary: {
+        returned: number;
+    };
+    requests: WebRequest[];
+}
+interface WebCookie {
+    id: string;
+    site_etld1: string;
+    cookie_etld1: string;
+    name: string;
+    value?: string | null;
+    is_secure: boolean;
+    is_http_only: boolean;
+    same_site?: string | null;
+    timestamp: string;
+}
+interface WebCookieCollectionData {
+    type: "cookie_collection";
+    summary: {
+        returned: number;
+    };
+    cookies: WebCookie[];
+}
 interface PaginationParams {
     limit?: number;
     offset?: number;
@@ -186,6 +222,34 @@ interface AppFilesParams extends PaginationParams {
     min_size?: number;
     max_size?: number;
 }
+interface WebSiteRequestsParams extends PaginationParams {
+    site_scope?: ScopeMode;
+    request_domain?: string;
+    domain_scope?: ScopeMode;
+    resource_type?: string[];
+    method?: string[];
+    third_party_only?: boolean;
+    first_party_only?: boolean;
+}
+interface WebDomainRequestsParams extends PaginationParams {
+    domain_scope?: ScopeMode;
+    site?: string;
+    site_scope?: ScopeMode;
+    resource_type?: string[];
+    method?: string[];
+}
+interface WebSiteCookiesParams extends PaginationParams {
+    site_scope?: ScopeMode;
+    cookie_domain?: string;
+    domain_scope?: ScopeMode;
+    include?: string[];
+}
+interface WebDomainCookiesParams extends PaginationParams {
+    domain_scope?: ScopeMode;
+    site?: string;
+    site_scope?: ScopeMode;
+    include?: string[];
+}
 interface GenreItem {
     name: string;
     app_count: number;
@@ -226,6 +290,8 @@ type AppFilesResponse = APIResponse<AppFilesData>;
 type GenreListResponse = APIResponse<GenreListData>;
 type FrameworkListResponse = APIResponse<FrameworkListData>;
 type EntitlementListResponse = APIResponse<EntitlementListData>;
+type WebRequestCollectionResponse = APIResponse<WebRequestCollectionData>;
+type WebCookieCollectionResponse = APIResponse<WebCookieCollectionData>;
 
 interface LightboxClientConfig {
     apiKey: string;
@@ -311,6 +377,31 @@ declare class LightboxClient {
             entitlements: (params?: MetadataSearchParams) => Promise<EntitlementListResponse>;
         };
     };
+    /**
+     * Web traffic API methods
+     */
+    web: {
+        sites: {
+            /**
+             * Get HTTP requests observed when visiting a specific site.
+             */
+            requests: (site: string, params?: WebSiteRequestsParams) => Promise<WebRequestCollectionResponse>;
+            /**
+             * Get cookies observed when visiting a specific site.
+             */
+            cookies: (site: string, params?: WebSiteCookiesParams) => Promise<WebCookieCollectionResponse>;
+        };
+        domains: {
+            /**
+             * Get HTTP requests made to a specific destination domain.
+             */
+            requests: (domain: string, params?: WebDomainRequestsParams) => Promise<WebRequestCollectionResponse>;
+            /**
+             * Get cookies set by a specific domain.
+             */
+            cookies: (domain: string, params?: WebDomainCookiesParams) => Promise<WebCookieCollectionResponse>;
+        };
+    };
 }
 
-export { type APIError, type APIMetadata, type APIResponse, type AppFile, type AppFilesData, type AppFilesParams, type AppFilesResponse, type AppGetParams, type AppProfile, type AppProfileData, type AppProfileResponse, type AppSearchData, type AppSearchParams, type AppSearchResponse, type AppSummary, type AppVersion, type AppVersionsData, type AppVersionsResponse, type EntitlementItem, type EntitlementListData, type EntitlementListResponse, type FileHashData, type FileHashResponse, type FileHashResult, type FileSearchData, type FileSearchParams, type FileSearchResponse, type FileSearchResult, type FrameworkItem, type FrameworkListData, type FrameworkListResponse, type GenreItem, type GenreListData, type GenreListResponse, LightboxClient, type LightboxClientConfig, LightboxError, type MetadataSearchParams, type Pagination, type PaginationParams };
+export { type APIError, type APIMetadata, type APIResponse, type AppFile, type AppFilesData, type AppFilesParams, type AppFilesResponse, type AppGetParams, type AppProfile, type AppProfileData, type AppProfileResponse, type AppSearchData, type AppSearchParams, type AppSearchResponse, type AppSummary, type AppVersion, type AppVersionsData, type AppVersionsResponse, type EntitlementItem, type EntitlementListData, type EntitlementListResponse, type FileHashData, type FileHashResponse, type FileHashResult, type FileSearchData, type FileSearchParams, type FileSearchResponse, type FileSearchResult, type FrameworkItem, type FrameworkListData, type FrameworkListResponse, type GenreItem, type GenreListData, type GenreListResponse, LightboxClient, type LightboxClientConfig, LightboxError, type MetadataSearchParams, type Pagination, type PaginationParams, type ScopeMode, type WebCookie, type WebCookieCollectionData, type WebCookieCollectionResponse, type WebDomainCookiesParams, type WebDomainRequestsParams, type WebRequest, type WebRequestCollectionData, type WebRequestCollectionResponse, type WebSiteCookiesParams, type WebSiteRequestsParams };

package/dist/index.d.ts

@@ -151,6 +151,42 @@ interface AppFilesData {
     };
     files: AppFile[];
 }
+type ScopeMode = "auto" | "root" | "host";
+interface WebRequest {
+    id: string;
+    site_etld1: string;
+    request_etld1: string;
+    url: string;
+    method: string;
+    resource_type: string | null;
+    timestamp: string;
+    is_third_party: boolean;
+}
+interface WebRequestCollectionData {
+    type: "http_request_collection";
+    summary: {
+        returned: number;
+    };
+    requests: WebRequest[];
+}
+interface WebCookie {
+    id: string;
+    site_etld1: string;
+    cookie_etld1: string;
+    name: string;
+    value?: string | null;
+    is_secure: boolean;
+    is_http_only: boolean;
+    same_site?: string | null;
+    timestamp: string;
+}
+interface WebCookieCollectionData {
+    type: "cookie_collection";
+    summary: {
+        returned: number;
+    };
+    cookies: WebCookie[];
+}
 interface PaginationParams {
     limit?: number;
     offset?: number;
@@ -186,6 +222,34 @@ interface AppFilesParams extends PaginationParams {
     min_size?: number;
     max_size?: number;
 }
+interface WebSiteRequestsParams extends PaginationParams {
+    site_scope?: ScopeMode;
+    request_domain?: string;
+    domain_scope?: ScopeMode;
+    resource_type?: string[];
+    method?: string[];
+    third_party_only?: boolean;
+    first_party_only?: boolean;
+}
+interface WebDomainRequestsParams extends PaginationParams {
+    domain_scope?: ScopeMode;
+    site?: string;
+    site_scope?: ScopeMode;
+    resource_type?: string[];
+    method?: string[];
+}
+interface WebSiteCookiesParams extends PaginationParams {
+    site_scope?: ScopeMode;
+    cookie_domain?: string;
+    domain_scope?: ScopeMode;
+    include?: string[];
+}
+interface WebDomainCookiesParams extends PaginationParams {
+    domain_scope?: ScopeMode;
+    site?: string;
+    site_scope?: ScopeMode;
+    include?: string[];
+}
 interface GenreItem {
     name: string;
     app_count: number;
@@ -226,6 +290,8 @@ type AppFilesResponse = APIResponse<AppFilesData>;
 type GenreListResponse = APIResponse<GenreListData>;
 type FrameworkListResponse = APIResponse<FrameworkListData>;
 type EntitlementListResponse = APIResponse<EntitlementListData>;
+type WebRequestCollectionResponse = APIResponse<WebRequestCollectionData>;
+type WebCookieCollectionResponse = APIResponse<WebCookieCollectionData>;
 
 interface LightboxClientConfig {
     apiKey: string;
@@ -311,6 +377,31 @@ declare class LightboxClient {
             entitlements: (params?: MetadataSearchParams) => Promise<EntitlementListResponse>;
         };
     };
+    /**
+     * Web traffic API methods
+     */
+    web: {
+        sites: {
+            /**
+             * Get HTTP requests observed when visiting a specific site.
+             */
+            requests: (site: string, params?: WebSiteRequestsParams) => Promise<WebRequestCollectionResponse>;
+            /**
+             * Get cookies observed when visiting a specific site.
+             */
+            cookies: (site: string, params?: WebSiteCookiesParams) => Promise<WebCookieCollectionResponse>;
+        };
+        domains: {
+            /**
+             * Get HTTP requests made to a specific destination domain.
+             */
+            requests: (domain: string, params?: WebDomainRequestsParams) => Promise<WebRequestCollectionResponse>;
+            /**
+             * Get cookies set by a specific domain.
+             */
+            cookies: (domain: string, params?: WebDomainCookiesParams) => Promise<WebCookieCollectionResponse>;
+        };
+    };
 }
 
-export { type APIError, type APIMetadata, type APIResponse, type AppFile, type AppFilesData, type AppFilesParams, type AppFilesResponse, type AppGetParams, type AppProfile, type AppProfileData, type AppProfileResponse, type AppSearchData, type AppSearchParams, type AppSearchResponse, type AppSummary, type AppVersion, type AppVersionsData, type AppVersionsResponse, type EntitlementItem, type EntitlementListData, type EntitlementListResponse, type FileHashData, type FileHashResponse, type FileHashResult, type FileSearchData, type FileSearchParams, type FileSearchResponse, type FileSearchResult, type FrameworkItem, type FrameworkListData, type FrameworkListResponse, type GenreItem, type GenreListData, type GenreListResponse, LightboxClient, type LightboxClientConfig, LightboxError, type MetadataSearchParams, type Pagination, type PaginationParams };
+export { type APIError, type APIMetadata, type APIResponse, type AppFile, type AppFilesData, type AppFilesParams, type AppFilesResponse, type AppGetParams, type AppProfile, type AppProfileData, type AppProfileResponse, type AppSearchData, type AppSearchParams, type AppSearchResponse, type AppSummary, type AppVersion, type AppVersionsData, type AppVersionsResponse, type EntitlementItem, type EntitlementListData, type EntitlementListResponse, type FileHashData, type FileHashResponse, type FileHashResult, type FileSearchData, type FileSearchParams, type FileSearchResponse, type FileSearchResult, type FrameworkItem, type FrameworkListData, type FrameworkListResponse, type GenreItem, type GenreListData, type GenreListResponse, LightboxClient, type LightboxClientConfig, LightboxError, type MetadataSearchParams, type Pagination, type PaginationParams, type ScopeMode, type WebCookie, type WebCookieCollectionData, type WebCookieCollectionResponse, type WebDomainCookiesParams, type WebDomainRequestsParams, type WebRequest, type WebRequestCollectionData, type WebRequestCollectionResponse, type WebSiteCookiesParams, type WebSiteRequestsParams };

package/dist/index.js

@@ -146,6 +146,51 @@ var LightboxClient = class {
       }
     }
   };
+  /**
+   * Web traffic API methods
+   */
+  web = {
+    sites: {
+      /**
+       * Get HTTP requests observed when visiting a specific site.
+       */
+      requests: (site, params) => {
+        return this.request(
+          `/v1/web/sites/${encodeURIComponent(site)}/requests`,
+          params
+        );
+      },
+      /**
+       * Get cookies observed when visiting a specific site.
+       */
+      cookies: (site, params) => {
+        return this.request(
+          `/v1/web/sites/${encodeURIComponent(site)}/cookies`,
+          params
+        );
+      }
+    },
+    domains: {
+      /**
+       * Get HTTP requests made to a specific destination domain.
+       */
+      requests: (domain, params) => {
+        return this.request(
+          `/v1/web/domains/${encodeURIComponent(domain)}/requests`,
+          params
+        );
+      },
+      /**
+       * Get cookies set by a specific domain.
+       */
+      cookies: (domain, params) => {
+        return this.request(
+          `/v1/web/domains/${encodeURIComponent(domain)}/cookies`,
+          params
+        );
+      }
+    }
+  };
 };
 export {
   LightboxClient,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@disconnectme/lightbox-sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "TypeScript SDK for the Lightbox Data API by Disconnect",
   "type": "module",
   "engines": {