@disconnectme/lightbox-sdk 0.1.1 → 0.1.3

package/dist/index.cjs

@@ -173,6 +173,93 @@ 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
+        );
+      }
+    },
+    /**
+     * JavaScript API symbol tracking methods
+     */
+    javascript: {
+      /**
+       * Get the catalog of all JavaScript symbols available for querying.
+       * This is a static list of browser APIs monitored during web crawls.
+       */
+      catalog: (params) => {
+        return this.request(
+          "/v1/web/javascript/symbols",
+          params
+        );
+      },
+      /**
+       * Get all scripts that access a specific JavaScript API symbol.
+       */
+      symbols: (symbol, params) => {
+        return this.request(
+          `/v1/web/javascript/symbols/${encodeURIComponent(symbol)}`,
+          params
+        );
+      },
+      /**
+       * Get JavaScript API accesses by scripts from a specific domain.
+       */
+      scripts: (domain, params) => {
+        return this.request(
+          `/v1/web/javascript/scripts/${encodeURIComponent(domain)}`,
+          params
+        );
+      },
+      /**
+       * Get JavaScript API accesses observed when visiting a specific site.
+       */
+      sites: (site, params) => {
+        return this.request(
+          `/v1/web/javascript/sites/${encodeURIComponent(site)}`,
+          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;
@@ -217,6 +281,53 @@ interface MetadataSearchParams extends PaginationParams {
     search?: string;
     sort?: "popularity" | "name";
 }
+type JavaScriptSymbolCategory = "canvas" | "audio" | "webrtc" | "navigator" | "screen" | "storage" | "cookie" | "referrer";
+interface JavaScriptSymbolCatalogItem {
+    symbol: string;
+    category: JavaScriptSymbolCategory;
+    description: string;
+}
+interface JavaScriptSymbolCatalogData {
+    type: "javascript_symbol_catalog";
+    total_symbols: number;
+    categories: string[];
+    note: string;
+    symbols: JavaScriptSymbolCatalogItem[];
+}
+interface JavaScriptSymbolObservation {
+    id: string;
+    script_etld1: string;
+    site_etld1: string;
+    script_url: string;
+    symbol: string;
+    symbol_category: string;
+    operation: string | null;
+    arguments: string | null;
+    value: string | null;
+    timestamp: string;
+}
+interface JavaScriptSymbolCollectionData {
+    type: "javascript_symbol_collection";
+    summary: {
+        returned: number;
+    };
+    symbols: JavaScriptSymbolObservation[];
+}
+interface JavaScriptCatalogParams {
+    category?: JavaScriptSymbolCategory;
+}
+interface JavaScriptSymbolParams extends PaginationParams {
+}
+interface JavaScriptScriptsParams extends PaginationParams {
+    symbol?: string;
+    category?: JavaScriptSymbolCategory;
+}
+interface JavaScriptSitesParams extends PaginationParams {
+    symbol?: string;
+    category?: JavaScriptSymbolCategory;
+}
+type JavaScriptCatalogResponse = APIResponse<JavaScriptSymbolCatalogData>;
+type JavaScriptSymbolCollectionResponse = APIResponse<JavaScriptSymbolCollectionData>;
 type FileSearchResponse = APIResponse<FileSearchData>;
 type FileHashResponse = APIResponse<FileHashData>;
 type AppSearchResponse = APIResponse<AppSearchData>;
@@ -226,6 +337,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 +424,53 @@ 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>;
+        };
+        /**
+         * JavaScript API symbol tracking methods
+         */
+        javascript: {
+            /**
+             * Get the catalog of all JavaScript symbols available for querying.
+             * This is a static list of browser APIs monitored during web crawls.
+             */
+            catalog: (params?: JavaScriptCatalogParams) => Promise<JavaScriptCatalogResponse>;
+            /**
+             * Get all scripts that access a specific JavaScript API symbol.
+             */
+            symbols: (symbol: string, params?: JavaScriptSymbolParams) => Promise<JavaScriptSymbolCollectionResponse>;
+            /**
+             * Get JavaScript API accesses by scripts from a specific domain.
+             */
+            scripts: (domain: string, params?: JavaScriptScriptsParams) => Promise<JavaScriptSymbolCollectionResponse>;
+            /**
+             * Get JavaScript API accesses observed when visiting a specific site.
+             */
+            sites: (site: string, params?: JavaScriptSitesParams) => Promise<JavaScriptSymbolCollectionResponse>;
+        };
+    };
 }
 
-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, type JavaScriptCatalogParams, type JavaScriptCatalogResponse, type JavaScriptScriptsParams, type JavaScriptSitesParams, type JavaScriptSymbolCatalogData, type JavaScriptSymbolCatalogItem, type JavaScriptSymbolCategory, type JavaScriptSymbolCollectionData, type JavaScriptSymbolCollectionResponse, type JavaScriptSymbolObservation, type JavaScriptSymbolParams, 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;
@@ -217,6 +281,53 @@ interface MetadataSearchParams extends PaginationParams {
     search?: string;
     sort?: "popularity" | "name";
 }
+type JavaScriptSymbolCategory = "canvas" | "audio" | "webrtc" | "navigator" | "screen" | "storage" | "cookie" | "referrer";
+interface JavaScriptSymbolCatalogItem {
+    symbol: string;
+    category: JavaScriptSymbolCategory;
+    description: string;
+}
+interface JavaScriptSymbolCatalogData {
+    type: "javascript_symbol_catalog";
+    total_symbols: number;
+    categories: string[];
+    note: string;
+    symbols: JavaScriptSymbolCatalogItem[];
+}
+interface JavaScriptSymbolObservation {
+    id: string;
+    script_etld1: string;
+    site_etld1: string;
+    script_url: string;
+    symbol: string;
+    symbol_category: string;
+    operation: string | null;
+    arguments: string | null;
+    value: string | null;
+    timestamp: string;
+}
+interface JavaScriptSymbolCollectionData {
+    type: "javascript_symbol_collection";
+    summary: {
+        returned: number;
+    };
+    symbols: JavaScriptSymbolObservation[];
+}
+interface JavaScriptCatalogParams {
+    category?: JavaScriptSymbolCategory;
+}
+interface JavaScriptSymbolParams extends PaginationParams {
+}
+interface JavaScriptScriptsParams extends PaginationParams {
+    symbol?: string;
+    category?: JavaScriptSymbolCategory;
+}
+interface JavaScriptSitesParams extends PaginationParams {
+    symbol?: string;
+    category?: JavaScriptSymbolCategory;
+}
+type JavaScriptCatalogResponse = APIResponse<JavaScriptSymbolCatalogData>;
+type JavaScriptSymbolCollectionResponse = APIResponse<JavaScriptSymbolCollectionData>;
 type FileSearchResponse = APIResponse<FileSearchData>;
 type FileHashResponse = APIResponse<FileHashData>;
 type AppSearchResponse = APIResponse<AppSearchData>;
@@ -226,6 +337,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 +424,53 @@ 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>;
+        };
+        /**
+         * JavaScript API symbol tracking methods
+         */
+        javascript: {
+            /**
+             * Get the catalog of all JavaScript symbols available for querying.
+             * This is a static list of browser APIs monitored during web crawls.
+             */
+            catalog: (params?: JavaScriptCatalogParams) => Promise<JavaScriptCatalogResponse>;
+            /**
+             * Get all scripts that access a specific JavaScript API symbol.
+             */
+            symbols: (symbol: string, params?: JavaScriptSymbolParams) => Promise<JavaScriptSymbolCollectionResponse>;
+            /**
+             * Get JavaScript API accesses by scripts from a specific domain.
+             */
+            scripts: (domain: string, params?: JavaScriptScriptsParams) => Promise<JavaScriptSymbolCollectionResponse>;
+            /**
+             * Get JavaScript API accesses observed when visiting a specific site.
+             */
+            sites: (site: string, params?: JavaScriptSitesParams) => Promise<JavaScriptSymbolCollectionResponse>;
+        };
+    };
 }
 
-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, type JavaScriptCatalogParams, type JavaScriptCatalogResponse, type JavaScriptScriptsParams, type JavaScriptSitesParams, type JavaScriptSymbolCatalogData, type JavaScriptSymbolCatalogItem, type JavaScriptSymbolCategory, type JavaScriptSymbolCollectionData, type JavaScriptSymbolCollectionResponse, type JavaScriptSymbolObservation, type JavaScriptSymbolParams, 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,93 @@ 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
+        );
+      }
+    },
+    /**
+     * JavaScript API symbol tracking methods
+     */
+    javascript: {
+      /**
+       * Get the catalog of all JavaScript symbols available for querying.
+       * This is a static list of browser APIs monitored during web crawls.
+       */
+      catalog: (params) => {
+        return this.request(
+          "/v1/web/javascript/symbols",
+          params
+        );
+      },
+      /**
+       * Get all scripts that access a specific JavaScript API symbol.
+       */
+      symbols: (symbol, params) => {
+        return this.request(
+          `/v1/web/javascript/symbols/${encodeURIComponent(symbol)}`,
+          params
+        );
+      },
+      /**
+       * Get JavaScript API accesses by scripts from a specific domain.
+       */
+      scripts: (domain, params) => {
+        return this.request(
+          `/v1/web/javascript/scripts/${encodeURIComponent(domain)}`,
+          params
+        );
+      },
+      /**
+       * Get JavaScript API accesses observed when visiting a specific site.
+       */
+      sites: (site, params) => {
+        return this.request(
+          `/v1/web/javascript/sites/${encodeURIComponent(site)}`,
+          params
+        );
+      }
+    }
+  };
 };
 export {
   LightboxClient,

package/package.json

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