@bisibility/sdk 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +20 -0
- package/LICENSE +661 -0
- package/README.md +222 -0
- package/dist/client.d.ts +89 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +614 -0
- package/dist/client.js.map +1 -0
- package/dist/errors.d.ts +46 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +70 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -0
- package/dist/types.d.ts +793 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/package.json +73 -0
package/dist/errors.d.ts
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { ProblemDetails } from "./types.js";
|
|
2
|
+
export interface BisibilityApiErrorOptions {
|
|
3
|
+
body: string | undefined;
|
|
4
|
+
headers: Headers;
|
|
5
|
+
method: string;
|
|
6
|
+
problem: ProblemDetails | undefined;
|
|
7
|
+
status: number;
|
|
8
|
+
url: string;
|
|
9
|
+
}
|
|
10
|
+
export declare class BisibilityApiError extends Error {
|
|
11
|
+
readonly body: string | undefined;
|
|
12
|
+
readonly headers: Headers;
|
|
13
|
+
readonly method: string;
|
|
14
|
+
readonly problem: ProblemDetails | undefined;
|
|
15
|
+
readonly status: number;
|
|
16
|
+
readonly url: string;
|
|
17
|
+
constructor(message: string, options: BisibilityApiErrorOptions);
|
|
18
|
+
}
|
|
19
|
+
export declare class BisibilityConfigurationError extends Error {
|
|
20
|
+
constructor(message: string);
|
|
21
|
+
}
|
|
22
|
+
export declare class BisibilityNetworkError extends Error {
|
|
23
|
+
readonly cause: unknown;
|
|
24
|
+
readonly method: string;
|
|
25
|
+
readonly url: string;
|
|
26
|
+
constructor(message: string, options: {
|
|
27
|
+
cause: unknown;
|
|
28
|
+
method: string;
|
|
29
|
+
url: string;
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
export declare class BisibilityResponseError extends Error {
|
|
33
|
+
readonly body: string;
|
|
34
|
+
readonly cause: unknown;
|
|
35
|
+
readonly method: string;
|
|
36
|
+
readonly status: number;
|
|
37
|
+
readonly url: string;
|
|
38
|
+
constructor(message: string, options: {
|
|
39
|
+
body: string;
|
|
40
|
+
cause: unknown;
|
|
41
|
+
method: string;
|
|
42
|
+
status: number;
|
|
43
|
+
url: string;
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,cAAc,GAAG,SAAS,CAAC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb;AAqBD,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,CAAC;IAC7C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;gBAET,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAyB;CAUhE;AAED,qBAAa,4BAA6B,SAAQ,KAAK;gBACzC,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;gBAET,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE;CAOtF;AAED,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;gBAGnB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE;CAUzF"}
|
package/dist/errors.js
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
const SENSITIVE_RESPONSE_HEADERS = new Set([
|
|
2
|
+
"authorization",
|
|
3
|
+
"cookie",
|
|
4
|
+
"proxy-authorization",
|
|
5
|
+
"set-cookie",
|
|
6
|
+
"x-api-key",
|
|
7
|
+
"x-auth-token",
|
|
8
|
+
]);
|
|
9
|
+
function safeResponseHeaders(headers) {
|
|
10
|
+
const safeHeaders = new Headers();
|
|
11
|
+
for (const [name, value] of headers) {
|
|
12
|
+
if (!SENSITIVE_RESPONSE_HEADERS.has(name.toLowerCase())) {
|
|
13
|
+
safeHeaders.append(name, value);
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
return safeHeaders;
|
|
17
|
+
}
|
|
18
|
+
export class BisibilityApiError extends Error {
|
|
19
|
+
body;
|
|
20
|
+
headers;
|
|
21
|
+
method;
|
|
22
|
+
problem;
|
|
23
|
+
status;
|
|
24
|
+
url;
|
|
25
|
+
constructor(message, options) {
|
|
26
|
+
super(message);
|
|
27
|
+
this.name = "BisibilityApiError";
|
|
28
|
+
this.body = options.body;
|
|
29
|
+
this.headers = safeResponseHeaders(options.headers);
|
|
30
|
+
this.method = options.method;
|
|
31
|
+
this.problem = options.problem;
|
|
32
|
+
this.status = options.status;
|
|
33
|
+
this.url = options.url;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
export class BisibilityConfigurationError extends Error {
|
|
37
|
+
constructor(message) {
|
|
38
|
+
super(message);
|
|
39
|
+
this.name = "BisibilityConfigurationError";
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
export class BisibilityNetworkError extends Error {
|
|
43
|
+
cause;
|
|
44
|
+
method;
|
|
45
|
+
url;
|
|
46
|
+
constructor(message, options) {
|
|
47
|
+
super(message, { cause: options.cause });
|
|
48
|
+
this.name = "BisibilityNetworkError";
|
|
49
|
+
this.cause = options.cause;
|
|
50
|
+
this.method = options.method;
|
|
51
|
+
this.url = options.url;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
export class BisibilityResponseError extends Error {
|
|
55
|
+
body;
|
|
56
|
+
cause;
|
|
57
|
+
method;
|
|
58
|
+
status;
|
|
59
|
+
url;
|
|
60
|
+
constructor(message, options) {
|
|
61
|
+
super(message, { cause: options.cause });
|
|
62
|
+
this.name = "BisibilityResponseError";
|
|
63
|
+
this.body = options.body;
|
|
64
|
+
this.cause = options.cause;
|
|
65
|
+
this.method = options.method;
|
|
66
|
+
this.status = options.status;
|
|
67
|
+
this.url = options.url;
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
//# sourceMappingURL=errors.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAWA,MAAM,0BAA0B,GAAG,IAAI,GAAG,CAAC;IACzC,eAAe;IACf,QAAQ;IACR,qBAAqB;IACrB,YAAY;IACZ,WAAW;IACX,cAAc;CACf,CAAC,CAAC;AAEH,SAAS,mBAAmB,CAAC,OAAgB;IAC3C,MAAM,WAAW,GAAG,IAAI,OAAO,EAAE,CAAC;IAClC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;QACpC,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YACxD,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAClC,IAAI,CAAqB;IACzB,OAAO,CAAU;IACjB,MAAM,CAAS;IACf,OAAO,CAA6B;IACpC,MAAM,CAAS;IACf,GAAG,CAAS;IAErB,YAAY,OAAe,EAAE,OAAkC;QAC7D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACzB,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,KAAK;IACrD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IACtC,KAAK,CAAU;IACf,MAAM,CAAS;IACf,GAAG,CAAS;IAErB,YAAY,OAAe,EAAE,OAAwD;QACnF,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACzB,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IACvC,IAAI,CAAS;IACb,KAAK,CAAU;IACf,MAAM,CAAS;IACf,MAAM,CAAS;IACf,GAAG,CAAS;IAErB,YACE,OAAe,EACf,OAAsF;QAEtF,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACzB,CAAC;CACF"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { BisibilityClient, createBisibilityClient } from "./client.js";
|
|
2
|
+
export { BisibilityApiError, BisibilityConfigurationError, BisibilityNetworkError, BisibilityResponseError, } from "./errors.js";
|
|
3
|
+
export type { ActiveMigrationToken, AddCompetitorInput, AlertChannel, AlertConditionType, AlertRule, AlertRuleInput, AlertRuleTarget, AlertSeverity, AlertTargetType, ApiKey, BisibilityClientConfig, Capability, CloudImportJob, CloudImportState, Competitor, CompetitorColumn, CompetitorKind, CompetitorListMeta, CompetitorListResponse, CompetitorMarket, CompetitorShare, ConnectProviderInput, CostEstimate, CostEstimateBase, CostEstimateFrequency, CreateAlertRuleInput, CreatedApiKey, CreatedPersonalAccessToken, CreatedTeamInvite, CreateKeywordInput, CreateKeywordItem, CreateKeywordResult, CreateKeywordsInput, CreateKeywordsResponse, CreateMyTokenInput, CreateProjectInput, CreateSavedViewInput, CreateSignalInput, CreateSignalSource, CreateTeamInviteInput, CreateWebhookInput, DataResponse, DeleteAlertRuleResponse, DeleteSavedViewResponse, Device, FetchLike, FlatCostEstimate, FlatProviderRate, GetCostEstimateOptions, HeadToHeadRow, HealthResponse, IssuedMigrationToken, JsonObject, Keyword, KeywordBulkInput, KeywordBulkItemResult, KeywordBulkOperation, KeywordBulkResponse, KeywordSchedule, KeywordScheduleInput, ListKeywordsOptions, ListMeta, ListRankChecksOptions, ListResponse, ListSignalsOptions, Me, MembershipRole, MeProject, MigrationScope, MigrationTokenListMeta, MigrationTokenListResponse, MintMigrationTokenInput, NotificationPreferences, OpenApiDocument, PaginationOptions, PersonalAccessToken, PersonalAccessTokenScope, PlanCostEstimate, PlanProviderRate, PricingModel, ProblemDetails, Project, ProjectDefaults, ProjectDefaultsPatch, ProjectWriteMode, Provider, ProviderConnection, ProviderCredentialField, ProviderCredentialsInput, ProviderDisconnectResponse, ProviderDrawer, ProviderDrawerDefaults, ProviderIconName, ProviderId, ProviderKind, ProviderMetaRow, ProviderRate, ProviderRateBase, ProviderRateOption, ProviderRatePlan, ProviderSettingsInput, ProviderStatus, ProviderTestResult, RankCheck, RankCheckAttempt, RankCheckFrequency, RankCheckStatus, RemoveCompetitorResponse, RequestHeaders, RequestOptions, RevokedMigrationToken, RevokedTeamInvite, RunRankCheckInput, RunRankCheckOptions, SavedView, SavedViewConfig, SavedViewFilterChange, SavedViewFilterCountry, SavedViewFilterDevice, SavedViewFilters, SavedViewPositionFilter, SavedViewSerpFilter, Signal, SignalSeverity, SignalSource, SuggestedCompetitor, TeamInvite, TeamMember, TeamRole, TeamRoleLabel, TestProviderConnectionInput, TrackingScope, TriggeredAlert, UpdateAlertRuleInput, UpdateKeywordInput, UpdateMeInput, UpdateNotificationPreferencesInput, UpdateProjectInput, UpdateWebhookInput, Webhook, } from "./types.js";
|
|
4
|
+
export { BisibilityClient as default } from "./client.js";
|
|
5
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EACL,kBAAkB,EAClB,4BAA4B,EAC5B,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,aAAa,CAAC;AACrB,YAAY,EACV,oBAAoB,EACpB,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EAClB,SAAS,EACT,cAAc,EACd,eAAe,EACf,aAAa,EACb,eAAe,EACf,MAAM,EACN,sBAAsB,EACtB,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,YAAY,EACZ,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,aAAa,EACb,0BAA0B,EAC1B,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,kBAAkB,EAClB,YAAY,EACZ,uBAAuB,EACvB,uBAAuB,EACvB,MAAM,EACN,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,aAAa,EACb,cAAc,EACd,oBAAoB,EACpB,UAAU,EACV,OAAO,EACP,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,mBAAmB,EACnB,QAAQ,EACR,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,EAAE,EACF,cAAc,EACd,SAAS,EACT,cAAc,EACd,sBAAsB,EACtB,0BAA0B,EAC1B,uBAAuB,EACvB,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,cAAc,EACd,sBAAsB,EACtB,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,SAAS,EACT,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,wBAAwB,EACxB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,SAAS,EACT,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,mBAAmB,EACnB,MAAM,EACN,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,UAAU,EACV,QAAQ,EACR,aAAa,EACb,2BAA2B,EAC3B,aAAa,EACb,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,aAAa,EACb,kCAAkC,EAClC,kBAAkB,EAClB,kBAAkB,EAClB,OAAO,GACR,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { BisibilityClient, createBisibilityClient } from "./client.js";
|
|
2
|
+
export { BisibilityApiError, BisibilityConfigurationError, BisibilityNetworkError, BisibilityResponseError, } from "./errors.js";
|
|
3
|
+
export { BisibilityClient as default } from "./client.js";
|
|
4
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EACL,kBAAkB,EAClB,4BAA4B,EAC5B,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,aAAa,CAAC;AAgJrB,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC"}
|