@disconnectme/lightbox-sdk 0.1.0 → 0.1.2

package/dist/index.cjs

@@ -100,7 +100,7 @@ var LightboxClient = class {
    */
   apps = {
     /**
-     * Search for iOS apps by framework, permission, genre, developer, name, or bundle.
+     * Search for iOS apps by framework, entitlement, usage_key, genre, developer, name, or bundle.
      * Requires at least one filter parameter.
      */
     search: (params) => {
@@ -109,7 +109,7 @@ var LightboxClient = class {
     /**
      * Get detailed profile for a specific app bundle.
      * Use `version` param to get a specific version, defaults to latest.
-     * Use `include` to specify which fields to include (frameworks, permissions, privacy, urls, files, all).
+     * Use `include` to specify which fields to include (frameworks, entitlements, privacy, urls, files, all).
      */
     get: (bundle, params) => {
       const queryParams = {};
@@ -161,15 +161,60 @@ var LightboxClient = class {
         return this.request("/v1/apps/ios/metadata/frameworks", params);
       },
       /**
-       * Get available permissions (iOS entitlements) with app counts.
+       * Get available iOS entitlements with app counts.
        * Supports pagination and search.
-       * @param params.search - Filter by permission key (case-insensitive contains)
+       * @param params.search - Filter by entitlement key (case-insensitive contains)
        * @param params.sort - Sort by 'popularity' (default) or 'name'
        * @param params.limit - Results per page (default 100, max 1000)
        * @param params.offset - Pagination offset
        */
-      permissions: (params) => {
-        return this.request("/v1/apps/ios/metadata/permissions", params);
+      entitlements: (params) => {
+        return this.request("/v1/apps/ios/metadata/entitlements", params);
+      }
+    }
+  };
+  /**
+   * 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
+        );
       }
     }
   };

package/dist/index.d.cts

@@ -77,7 +77,10 @@ interface AppSummary {
     rating: number | null;
     app_store_url: string | null;
     frameworks: string[];
-    permissions: string[];
+    entitlements: string[];
+    icon: string | null;
+    size: number | null;
+    min_os_version: string | null;
     created_at: string;
 }
 interface AppProfile {
@@ -90,9 +93,14 @@ interface AppProfile {
     review_count: number | null;
     rating: number | null;
     app_store_url: string | null;
+    icon: string | null;
+    size: number | null;
+    min_os_version: string | null;
+    screenshots: string[];
+    usage_descriptions: Record<string, string>;
     created_at: string;
     frameworks?: string[];
-    permissions?: string[];
+    entitlements?: string[];
     privacy?: unknown[];
     urls?: unknown[];
     files?: unknown[];
@@ -143,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;
@@ -159,7 +203,8 @@ interface FileSearchParams extends PaginationParams {
 }
 interface AppSearchParams extends PaginationParams {
     framework?: string;
-    permission?: string;
+    entitlement?: string;
+    usage_key?: string;
     genre?: string;
     developer?: string;
     name?: string;
@@ -177,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;
@@ -185,7 +258,7 @@ interface FrameworkItem {
     name: string;
     app_count: number;
 }
-interface PermissionItem {
+interface EntitlementItem {
     key: string;
     app_count: number;
 }
@@ -199,10 +272,10 @@ interface FrameworkListData {
     total: number;
     frameworks: FrameworkItem[];
 }
-interface PermissionListData {
-    type: "permission_list";
+interface EntitlementListData {
+    type: "entitlement_list";
     total: number;
-    permissions: PermissionItem[];
+    entitlements: EntitlementItem[];
 }
 interface MetadataSearchParams extends PaginationParams {
     search?: string;
@@ -216,7 +289,9 @@ type AppVersionsResponse = APIResponse<AppVersionsData>;
 type AppFilesResponse = APIResponse<AppFilesData>;
 type GenreListResponse = APIResponse<GenreListData>;
 type FrameworkListResponse = APIResponse<FrameworkListData>;
-type PermissionListResponse = APIResponse<PermissionListData>;
+type EntitlementListResponse = APIResponse<EntitlementListData>;
+type WebRequestCollectionResponse = APIResponse<WebRequestCollectionData>;
+type WebCookieCollectionResponse = APIResponse<WebCookieCollectionData>;
 
 interface LightboxClientConfig {
     apiKey: string;
@@ -255,14 +330,14 @@ declare class LightboxClient {
      */
     apps: {
         /**
-         * Search for iOS apps by framework, permission, genre, developer, name, or bundle.
+         * Search for iOS apps by framework, entitlement, usage_key, genre, developer, name, or bundle.
          * Requires at least one filter parameter.
          */
         search: (params: AppSearchParams) => Promise<AppSearchResponse>;
         /**
          * Get detailed profile for a specific app bundle.
          * Use `version` param to get a specific version, defaults to latest.
-         * Use `include` to specify which fields to include (frameworks, permissions, privacy, urls, files, all).
+         * Use `include` to specify which fields to include (frameworks, entitlements, privacy, urls, files, all).
          */
         get: (bundle: string, params?: AppGetParams) => Promise<AppProfileResponse>;
         /**
@@ -292,16 +367,41 @@ declare class LightboxClient {
              */
             frameworks: (params?: MetadataSearchParams) => Promise<FrameworkListResponse>;
             /**
-             * Get available permissions (iOS entitlements) with app counts.
+             * Get available iOS entitlements with app counts.
              * Supports pagination and search.
-             * @param params.search - Filter by permission key (case-insensitive contains)
+             * @param params.search - Filter by entitlement key (case-insensitive contains)
              * @param params.sort - Sort by 'popularity' (default) or 'name'
              * @param params.limit - Results per page (default 100, max 1000)
              * @param params.offset - Pagination offset
              */
-            permissions: (params?: MetadataSearchParams) => Promise<PermissionListResponse>;
+            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 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 PermissionItem, type PermissionListData, type PermissionListResponse };
+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

@@ -77,7 +77,10 @@ interface AppSummary {
     rating: number | null;
     app_store_url: string | null;
     frameworks: string[];
-    permissions: string[];
+    entitlements: string[];
+    icon: string | null;
+    size: number | null;
+    min_os_version: string | null;
     created_at: string;
 }
 interface AppProfile {
@@ -90,9 +93,14 @@ interface AppProfile {
     review_count: number | null;
     rating: number | null;
     app_store_url: string | null;
+    icon: string | null;
+    size: number | null;
+    min_os_version: string | null;
+    screenshots: string[];
+    usage_descriptions: Record<string, string>;
     created_at: string;
     frameworks?: string[];
-    permissions?: string[];
+    entitlements?: string[];
     privacy?: unknown[];
     urls?: unknown[];
     files?: unknown[];
@@ -143,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;
@@ -159,7 +203,8 @@ interface FileSearchParams extends PaginationParams {
 }
 interface AppSearchParams extends PaginationParams {
     framework?: string;
-    permission?: string;
+    entitlement?: string;
+    usage_key?: string;
     genre?: string;
     developer?: string;
     name?: string;
@@ -177,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;
@@ -185,7 +258,7 @@ interface FrameworkItem {
     name: string;
     app_count: number;
 }
-interface PermissionItem {
+interface EntitlementItem {
     key: string;
     app_count: number;
 }
@@ -199,10 +272,10 @@ interface FrameworkListData {
     total: number;
     frameworks: FrameworkItem[];
 }
-interface PermissionListData {
-    type: "permission_list";
+interface EntitlementListData {
+    type: "entitlement_list";
     total: number;
-    permissions: PermissionItem[];
+    entitlements: EntitlementItem[];
 }
 interface MetadataSearchParams extends PaginationParams {
     search?: string;
@@ -216,7 +289,9 @@ type AppVersionsResponse = APIResponse<AppVersionsData>;
 type AppFilesResponse = APIResponse<AppFilesData>;
 type GenreListResponse = APIResponse<GenreListData>;
 type FrameworkListResponse = APIResponse<FrameworkListData>;
-type PermissionListResponse = APIResponse<PermissionListData>;
+type EntitlementListResponse = APIResponse<EntitlementListData>;
+type WebRequestCollectionResponse = APIResponse<WebRequestCollectionData>;
+type WebCookieCollectionResponse = APIResponse<WebCookieCollectionData>;
 
 interface LightboxClientConfig {
     apiKey: string;
@@ -255,14 +330,14 @@ declare class LightboxClient {
      */
     apps: {
         /**
-         * Search for iOS apps by framework, permission, genre, developer, name, or bundle.
+         * Search for iOS apps by framework, entitlement, usage_key, genre, developer, name, or bundle.
          * Requires at least one filter parameter.
          */
         search: (params: AppSearchParams) => Promise<AppSearchResponse>;
         /**
          * Get detailed profile for a specific app bundle.
          * Use `version` param to get a specific version, defaults to latest.
-         * Use `include` to specify which fields to include (frameworks, permissions, privacy, urls, files, all).
+         * Use `include` to specify which fields to include (frameworks, entitlements, privacy, urls, files, all).
          */
         get: (bundle: string, params?: AppGetParams) => Promise<AppProfileResponse>;
         /**
@@ -292,16 +367,41 @@ declare class LightboxClient {
              */
             frameworks: (params?: MetadataSearchParams) => Promise<FrameworkListResponse>;
             /**
-             * Get available permissions (iOS entitlements) with app counts.
+             * Get available iOS entitlements with app counts.
              * Supports pagination and search.
-             * @param params.search - Filter by permission key (case-insensitive contains)
+             * @param params.search - Filter by entitlement key (case-insensitive contains)
              * @param params.sort - Sort by 'popularity' (default) or 'name'
              * @param params.limit - Results per page (default 100, max 1000)
              * @param params.offset - Pagination offset
              */
-            permissions: (params?: MetadataSearchParams) => Promise<PermissionListResponse>;
+            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 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 PermissionItem, type PermissionListData, type PermissionListResponse };
+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

@@ -73,7 +73,7 @@ var LightboxClient = class {
    */
   apps = {
     /**
-     * Search for iOS apps by framework, permission, genre, developer, name, or bundle.
+     * Search for iOS apps by framework, entitlement, usage_key, genre, developer, name, or bundle.
      * Requires at least one filter parameter.
      */
     search: (params) => {
@@ -82,7 +82,7 @@ var LightboxClient = class {
     /**
      * Get detailed profile for a specific app bundle.
      * Use `version` param to get a specific version, defaults to latest.
-     * Use `include` to specify which fields to include (frameworks, permissions, privacy, urls, files, all).
+     * Use `include` to specify which fields to include (frameworks, entitlements, privacy, urls, files, all).
      */
     get: (bundle, params) => {
       const queryParams = {};
@@ -134,15 +134,60 @@ var LightboxClient = class {
         return this.request("/v1/apps/ios/metadata/frameworks", params);
       },
       /**
-       * Get available permissions (iOS entitlements) with app counts.
+       * Get available iOS entitlements with app counts.
        * Supports pagination and search.
-       * @param params.search - Filter by permission key (case-insensitive contains)
+       * @param params.search - Filter by entitlement key (case-insensitive contains)
        * @param params.sort - Sort by 'popularity' (default) or 'name'
        * @param params.limit - Results per page (default 100, max 1000)
        * @param params.offset - Pagination offset
        */
-      permissions: (params) => {
-        return this.request("/v1/apps/ios/metadata/permissions", params);
+      entitlements: (params) => {
+        return this.request("/v1/apps/ios/metadata/entitlements", params);
+      }
+    }
+  };
+  /**
+   * 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
+        );
       }
     }
   };

package/package.json

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