Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
},
"license": "Apache-2.0",
"main": "./index",
"typings": "./types/index.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/openstf/adbkit-apkreader.git"
Expand Down
149 changes: 149 additions & 0 deletions types/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
// Type definitions for adbkit-apkreader 3.1.0
/// <reference types='node' />

import fs = require('fs');

type activity = {
name: string,
label?: string|undefined,
theme?: string|undefined,
configChanges?: number|undefined,
screenOrientation?: number|undefined,
launchMode?: number|undefined,
windowSoftInputMode?: number|undefined,
hardwareAccelerated?: boolean|undefined,
exported?: boolean|undefined,
excludeFromRecents?: boolean|undefined,
intentFilters?: Array<{
actions: {name: string},
categories: {name: string},
data: Array<any>,
[key: string]: any,
}>|undefined,
metaData?: Array<{
name: string,
value: boolean,
}>|undefined,
[key: string]: any,
}

type manifest = {
versionCode: number,
versionName: string,
compileSdkVersion?: number|undefined,
compileSdkVersionCodename?: string|undefined,
installLocation?: number|undefined,
package: string,
platformBuildVersionCode?: number|undefined,
platformBuildVersionName?: string|undefined,
usesPermissions: Array<{name: string, maxSdkVersion?: number|undefined}>,
permissions: Array<{name: string, protectionLevel: number}>,
permissionTrees: Array<any>,
permissionGroups: Array<any>,
instrumentation: any|null,
usesSdk: { minSdkVersion: number, targetSdkVersion: number },
usesConfiguration: any|null,
usesFeatures: Array<{name?: string|undefined, required?: boolean|undefined, glEsVersion?: number|undefined}>,
supportsScreens: {
anyDensity?: boolean|undefined,
smallScreens?: boolean|undefined,
normalScreens?: boolean|undefined,
largeScreens?: boolean|undefined,
xlargeScreens?: boolean|undefined,
[key: string]: boolean|undefined,
} | null,
compatibleScreens: Array<{ screenSize: number, screenDensity: number }>,
supportsGlTextures: Array<any>,
application: {
theme?: string|undefined,
label?: string|undefined,
icon?: string|undefined,
roundIcon?: string|undefined,
name?: string|undefined,
banner?: string|undefined,
screenOrientation?: number|undefined,
debuggable?: boolean|undefined,
allowBackup?: boolean|undefined,
usesCleartextTraffic?: boolean|undefined,
supportsRtl?: boolean|undefined,
isGame?: boolean|undefined,
activities: activity[],
activityAliases: Array<any>,
launcherActivities: activity[],
services: Array<{
name: string,
enabled?: boolean|string|undefined,
exported?: boolean|undefined,
permission?: string|undefined,
intentFilters?: Array<{
actions: {name: string},
categories: {name: string},
data: Array<any>,
[key: string]: any,
}>|undefined,
metaData?: Array<any>,
[key: string]: any,
}>|undefined,
receivers: Array<{
name: string,
enabled?: boolean|string|undefined,
exported?: boolean|undefined,
permission?: string|undefined,
intentFilters?: Array<{
actions: {name: string},
categories: {name: string},
data: Array<any>,
[key: string]: any,
}>|undefined,
metaData?: Array<any>,
[key: string]: any,
}>|undefined,
providers: Array<{
name: string,
enabled?: boolean|string|undefined,
exported?: boolean|undefined,
authorities?: string|undefined,
initOrder?: number|undefined,
grantUriPermissions?: Array<any>|undefined,
metaData?: Array<any>|undefined,
pathPermissions?: Array<any>|undefined,
[key: string]: any,
}>,
usesLibraries: Array<{ name: string, required: boolean }>,
[key: string]: any,
},
}

type attribute = {
namespaceURI: string|null,
nodeType: number,
nodeName: string,
name: string,
value: string|null,
typedValue: {
valeu: string|number,
type: string,
rawType: number,
}
}

type xmlNode = {
namespaceURI: string|null,
nodeType: number,
nodeName: string,
attributes: Array<attribute>,
childNodes: Array<xmlNode>,
}


declare class ApkReader {
public static MANIFEST(): 'AndroidManifest.xml';
public static open(apk: string): Promise<ApkReader>;

public readContent(path: string): Promise<Buffer>;
public readManifest(options?: {debug: boolean}): Promise<manifest>;
public readXml(path: string, options?: {debug: boolean}): Promise<xmlNode>;
public usingFileStream<T>(path: string, action: (stream: fs.ReadStream) => Promise<T> ): Promise<T>;
}

export = ApkReader;