@fern-api/fdr-sdk 1.2.74-882248ce5b → 1.2.74-9da4eb6ac8

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.
Files changed (52) hide show
  1. package/dist/js/client/FdrClient.js +50 -2
  2. package/dist/js/client/FdrClient.js.map +1 -1
  3. package/dist/js/client/FdrClient.mjs +50 -2
  4. package/dist/js/client/FdrClient.mjs.map +1 -1
  5. package/dist/js/client/types.js +7 -1
  6. package/dist/js/client/types.js.map +1 -1
  7. package/dist/js/client/types.mjs +7 -1
  8. package/dist/js/client/types.mjs.map +1 -1
  9. package/dist/js/converters/index.js +7 -1
  10. package/dist/js/converters/index.js.map +1 -1
  11. package/dist/js/converters/index.mjs +7 -1
  12. package/dist/js/converters/index.mjs.map +1 -1
  13. package/dist/js/docs/index.js +7 -1
  14. package/dist/js/docs/index.js.map +1 -1
  15. package/dist/js/docs/index.mjs +7 -1
  16. package/dist/js/docs/index.mjs.map +1 -1
  17. package/dist/js/index.js +50 -2
  18. package/dist/js/index.js.map +1 -1
  19. package/dist/js/index.mjs +50 -2
  20. package/dist/js/index.mjs.map +1 -1
  21. package/dist/js/navigation/index.js +7 -1
  22. package/dist/js/navigation/index.js.map +1 -1
  23. package/dist/js/navigation/index.mjs +7 -1
  24. package/dist/js/navigation/index.mjs.map +1 -1
  25. package/dist/js/orpc-client.js +60 -2
  26. package/dist/js/orpc-client.js.map +1 -1
  27. package/dist/js/orpc-client.mjs +55 -2
  28. package/dist/js/orpc-client.mjs.map +1 -1
  29. package/dist/tsconfig.tsbuildinfo +1 -1
  30. package/dist/types/client/docs-types/db.d.ts +61 -0
  31. package/dist/types/client/docs-types/db.d.ts.map +1 -1
  32. package/dist/types/client/docs-types/read.d.ts +27 -0
  33. package/dist/types/client/docs-types/read.d.ts.map +1 -1
  34. package/dist/types/client/docs-types/shared.d.ts +18 -0
  35. package/dist/types/client/docs-types/shared.d.ts.map +1 -1
  36. package/dist/types/client/docs-types/write.d.ts +16 -0
  37. package/dist/types/client/docs-types/write.d.ts.map +1 -1
  38. package/dist/types/orpc-client/dashboard-agent/contract.d.ts +257 -0
  39. package/dist/types/orpc-client/dashboard-agent/contract.d.ts.map +1 -1
  40. package/dist/types/orpc-client/docs/v1/read/contract.d.ts +18 -0
  41. package/dist/types/orpc-client/docs/v1/read/contract.d.ts.map +1 -1
  42. package/dist/types/orpc-client/docs/v1/write/contract.d.ts +4 -0
  43. package/dist/types/orpc-client/docs/v1/write/contract.d.ts.map +1 -1
  44. package/dist/types/orpc-client/docs/v2/read/contract.d.ts +40 -0
  45. package/dist/types/orpc-client/docs/v2/read/contract.d.ts.map +1 -1
  46. package/dist/types/orpc-client/docs/v2/write/contract.d.ts +8 -0
  47. package/dist/types/orpc-client/docs/v2/write/contract.d.ts.map +1 -1
  48. package/dist/types/orpc-client/docs-ledger/contract.d.ts +56 -0
  49. package/dist/types/orpc-client/docs-ledger/contract.d.ts.map +1 -1
  50. package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts +22 -0
  51. package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
  52. package/package.json +1 -1
@@ -1967,6 +1967,10 @@ var DashboardListOrgMembersInputSchema = z9.object({
1967
1967
  orgId: z9.string(),
1968
1968
  includeFernEmployees: z9.boolean().optional()
1969
1969
  });
1970
+ var DashboardGetSiteConfigInputSchema = z9.object({
1971
+ orgId: z9.string(),
1972
+ domain: z9.string().min(1)
1973
+ });
1970
1974
  var AnalyticsMetricSchema = z9.enum(["pageviews", "visitors", "sessions", "404s"]);
1971
1975
  var AnalyticsDimensionSchema = z9.enum(["path", "referrer"]);
1972
1976
  var AnalyticsGranularitySchema = z9.enum(["day", "week", "month"]);
@@ -2090,6 +2094,42 @@ var OrgMembersResponseSchema = z9.object({
2090
2094
  ),
2091
2095
  count: z9.number()
2092
2096
  });
2097
+ var SiteGitRepositorySchema = z9.object({
2098
+ gitUrl: z9.string(),
2099
+ provider: z9.enum(["github", "gitlab", "other"]),
2100
+ /** `owner/repo` when the git url points at GitHub, else null. */
2101
+ githubRepository: z9.string().nullable(),
2102
+ branch: z9.string().nullable()
2103
+ });
2104
+ var SiteConfigResponseSchema = z9.object({
2105
+ domain: z9.string(),
2106
+ basepath: z9.string().nullable(),
2107
+ status: z9.string().nullable(),
2108
+ isPreview: z9.boolean(),
2109
+ /** The git repository connected to this docs site, when one exists. */
2110
+ gitRepository: SiteGitRepositorySchema.nullable(),
2111
+ /** True when the queried domain is a customer-owned custom domain (not *.docs.buildwithfern.com). */
2112
+ isCustomDomain: z9.boolean(),
2113
+ /** Fern CLI version that published the current deployment, when known. */
2114
+ fernCliVersion: z9.string().nullable(),
2115
+ /** Connected Postman collection id, when one exists. */
2116
+ postmanCollectionId: z9.string().nullable()
2117
+ });
2118
+ var SitePasswordProtectionSchema = z9.object({
2119
+ enabled: z9.boolean(),
2120
+ /** Number of configured passwords. Passwords themselves are never returned. */
2121
+ passwordCount: z9.number()
2122
+ });
2123
+ var SiteSettingsResponseSchema = z9.object({
2124
+ domain: z9.string(),
2125
+ basepath: z9.string().nullable(),
2126
+ /** Default basepath route for multi-basepath domains, when configured. */
2127
+ defaultBasepath: z9.string().nullable(),
2128
+ /** Basepaths routed on this domain, when configured. */
2129
+ basepaths: z9.array(z9.string()).nullable(),
2130
+ searchBehavior: z9.enum(["hierarchical", "unified"]).nullable(),
2131
+ passwordProtection: SitePasswordProtectionSchema
2132
+ });
2093
2133
  var dashboardAgentContract = {
2094
2134
  getTrafficSummary: oc4.route({ method: "POST", path: "/get-traffic-summary" }).input(DashboardAnalyticsCommonInputSchema).output(TrafficSummaryResponseSchema),
2095
2135
  getTopPages: oc4.route({ method: "POST", path: "/get-top-pages" }).input(DashboardAnalyticsCommonInputSchema).output(TopPagesResponseSchema),
@@ -2099,7 +2139,9 @@ var dashboardAgentContract = {
2099
2139
  getRecentFeedback: oc4.route({ method: "POST", path: "/get-recent-feedback" }).input(DashboardFeedbackInputSchema).output(RecentFeedbackResponseSchema),
2100
2140
  queryAnalytics: oc4.route({ method: "POST", path: "/query-analytics" }).input(QueryAnalyticsInputSchema).output(QueryAnalyticsResponseSchema),
2101
2141
  listOrgDocDomains: oc4.route({ method: "POST", path: "/list-org-doc-domains" }).input(DashboardListOrgDocDomainsInputSchema).output(OrgDocDomainsResponseSchema),
2102
- listOrgMembers: oc4.route({ method: "POST", path: "/list-org-members" }).input(DashboardListOrgMembersInputSchema).output(OrgMembersResponseSchema)
2142
+ listOrgMembers: oc4.route({ method: "POST", path: "/list-org-members" }).input(DashboardListOrgMembersInputSchema).output(OrgMembersResponseSchema),
2143
+ getSiteConfig: oc4.route({ method: "POST", path: "/get-site-config" }).input(DashboardGetSiteConfigInputSchema).output(SiteConfigResponseSchema),
2144
+ getSiteSettings: oc4.route({ method: "POST", path: "/get-site-settings" }).input(DashboardGetSiteConfigInputSchema).output(SiteSettingsResponseSchema)
2103
2145
  };
2104
2146
 
2105
2147
  // src/orpc-client/dashboard-agent/client.ts
@@ -2337,7 +2379,13 @@ var HttpSnippetLanguageSchema = z10.enum([
2337
2379
  var HttpSnippetsConfigSchema = z10.union([z10.boolean(), z10.array(HttpSnippetLanguageSchema)]);
2338
2380
  var SearchSettingsConfigSchema = z10.object({
2339
2381
  prioritizeCurrentProduct: z10.boolean().optional(),
2340
- defaultFilterByCurrentProduct: z10.boolean().optional()
2382
+ defaultFilterByCurrentProduct: z10.boolean().optional(),
2383
+ /**
2384
+ * Experimental: absolute URLs of external sitemaps to index alongside this
2385
+ * site's docs content. Their pages are tagged to the same domain but flagged
2386
+ * as third-party so they rank below all first-party documentation in search.
2387
+ */
2388
+ externalSitemaps: z10.array(z10.string()).optional()
2341
2389
  });
2342
2390
  var DocsSettingsConfigSchema = z10.object({
2343
2391
  searchText: z10.string().optional(),