@oxchannels/sdk 1.0.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/LICENSE +7 -0
- package/QUICKSTART.md +604 -0
- package/README.md +193 -0
- package/contracts/openapi-agent-bootstrap-contract-v2.json +1266 -0
- package/contracts/openapi-dashboard-contract-v2.json +98996 -0
- package/contracts/openapi-partner-contract-v2.json +14808 -0
- package/contracts/openapi-public-contract-v2.json +13489 -0
- package/dist/client.d.ts +83 -0
- package/dist/client.js +661 -0
- package/dist/generated/agent-bootstrap-contract-v2-schema.d.ts +398 -0
- package/dist/generated/agent-bootstrap-contract-v2-schema.js +1 -0
- package/dist/generated/client.d.ts +1 -0
- package/dist/generated/client.js +2 -0
- package/dist/generated/contracts/api-errors.d.ts +83 -0
- package/dist/generated/contracts/api-errors.js +296 -0
- package/dist/generated/contracts/json-data.d.ts +16 -0
- package/dist/generated/contracts/json-data.js +308 -0
- package/dist/generated/dashboard-contract-v2-schema.d.ts +45429 -0
- package/dist/generated/dashboard-contract-v2-schema.js +1 -0
- package/dist/generated/partner-contract-v2-schema.d.ts +6458 -0
- package/dist/generated/partner-contract-v2-schema.js +1 -0
- package/dist/generated/public-contract-v2-schema.d.ts +4112 -0
- package/dist/generated/public-contract-v2-schema.js +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +1 -0
- package/generated/provenance.json +87 -0
- package/package.json +55 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export { OXCHANNELS_CONTRACT_SET_VERSION, OxChannelsApiError, OxChannelsApiErrorV2, OxChannelsApiProtocolError, createAgentBootstrapClient, createDashboardContractClient, createDashboardV2Client, createOxStudioClient, createPartnerClient, createPublicClient, } from './client.js';
|
|
2
|
+
export type { ActiveApiErrorCode, AgentBootstrapClient, AgentBootstrapClientOptions, ApiErrorCategory, ApiErrorViolation, DashboardContractClient, DashboardV2Client, DashboardV2ClientOptions, ErrorEnvelopeV2, OxStudioClient, PartnerClient, PartnerClientOptions, PublicClient, PublicClientOptions, ProviderBindingRotationSelection, } from './client.js';
|
|
3
|
+
export type { paths as AgentBootstrapContractV2Paths } from './generated/agent-bootstrap-contract-v2-schema.js';
|
|
4
|
+
export type { paths as DashboardContractV2Paths } from './generated/dashboard-contract-v2-schema.js';
|
|
5
|
+
export type { paths as PartnerContractV2Paths } from './generated/partner-contract-v2-schema.js';
|
|
6
|
+
export type { paths as PublicContractV2Paths } from './generated/public-contract-v2-schema.js';
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { OXCHANNELS_CONTRACT_SET_VERSION, OxChannelsApiError, OxChannelsApiErrorV2, OxChannelsApiProtocolError, createAgentBootstrapClient, createDashboardContractClient, createDashboardV2Client, createOxStudioClient, createPartnerClient, createPublicClient, } from './client.js';
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "2.0.0",
|
|
3
|
+
"contractSetVersion": "2.0.0",
|
|
4
|
+
"sources": {
|
|
5
|
+
"publicContractV2": {
|
|
6
|
+
"path": "docs/api/generated/openapi-public-contract-v2.json",
|
|
7
|
+
"sha256": "155c39d688345f2d5c46d5d44497110b993f02b3f673c71e9f7c38ea30b17856",
|
|
8
|
+
"contract": "PUBLIC"
|
|
9
|
+
},
|
|
10
|
+
"dashboardContractV2": {
|
|
11
|
+
"path": "docs/api/generated/openapi-dashboard-contract-v2.json",
|
|
12
|
+
"sha256": "1108f61022f40b7126e4d2ff0302cfd494cf2461d86a8e8a33ae8a4c69995f68",
|
|
13
|
+
"contract": "DASHBOARD"
|
|
14
|
+
},
|
|
15
|
+
"partnerContractV2": {
|
|
16
|
+
"path": "docs/api/generated/openapi-partner-contract-v2.json",
|
|
17
|
+
"sha256": "51cdb5687d4bb724366d09e00549d17eb22a6a8d0a2556e09f5e9cf242fd09eb",
|
|
18
|
+
"contract": "PARTNER_OX_STUDIO"
|
|
19
|
+
},
|
|
20
|
+
"agentBootstrapContractV2": {
|
|
21
|
+
"path": "docs/api/generated/openapi-agent-bootstrap-contract-v2.json",
|
|
22
|
+
"sha256": "53898b03748aa9c2788960bd2d5f9f64421a4c7e3c38b9ad774b45925ef8cced",
|
|
23
|
+
"contract": "AGENT_BOOTSTRAP"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"outputs": {
|
|
27
|
+
"publicContractV2": {
|
|
28
|
+
"path": "packages/openapi-client/src/generated/public-contract-v2-schema.ts",
|
|
29
|
+
"sha256": "9a97334bbfe4b7a7c538e11ecbb5d0792361ed6b469469bc8dde40785e89c849",
|
|
30
|
+
"sdkManagedOperationHeaders": [
|
|
31
|
+
"OxChannels-Contract-Set"
|
|
32
|
+
],
|
|
33
|
+
"sdkManagedOperationHeadersByOperation": {},
|
|
34
|
+
"sourceBrowserNavigationOperationIds": [
|
|
35
|
+
"LocalAuth_begin",
|
|
36
|
+
"LocalAuth_socialCallback",
|
|
37
|
+
"LocalAuth_verify",
|
|
38
|
+
"OAuthAuthorize_start",
|
|
39
|
+
"ProviderOAuthCallback_callback"
|
|
40
|
+
],
|
|
41
|
+
"excludedBrowserNavigationOperationIds": [
|
|
42
|
+
"LocalAuth_begin",
|
|
43
|
+
"LocalAuth_socialCallback",
|
|
44
|
+
"LocalAuth_verify",
|
|
45
|
+
"OAuthAuthorize_start",
|
|
46
|
+
"ProviderOAuthCallback_callback"
|
|
47
|
+
]
|
|
48
|
+
},
|
|
49
|
+
"dashboardContractV2": {
|
|
50
|
+
"path": "packages/openapi-client/src/generated/dashboard-contract-v2-schema.ts",
|
|
51
|
+
"sha256": "74a6774dd71994831c003ceada80784564b6aed2723e8df501cecb70521432b1",
|
|
52
|
+
"sdkManagedOperationHeaders": [
|
|
53
|
+
"OxChannels-Contract-Set",
|
|
54
|
+
"x-csrf-token"
|
|
55
|
+
],
|
|
56
|
+
"sdkManagedOperationHeadersByOperation": {
|
|
57
|
+
"ProviderApp_addBinding": [
|
|
58
|
+
"X-OxChannels-Expected-Binding-Id"
|
|
59
|
+
]
|
|
60
|
+
},
|
|
61
|
+
"sourceBrowserNavigationOperationIds": [],
|
|
62
|
+
"excludedBrowserNavigationOperationIds": []
|
|
63
|
+
},
|
|
64
|
+
"partnerContractV2": {
|
|
65
|
+
"path": "packages/openapi-client/src/generated/partner-contract-v2-schema.ts",
|
|
66
|
+
"sha256": "9452af29cd1e4ce6dd709b1f3a0cc795119bffdc07856fdfec9f3fd36714da66",
|
|
67
|
+
"sdkManagedOperationHeaders": [
|
|
68
|
+
"OxChannels-Contract-Set"
|
|
69
|
+
],
|
|
70
|
+
"sdkManagedOperationHeadersByOperation": {},
|
|
71
|
+
"sourceBrowserNavigationOperationIds": [],
|
|
72
|
+
"excludedBrowserNavigationOperationIds": []
|
|
73
|
+
},
|
|
74
|
+
"agentBootstrapContractV2": {
|
|
75
|
+
"path": "packages/openapi-client/src/generated/agent-bootstrap-contract-v2-schema.ts",
|
|
76
|
+
"sha256": "2657490e5a67caccba3edfd303a9f64354f70f0f795a46f09ae66df66d0847bf",
|
|
77
|
+
"sdkManagedOperationHeaders": [
|
|
78
|
+
"OxChannels-Contract-Set"
|
|
79
|
+
],
|
|
80
|
+
"sdkManagedOperationHeadersByOperation": {},
|
|
81
|
+
"sourceBrowserNavigationOperationIds": [],
|
|
82
|
+
"excludedBrowserNavigationOperationIds": []
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
"generator": "openapi-typescript@7.13.0",
|
|
86
|
+
"runtime": "openapi-fetch@0.17.0"
|
|
87
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@oxchannels/sdk",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Closed beta. Typed TypeScript client for the OxChannels REST API, generated from the sealed OpenAPI contracts (public, dashboard, partner and agent-bootstrap surfaces); requires an API key issued by OxChannels.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"oxchannels",
|
|
7
|
+
"sdk",
|
|
8
|
+
"openapi",
|
|
9
|
+
"openapi-fetch",
|
|
10
|
+
"social-media",
|
|
11
|
+
"publishing",
|
|
12
|
+
"typescript"
|
|
13
|
+
],
|
|
14
|
+
"license": "UNLICENSED",
|
|
15
|
+
"repository": {
|
|
16
|
+
"type": "git",
|
|
17
|
+
"url": "git+https://github.com/OxStudio-io/oxchannels.git",
|
|
18
|
+
"directory": "packages/openapi-client"
|
|
19
|
+
},
|
|
20
|
+
"type": "module",
|
|
21
|
+
"exports": {
|
|
22
|
+
".": {
|
|
23
|
+
"types": "./dist/index.d.ts",
|
|
24
|
+
"default": "./dist/index.js"
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
"files": [
|
|
28
|
+
"dist",
|
|
29
|
+
"generated/provenance.json",
|
|
30
|
+
"contracts/*.json",
|
|
31
|
+
"README.md",
|
|
32
|
+
"QUICKSTART.md",
|
|
33
|
+
"LICENSE"
|
|
34
|
+
],
|
|
35
|
+
"publishConfig": {
|
|
36
|
+
"access": "public"
|
|
37
|
+
},
|
|
38
|
+
"dependencies": {
|
|
39
|
+
"openapi-fetch": "0.17.0"
|
|
40
|
+
},
|
|
41
|
+
"devDependencies": {
|
|
42
|
+
"openapi-typescript": "7.13.0",
|
|
43
|
+
"typescript": "5.9.3",
|
|
44
|
+
"@oxchannels/contracts": "0.0.0"
|
|
45
|
+
},
|
|
46
|
+
"homepage": "https://oxchannels.com",
|
|
47
|
+
"scripts": {
|
|
48
|
+
"build": "tsc -p tsconfig.json",
|
|
49
|
+
"lint": "eslint src examples --max-warnings=0",
|
|
50
|
+
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
51
|
+
"test": "node --test test/client.test.mjs test/generator.test.mjs && tsc -p test/tsconfig.json --noEmit",
|
|
52
|
+
"openapi:generate": "node scripts/generate.mjs",
|
|
53
|
+
"openapi:check": "node scripts/check.mjs"
|
|
54
|
+
}
|
|
55
|
+
}
|