@fern-api/fdr-sdk 1.2.74-58b68e5a75 → 1.2.74-62f00ca999
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/dist/js/client/FdrClient.js +54 -2
- package/dist/js/client/FdrClient.js.map +1 -1
- package/dist/js/client/FdrClient.mjs +54 -2
- package/dist/js/client/FdrClient.mjs.map +1 -1
- package/dist/js/client/types.js +7 -1
- package/dist/js/client/types.js.map +1 -1
- package/dist/js/client/types.mjs +7 -1
- package/dist/js/client/types.mjs.map +1 -1
- package/dist/js/converters/index.js +7 -1
- package/dist/js/converters/index.js.map +1 -1
- package/dist/js/converters/index.mjs +7 -1
- package/dist/js/converters/index.mjs.map +1 -1
- package/dist/js/docs/index.js +7 -1
- package/dist/js/docs/index.js.map +1 -1
- package/dist/js/docs/index.mjs +7 -1
- package/dist/js/docs/index.mjs.map +1 -1
- package/dist/js/index.js +54 -2
- package/dist/js/index.js.map +1 -1
- package/dist/js/index.mjs +54 -2
- package/dist/js/index.mjs.map +1 -1
- package/dist/js/navigation/index.js +7 -1
- package/dist/js/navigation/index.js.map +1 -1
- package/dist/js/navigation/index.mjs +7 -1
- package/dist/js/navigation/index.mjs.map +1 -1
- package/dist/js/orpc-client.js +66 -2
- package/dist/js/orpc-client.js.map +1 -1
- package/dist/js/orpc-client.mjs +60 -2
- package/dist/js/orpc-client.mjs.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/types/client/docs-types/db.d.ts +61 -0
- package/dist/types/client/docs-types/db.d.ts.map +1 -1
- package/dist/types/client/docs-types/read.d.ts +27 -0
- package/dist/types/client/docs-types/read.d.ts.map +1 -1
- package/dist/types/client/docs-types/shared.d.ts +18 -0
- package/dist/types/client/docs-types/shared.d.ts.map +1 -1
- package/dist/types/client/docs-types/write.d.ts +16 -0
- package/dist/types/client/docs-types/write.d.ts.map +1 -1
- package/dist/types/orpc-client/dashboard-agent/contract.d.ts +282 -0
- package/dist/types/orpc-client/dashboard-agent/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs/v1/read/contract.d.ts +18 -0
- package/dist/types/orpc-client/docs/v1/read/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs/v1/write/contract.d.ts +4 -0
- package/dist/types/orpc-client/docs/v1/write/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs/v2/read/contract.d.ts +40 -0
- package/dist/types/orpc-client/docs/v2/read/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs/v2/write/contract.d.ts +8 -0
- package/dist/types/orpc-client/docs/v2/write/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs-ledger/contract.d.ts +56 -0
- package/dist/types/orpc-client/docs-ledger/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts +22 -0
- package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/js/orpc-client.js
CHANGED
|
@@ -55,6 +55,7 @@ __export(orpc_client_exports, {
|
|
|
55
55
|
AuthPayloadSchema: () => AuthPayloadSchema,
|
|
56
56
|
AuthSchemeId: () => AuthSchemeId,
|
|
57
57
|
AuthSchemeIdSchema: () => AuthSchemeIdSchema,
|
|
58
|
+
AuthorizeDocsEditResponseSchema: () => AuthorizeDocsEditResponseSchema,
|
|
58
59
|
Availability: () => Availability,
|
|
59
60
|
AvailabilitySchema: () => AvailabilitySchema,
|
|
60
61
|
Base64TypeSchema: () => Base64TypeSchema,
|
|
@@ -93,6 +94,7 @@ __export(orpc_client_exports, {
|
|
|
93
94
|
DashboardAnalyticsCommonInputSchema: () => DashboardAnalyticsCommonInputSchema,
|
|
94
95
|
DashboardDocsSiteSchema: () => DashboardDocsSiteSchema,
|
|
95
96
|
DashboardFeedbackInputSchema: () => DashboardFeedbackInputSchema,
|
|
97
|
+
DashboardGetSiteConfigInputSchema: () => DashboardGetSiteConfigInputSchema,
|
|
96
98
|
DashboardListOrgDocDomainsInputSchema: () => DashboardListOrgDocDomainsInputSchema,
|
|
97
99
|
DashboardListOrgMembersInputSchema: () => DashboardListOrgMembersInputSchema,
|
|
98
100
|
DateTypeSchema: () => DateTypeSchema,
|
|
@@ -536,7 +538,11 @@ __export(orpc_client_exports, {
|
|
|
536
538
|
SetEditorRepoUrlInputSchema: () => SetEditorRepoUrlInputSchema,
|
|
537
539
|
SetIsArchivedInputSchema: () => SetIsArchivedInputSchema,
|
|
538
540
|
SetSnapshotInputSchema: () => SetSnapshotInputSchema,
|
|
541
|
+
SiteConfigResponseSchema: () => SiteConfigResponseSchema,
|
|
542
|
+
SiteGitRepositorySchema: () => SiteGitRepositorySchema,
|
|
539
543
|
SiteMetricsSchema: () => SiteMetricsSchema,
|
|
544
|
+
SitePasswordProtectionSchema: () => SitePasswordProtectionSchema,
|
|
545
|
+
SiteSettingsResponseSchema: () => SiteSettingsResponseSchema,
|
|
540
546
|
SlugEntrySchema: () => SlugEntrySchema,
|
|
541
547
|
SlugsInputSchema: () => SlugsInputSchema,
|
|
542
548
|
SnippetInfoSchema: () => SnippetInfoSchema,
|
|
@@ -2861,6 +2867,13 @@ var DashboardListOrgMembersInputSchema = z10.object({
|
|
|
2861
2867
|
orgId: z10.string(),
|
|
2862
2868
|
includeFernEmployees: z10.boolean().optional()
|
|
2863
2869
|
});
|
|
2870
|
+
var DashboardGetSiteConfigInputSchema = z10.object({
|
|
2871
|
+
orgId: z10.string(),
|
|
2872
|
+
domain: z10.string().min(1)
|
|
2873
|
+
});
|
|
2874
|
+
var AuthorizeDocsEditResponseSchema = z10.object({
|
|
2875
|
+
authorized: z10.literal(true)
|
|
2876
|
+
});
|
|
2864
2877
|
var AnalyticsMetricSchema = z10.enum(["pageviews", "visitors", "sessions", "404s"]);
|
|
2865
2878
|
var AnalyticsDimensionSchema = z10.enum(["path", "referrer"]);
|
|
2866
2879
|
var AnalyticsGranularitySchema = z10.enum(["day", "week", "month"]);
|
|
@@ -2984,6 +2997,42 @@ var OrgMembersResponseSchema = z10.object({
|
|
|
2984
2997
|
),
|
|
2985
2998
|
count: z10.number()
|
|
2986
2999
|
});
|
|
3000
|
+
var SiteGitRepositorySchema = z10.object({
|
|
3001
|
+
gitUrl: z10.string(),
|
|
3002
|
+
provider: z10.enum(["github", "gitlab", "other"]),
|
|
3003
|
+
/** `owner/repo` when the git url points at GitHub, else null. */
|
|
3004
|
+
githubRepository: z10.string().nullable(),
|
|
3005
|
+
branch: z10.string().nullable()
|
|
3006
|
+
});
|
|
3007
|
+
var SiteConfigResponseSchema = z10.object({
|
|
3008
|
+
domain: z10.string(),
|
|
3009
|
+
basepath: z10.string().nullable(),
|
|
3010
|
+
status: z10.string().nullable(),
|
|
3011
|
+
isPreview: z10.boolean(),
|
|
3012
|
+
/** The git repository connected to this docs site, when one exists. */
|
|
3013
|
+
gitRepository: SiteGitRepositorySchema.nullable(),
|
|
3014
|
+
/** True when the queried domain is a customer-owned custom domain (not *.docs.buildwithfern.com). */
|
|
3015
|
+
isCustomDomain: z10.boolean(),
|
|
3016
|
+
/** Fern CLI version that published the current deployment, when known. */
|
|
3017
|
+
fernCliVersion: z10.string().nullable(),
|
|
3018
|
+
/** Connected Postman collection id, when one exists. */
|
|
3019
|
+
postmanCollectionId: z10.string().nullable()
|
|
3020
|
+
});
|
|
3021
|
+
var SitePasswordProtectionSchema = z10.object({
|
|
3022
|
+
enabled: z10.boolean(),
|
|
3023
|
+
/** Number of configured passwords. Passwords themselves are never returned. */
|
|
3024
|
+
passwordCount: z10.number()
|
|
3025
|
+
});
|
|
3026
|
+
var SiteSettingsResponseSchema = z10.object({
|
|
3027
|
+
domain: z10.string(),
|
|
3028
|
+
basepath: z10.string().nullable(),
|
|
3029
|
+
/** Default basepath route for multi-basepath domains, when configured. */
|
|
3030
|
+
defaultBasepath: z10.string().nullable(),
|
|
3031
|
+
/** Basepaths routed on this domain, when configured. */
|
|
3032
|
+
basepaths: z10.array(z10.string()).nullable(),
|
|
3033
|
+
searchBehavior: z10.enum(["hierarchical", "unified"]).nullable(),
|
|
3034
|
+
passwordProtection: SitePasswordProtectionSchema
|
|
3035
|
+
});
|
|
2987
3036
|
var dashboardAgentContract = {
|
|
2988
3037
|
getTrafficSummary: import_contract6.oc.route({ method: "POST", path: "/get-traffic-summary" }).input(DashboardAnalyticsCommonInputSchema).output(TrafficSummaryResponseSchema),
|
|
2989
3038
|
getTopPages: import_contract6.oc.route({ method: "POST", path: "/get-top-pages" }).input(DashboardAnalyticsCommonInputSchema).output(TopPagesResponseSchema),
|
|
@@ -2993,7 +3042,10 @@ var dashboardAgentContract = {
|
|
|
2993
3042
|
getRecentFeedback: import_contract6.oc.route({ method: "POST", path: "/get-recent-feedback" }).input(DashboardFeedbackInputSchema).output(RecentFeedbackResponseSchema),
|
|
2994
3043
|
queryAnalytics: import_contract6.oc.route({ method: "POST", path: "/query-analytics" }).input(QueryAnalyticsInputSchema).output(QueryAnalyticsResponseSchema),
|
|
2995
3044
|
listOrgDocDomains: import_contract6.oc.route({ method: "POST", path: "/list-org-doc-domains" }).input(DashboardListOrgDocDomainsInputSchema).output(OrgDocDomainsResponseSchema),
|
|
2996
|
-
listOrgMembers: import_contract6.oc.route({ method: "POST", path: "/list-org-members" }).input(DashboardListOrgMembersInputSchema).output(OrgMembersResponseSchema)
|
|
3045
|
+
listOrgMembers: import_contract6.oc.route({ method: "POST", path: "/list-org-members" }).input(DashboardListOrgMembersInputSchema).output(OrgMembersResponseSchema),
|
|
3046
|
+
getSiteConfig: import_contract6.oc.route({ method: "POST", path: "/get-site-config" }).input(DashboardGetSiteConfigInputSchema).output(SiteConfigResponseSchema),
|
|
3047
|
+
authorizeDocsEdit: import_contract6.oc.route({ method: "POST", path: "/authorize-docs-edit" }).input(DashboardGetSiteConfigInputSchema).output(AuthorizeDocsEditResponseSchema),
|
|
3048
|
+
getSiteSettings: import_contract6.oc.route({ method: "POST", path: "/get-site-settings" }).input(DashboardGetSiteConfigInputSchema).output(SiteSettingsResponseSchema)
|
|
2997
3049
|
};
|
|
2998
3050
|
|
|
2999
3051
|
// src/orpc-client/dashboard-agent/client.ts
|
|
@@ -3231,7 +3283,13 @@ var HttpSnippetLanguageSchema = z11.enum([
|
|
|
3231
3283
|
var HttpSnippetsConfigSchema = z11.union([z11.boolean(), z11.array(HttpSnippetLanguageSchema)]);
|
|
3232
3284
|
var SearchSettingsConfigSchema = z11.object({
|
|
3233
3285
|
prioritizeCurrentProduct: z11.boolean().optional(),
|
|
3234
|
-
defaultFilterByCurrentProduct: z11.boolean().optional()
|
|
3286
|
+
defaultFilterByCurrentProduct: z11.boolean().optional(),
|
|
3287
|
+
/**
|
|
3288
|
+
* Experimental: absolute URLs of external sitemaps to index alongside this
|
|
3289
|
+
* site's docs content. Their pages are tagged to the same domain but flagged
|
|
3290
|
+
* as third-party so they rank below all first-party documentation in search.
|
|
3291
|
+
*/
|
|
3292
|
+
externalSitemaps: z11.array(z11.string()).optional()
|
|
3235
3293
|
});
|
|
3236
3294
|
var DocsSettingsConfigSchema = z11.object({
|
|
3237
3295
|
searchText: z11.string().optional(),
|
|
@@ -7022,6 +7080,7 @@ var UpsertThemeBodySchema = z36.object({
|
|
|
7022
7080
|
AuthPayloadSchema,
|
|
7023
7081
|
AuthSchemeId,
|
|
7024
7082
|
AuthSchemeIdSchema,
|
|
7083
|
+
AuthorizeDocsEditResponseSchema,
|
|
7025
7084
|
Availability,
|
|
7026
7085
|
AvailabilitySchema,
|
|
7027
7086
|
Base64TypeSchema,
|
|
@@ -7060,6 +7119,7 @@ var UpsertThemeBodySchema = z36.object({
|
|
|
7060
7119
|
DashboardAnalyticsCommonInputSchema,
|
|
7061
7120
|
DashboardDocsSiteSchema,
|
|
7062
7121
|
DashboardFeedbackInputSchema,
|
|
7122
|
+
DashboardGetSiteConfigInputSchema,
|
|
7063
7123
|
DashboardListOrgDocDomainsInputSchema,
|
|
7064
7124
|
DashboardListOrgMembersInputSchema,
|
|
7065
7125
|
DateTypeSchema,
|
|
@@ -7503,7 +7563,11 @@ var UpsertThemeBodySchema = z36.object({
|
|
|
7503
7563
|
SetEditorRepoUrlInputSchema,
|
|
7504
7564
|
SetIsArchivedInputSchema,
|
|
7505
7565
|
SetSnapshotInputSchema,
|
|
7566
|
+
SiteConfigResponseSchema,
|
|
7567
|
+
SiteGitRepositorySchema,
|
|
7506
7568
|
SiteMetricsSchema,
|
|
7569
|
+
SitePasswordProtectionSchema,
|
|
7570
|
+
SiteSettingsResponseSchema,
|
|
7507
7571
|
SlugEntrySchema,
|
|
7508
7572
|
SlugsInputSchema,
|
|
7509
7573
|
SnippetInfoSchema,
|