@fern-api/fdr-sdk 1.2.162-d476e5b6bc → 1.2.163-648ea89159
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/client/libraryDocs.d.ts +9 -0
- package/dist/client/libraryDocs.d.ts.map +1 -1
- package/dist/js/client/FdrClient.js +5 -2
- package/dist/js/client/FdrClient.js.map +1 -1
- package/dist/js/client/FdrClient.mjs +5 -2
- package/dist/js/client/FdrClient.mjs.map +1 -1
- package/dist/js/client/types.js.map +1 -1
- package/dist/js/client/types.mjs.map +1 -1
- package/dist/js/converters/index.js +29 -17
- package/dist/js/converters/index.js.map +1 -1
- package/dist/js/converters/index.mjs +29 -17
- package/dist/js/converters/index.mjs.map +1 -1
- package/dist/js/index.js +34 -19
- package/dist/js/index.js.map +1 -1
- package/dist/js/index.mjs +34 -19
- package/dist/js/index.mjs.map +1 -1
- package/dist/js/navigation/index.js +30 -17
- package/dist/js/navigation/index.js.map +1 -1
- package/dist/js/navigation/index.mjs +30 -17
- package/dist/js/navigation/index.mjs.map +1 -1
- package/dist/js/navigation/ledger-root-builder.js +7 -0
- package/dist/js/navigation/ledger-root-builder.js.map +1 -1
- package/dist/js/navigation/ledger-root-builder.mjs +7 -0
- package/dist/js/navigation/ledger-root-builder.mjs.map +1 -1
- package/dist/js/navigation/types/latest.js.map +1 -1
- package/dist/js/navigation/types/latest.mjs.map +1 -1
- package/dist/js/navigation/types/v1.js.map +1 -1
- package/dist/js/navigation/types/v1.mjs.map +1 -1
- package/dist/js/navigation/versions/latest/index.js +22 -15
- package/dist/js/navigation/versions/latest/index.js.map +1 -1
- package/dist/js/navigation/versions/latest/index.mjs +21 -15
- package/dist/js/navigation/versions/latest/index.mjs.map +1 -1
- package/dist/js/orpc-client.js +5 -2
- package/dist/js/orpc-client.js.map +1 -1
- package/dist/js/orpc-client.mjs +5 -2
- package/dist/js/orpc-client.mjs.map +1 -1
- package/dist/navigation/NodeCollector.js +3 -3
- package/dist/navigation/NodeCollector.js.map +1 -1
- package/dist/navigation/__test__/ledger-root-builder.noindexPreservation.test.d.ts +2 -0
- package/dist/navigation/__test__/ledger-root-builder.noindexPreservation.test.d.ts.map +1 -0
- package/dist/navigation/__test__/ledger-root-builder.noindexPreservation.test.js +58 -0
- package/dist/navigation/__test__/ledger-root-builder.noindexPreservation.test.js.map +1 -0
- package/dist/navigation/ledger-root-builder.d.ts.map +1 -1
- package/dist/navigation/ledger-root-builder.js +7 -0
- package/dist/navigation/ledger-root-builder.js.map +1 -1
- package/dist/navigation/migrators/v1ToV2.d.ts.map +1 -1
- package/dist/navigation/migrators/v1ToV2.js +6 -0
- package/dist/navigation/migrators/v1ToV2.js.map +1 -1
- package/dist/navigation/types/latest.d.ts +6 -0
- package/dist/navigation/types/latest.d.ts.map +1 -1
- package/dist/navigation/types/v1.d.ts +6 -0
- package/dist/navigation/types/v1.d.ts.map +1 -1
- package/dist/navigation/versions/latest/index.d.ts +1 -0
- package/dist/navigation/versions/latest/index.d.ts.map +1 -1
- package/dist/navigation/versions/latest/index.js +1 -0
- package/dist/navigation/versions/latest/index.js.map +1 -1
- package/dist/navigation/versions/latest/isNoindexNode.d.ts +7 -0
- package/dist/navigation/versions/latest/isNoindexNode.d.ts.map +1 -0
- package/dist/navigation/versions/latest/isNoindexNode.js +10 -0
- package/dist/navigation/versions/latest/isNoindexNode.js.map +1 -0
- package/dist/orpc-client/docs/v2/library-docs/contract.d.ts +16 -0
- package/dist/orpc-client/docs/v2/library-docs/contract.d.ts.map +1 -1
- package/dist/orpc-client/docs/v2/library-docs/contract.js +3 -1
- package/dist/orpc-client/docs/v2/library-docs/contract.js.map +1 -1
- package/dist/orpc-client/docs-ledger/contract.d.ts +228 -0
- package/dist/orpc-client/docs-ledger/contract.d.ts.map +1 -1
- package/dist/orpc-client/docs-ledger/contract.js +2 -1
- package/dist/orpc-client/docs-ledger/contract.js.map +1 -1
- package/dist/orpc-client/docs-ledger/ledger-manifest.d.ts +336 -0
- package/dist/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
- package/dist/types/client/libraryDocs.d.ts +9 -0
- package/dist/types/client/libraryDocs.d.ts.map +1 -1
- package/dist/types/navigation/__test__/ledger-root-builder.noindexPreservation.test.d.ts +2 -0
- package/dist/types/navigation/__test__/ledger-root-builder.noindexPreservation.test.d.ts.map +1 -0
- package/dist/types/navigation/ledger-root-builder.d.ts.map +1 -1
- package/dist/types/navigation/migrators/v1ToV2.d.ts.map +1 -1
- package/dist/types/navigation/types/latest.d.ts +6 -0
- package/dist/types/navigation/types/latest.d.ts.map +1 -1
- package/dist/types/navigation/types/v1.d.ts +6 -0
- package/dist/types/navigation/types/v1.d.ts.map +1 -1
- package/dist/types/navigation/versions/latest/index.d.ts +1 -0
- package/dist/types/navigation/versions/latest/index.d.ts.map +1 -1
- package/dist/types/navigation/versions/latest/isNoindexNode.d.ts +7 -0
- package/dist/types/navigation/versions/latest/isNoindexNode.d.ts.map +1 -0
- package/dist/types/orpc-client/docs/v2/library-docs/contract.d.ts +16 -0
- package/dist/types/orpc-client/docs/v2/library-docs/contract.d.ts.map +1 -1
- package/dist/types/orpc-client/docs-ledger/contract.d.ts +228 -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 +336 -0
- package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/navigation/types/latest.ts"],"sourcesContent":["import type {\n EndpointId,\n EnvironmentId,\n FileId,\n GraphQlOperationId,\n GraphQlOperationType,\n GraphQlTypeCategory,\n TypeId,\n WebhookId,\n WebSocketId\n} from \"../../orpc-client/api/shared.js\";\nimport type {\n AnnouncementConfig,\n ApiDefinitionId,\n Availability,\n GrpcId,\n GrpcMethod,\n HttpMethod,\n LinkTarget,\n PageId,\n RoleId,\n Url,\n VersionId\n} from \"../../orpc-client/shared.js\";\n\nexport type Slug = string & {\n navigation_latest_Slug: void;\n};\n\nexport function Slug(value: string): Slug {\n return value as unknown as Slug;\n}\n\nexport type TabId = string & {\n navigation_latest_TabId: void;\n};\n\nexport function TabId(value: string): TabId {\n return value as unknown as TabId;\n}\n\nexport type NodeId = string & {\n navigation_latest_NodeId: void;\n};\n\nexport function NodeId(value: string): NodeId {\n return value as unknown as NodeId;\n}\n\nexport type ProductId = string & {\n navigation_latest_ProductId: void;\n};\n\nexport function ProductId(value: string): ProductId {\n return value as unknown as ProductId;\n}\n\nexport type VariantId = string & {\n navigation_latest_VariantId: void;\n};\n\nexport function VariantId(value: string): VariantId {\n return value as unknown as VariantId;\n}\n\nexport type RootChild = VersionedNode | UnversionedNode | ProductGroupNode;\n\nexport type ProductNode = InternalProductNode | ExternalProductNode;\n\nexport type ProductChild = VersionedNode | UnversionedNode;\n\nexport type VersionChild = TabbedNode | SidebarRootNode | VariantedNode;\n\nexport type VariantChild = ApiReferenceNode | SectionNode | SidebarGroupNode | PageNode | LinkNode | ChangelogNode;\n\nexport type TabChild = TabNode | LinkNode | ChangelogNode;\n\nexport type SidebarRootChild = SidebarGroupNode | ApiReferenceNode | SectionNode | VariantedNode;\n\nexport type NavigationChild = ApiReferenceNode | SectionNode | PageNode | LinkNode | ChangelogNode | VariantedNode;\n\nexport type ApiPackageChild =\n | ApiPackageNode\n | EndpointNode\n | EndpointPairNode\n | WebSocketNode\n | WebhookNode\n | GrpcNode\n | GraphQlNode\n | GraphQlTypeNode\n | PageNode\n | LinkNode;\n\nexport interface WithNodeId {\n id: NodeId;\n collapsed: boolean | \"open-by-default\" | undefined;\n}\n\nexport interface WithPermissions {\n viewers: RoleId[] | undefined;\n orphaned: boolean | undefined;\n}\n\nexport interface WithFeatureFlags {\n featureFlags: FeatureFlagOptions[] | undefined;\n}\n\nexport interface WithNodeMetadata extends WithNodeId, WithPermissions, WithFeatureFlags {\n title: string;\n slug: Slug;\n canonicalSlug: Slug | undefined;\n icon: string | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface WithPage {\n pageId: PageId;\n noindex: boolean | undefined;\n}\n\nexport interface WithOverviewPage {\n overviewPageId: PageId | undefined;\n noindex: boolean | undefined;\n}\n\nexport interface WithApiDefinitionId {\n apiDefinitionId: ApiDefinitionId;\n availability: Availability | undefined;\n}\n\nexport interface WithRedirect {\n pointsTo: Slug | undefined;\n}\n\nexport interface FeatureFlagOptions {\n flag: string;\n fallbackValue: unknown | undefined;\n match: unknown | undefined;\n}\n\nexport interface BreadcrumbItem {\n title: string;\n pointsTo: Slug | undefined;\n}\n\nexport interface PlaygroundButtonSettings {\n href: Url | undefined;\n}\n\nexport interface PlaygroundSettings {\n environments: EnvironmentId[] | undefined;\n button: PlaygroundButtonSettings | undefined;\n \"limit-websocket-messages-per-connection\": number | undefined;\n hidden: boolean | undefined;\n // when true, optional parameters that declare a default (or x-fern-default) are\n // pre-filled and sent from the API Explorer playground. defaults to false.\n \"send-optional-defaults\": boolean | undefined;\n}\n\nexport type { GraphQlOperationType };\nexport type { GraphQlTypeCategory };\n\nexport interface ProductGroupNode extends WithNodeId {\n type: \"productgroup\";\n landingPage: LandingPageNode | undefined;\n children: ProductNode[];\n /** Site-level changelog shared by all products; slugged off the root, not shown in the product switcher. */\n changelog?: ChangelogNode | undefined;\n}\n\nexport interface VersionedNode extends WithNodeId {\n type: \"versioned\";\n children: VersionNode[];\n}\n\nexport interface UnversionedNode extends WithNodeId {\n type: \"unversioned\";\n child: VersionChild;\n landingPage: LandingPageNode | undefined;\n}\n\nexport interface VariantedNode extends WithNodeId {\n type: \"varianted\";\n children: VariantNode[];\n}\n\nexport interface TabbedNode extends WithNodeId {\n type: \"tabbed\";\n children: TabChild[];\n}\n\nexport interface SidebarRootNode extends WithNodeId {\n type: \"sidebarRoot\";\n children: SidebarRootChild[];\n}\n\nexport interface SidebarGroupNode extends WithNodeId {\n type: \"sidebarGroup\";\n children: NavigationChild[];\n}\n\nexport interface EndpointPairNode extends WithNodeId {\n type: \"endpointPair\";\n stream: EndpointNode;\n nonStream: EndpointNode;\n}\n\nexport interface LinkNode extends WithNodeId {\n type: \"link\";\n title: string;\n icon: string | undefined;\n url: Url;\n target: LinkTarget | undefined;\n}\n\nexport interface RootNode extends WithNodeMetadata, WithRedirect {\n type: \"root\";\n version: \"v2\";\n child: RootChild;\n roles: RoleId[] | undefined;\n}\n\nexport interface InternalProductNode extends WithNodeMetadata, WithRedirect {\n type: \"product\";\n default: boolean;\n productId: ProductId;\n child: ProductChild;\n subtitle: string;\n image: FileId | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface ExternalProductNode extends WithNodeId, WithPermissions, WithFeatureFlags {\n type: \"productLink\";\n default: boolean;\n productId: ProductId;\n title: string;\n href: Url;\n target: LinkTarget | undefined;\n subtitle: string;\n icon: string | undefined;\n image: FileId | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface VersionNode extends WithNodeMetadata, WithRedirect {\n type: \"version\";\n default: boolean;\n versionId: VersionId;\n child: VersionChild;\n availability: Availability | undefined;\n landingPage: LandingPageNode | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface VariantNode extends WithNodeMetadata, WithRedirect {\n type: \"variant\";\n default: boolean;\n variantId: VariantId;\n subtitle: string | undefined;\n image: FileId | undefined;\n children: VariantChild[];\n}\n\nexport interface TabNode extends WithNodeMetadata, WithRedirect {\n type: \"tab\";\n child: SidebarRootNode;\n}\n\nexport interface PageNode extends WithNodeMetadata, WithPage {\n type: \"page\";\n availability: Availability | undefined;\n}\n\nexport interface LandingPageNode extends WithNodeMetadata, WithPage {\n type: \"landingPage\";\n}\n\nexport interface SectionNode extends WithNodeMetadata, WithOverviewPage, WithRedirect {\n type: \"section\";\n collapsible: boolean | undefined;\n collapsedByDefault: boolean | undefined;\n children: NavigationChild[];\n availability: Availability | undefined;\n}\n\nexport interface ChangelogNode extends WithNodeMetadata, WithOverviewPage {\n type: \"changelog\";\n children: ChangelogYearNode[];\n}\n\nexport interface ChangelogYearNode extends WithNodeMetadata {\n type: \"changelogYear\";\n year: number;\n children: ChangelogMonthNode[];\n}\n\nexport interface ChangelogMonthNode extends WithNodeMetadata {\n type: \"changelogMonth\";\n month: number;\n children: ChangelogEntryNode[];\n}\n\nexport interface ChangelogEntryNode extends WithNodeMetadata, WithPage {\n type: \"changelogEntry\";\n date: string;\n tags: string[] | undefined;\n}\n\nexport interface ApiReferenceNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiReference\";\n paginated: boolean | undefined;\n showErrors: boolean | undefined;\n hideTitle: boolean | undefined;\n children: ApiPackageChild[];\n changelog: ChangelogNode | undefined;\n playground: PlaygroundSettings | undefined;\n postmanCollectionUrl: string | undefined;\n}\n\nexport interface EndpointNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"endpoint\";\n method: HttpMethod;\n endpointId: EndpointId;\n isResponseStream: boolean | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebSocketNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"webSocket\";\n webSocketId: WebSocketId;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebhookNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"webhook\";\n method: HttpMethod;\n webhookId: WebhookId;\n}\n\nexport interface GrpcNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"grpc\";\n method: GrpcMethod;\n grpcId: GrpcId;\n}\n\nexport interface GraphQlNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"graphql\";\n operationType: GraphQlOperationType;\n graphqlOperationId: GraphQlOperationId;\n /** Additional operation IDs when this node represents a namespace group (e.g. fieldPath grouping). */\n graphqlOperationIds: GraphQlOperationId[] | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\n/**\n * A navigation node representing a single GraphQL schema type (object, input,\n * enum, scalar, interface, or union) as opposed to a GraphQL operation.\n *\n * This node is a navigable leaf, mirroring {@link GraphQlNode}. Generating these\n * nodes from a schema (FER-10879) and rendering a dedicated type page\n * (FER-10880) are tracked separately.\n */\nexport interface GraphQlTypeNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"graphqlType\";\n typeId: TypeId;\n typeCategory: GraphQlTypeCategory;\n}\n\nexport interface ApiPackageNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiPackage\";\n children: ApiPackageChild[];\n playground: PlaygroundSettings | undefined;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA6BO,SAAS,KAAK,OAAqB;AACtC,SAAO;AACX;AAMO,SAAS,MAAM,OAAsB;AACxC,SAAO;AACX;AAMO,SAAS,OAAO,OAAuB;AAC1C,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../../../src/navigation/types/latest.ts"],"sourcesContent":["import type {\n EndpointId,\n EnvironmentId,\n FileId,\n GraphQlOperationId,\n GraphQlOperationType,\n GraphQlTypeCategory,\n TypeId,\n WebhookId,\n WebSocketId\n} from \"../../orpc-client/api/shared.js\";\nimport type {\n AnnouncementConfig,\n ApiDefinitionId,\n Availability,\n GrpcId,\n GrpcMethod,\n HttpMethod,\n LinkTarget,\n PageId,\n RoleId,\n Url,\n VersionId\n} from \"../../orpc-client/shared.js\";\n\nexport type Slug = string & {\n navigation_latest_Slug: void;\n};\n\nexport function Slug(value: string): Slug {\n return value as unknown as Slug;\n}\n\nexport type TabId = string & {\n navigation_latest_TabId: void;\n};\n\nexport function TabId(value: string): TabId {\n return value as unknown as TabId;\n}\n\nexport type NodeId = string & {\n navigation_latest_NodeId: void;\n};\n\nexport function NodeId(value: string): NodeId {\n return value as unknown as NodeId;\n}\n\nexport type ProductId = string & {\n navigation_latest_ProductId: void;\n};\n\nexport function ProductId(value: string): ProductId {\n return value as unknown as ProductId;\n}\n\nexport type VariantId = string & {\n navigation_latest_VariantId: void;\n};\n\nexport function VariantId(value: string): VariantId {\n return value as unknown as VariantId;\n}\n\nexport type RootChild = VersionedNode | UnversionedNode | ProductGroupNode;\n\nexport type ProductNode = InternalProductNode | ExternalProductNode;\n\nexport type ProductChild = VersionedNode | UnversionedNode;\n\nexport type VersionChild = TabbedNode | SidebarRootNode | VariantedNode;\n\nexport type VariantChild = ApiReferenceNode | SectionNode | SidebarGroupNode | PageNode | LinkNode | ChangelogNode;\n\nexport type TabChild = TabNode | LinkNode | ChangelogNode;\n\nexport type SidebarRootChild = SidebarGroupNode | ApiReferenceNode | SectionNode | VariantedNode;\n\nexport type NavigationChild = ApiReferenceNode | SectionNode | PageNode | LinkNode | ChangelogNode | VariantedNode;\n\nexport type ApiPackageChild =\n | ApiPackageNode\n | EndpointNode\n | EndpointPairNode\n | WebSocketNode\n | WebhookNode\n | GrpcNode\n | GraphQlNode\n | GraphQlTypeNode\n | PageNode\n | LinkNode;\n\nexport interface WithNodeId {\n id: NodeId;\n collapsed: boolean | \"open-by-default\" | undefined;\n}\n\nexport interface WithPermissions {\n viewers: RoleId[] | undefined;\n orphaned: boolean | undefined;\n}\n\nexport interface WithFeatureFlags {\n featureFlags: FeatureFlagOptions[] | undefined;\n}\n\nexport interface WithNodeMetadata extends WithNodeId, WithPermissions, WithFeatureFlags {\n title: string;\n slug: Slug;\n canonicalSlug: Slug | undefined;\n icon: string | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface WithPage {\n pageId: PageId;\n noindex: boolean | undefined;\n}\n\nexport interface WithOverviewPage {\n overviewPageId: PageId | undefined;\n noindex: boolean | undefined;\n}\n\nexport interface WithApiDefinitionId {\n apiDefinitionId: ApiDefinitionId;\n availability: Availability | undefined;\n}\n\nexport interface WithRedirect {\n pointsTo: Slug | undefined;\n}\n\nexport interface FeatureFlagOptions {\n flag: string;\n fallbackValue: unknown | undefined;\n match: unknown | undefined;\n}\n\nexport interface BreadcrumbItem {\n title: string;\n pointsTo: Slug | undefined;\n}\n\nexport interface PlaygroundButtonSettings {\n href: Url | undefined;\n}\n\nexport interface PlaygroundSettings {\n environments: EnvironmentId[] | undefined;\n button: PlaygroundButtonSettings | undefined;\n \"limit-websocket-messages-per-connection\": number | undefined;\n hidden: boolean | undefined;\n // when true, optional parameters that declare a default (or x-fern-default) are\n // pre-filled and sent from the API Explorer playground. defaults to false.\n \"send-optional-defaults\": boolean | undefined;\n}\n\nexport type { GraphQlOperationType };\nexport type { GraphQlTypeCategory };\n\nexport interface ProductGroupNode extends WithNodeId {\n type: \"productgroup\";\n landingPage: LandingPageNode | undefined;\n children: ProductNode[];\n /** Site-level changelog shared by all products; slugged off the root, not shown in the product switcher. */\n changelog?: ChangelogNode | undefined;\n}\n\nexport interface VersionedNode extends WithNodeId {\n type: \"versioned\";\n children: VersionNode[];\n}\n\nexport interface UnversionedNode extends WithNodeId {\n type: \"unversioned\";\n child: VersionChild;\n landingPage: LandingPageNode | undefined;\n}\n\nexport interface VariantedNode extends WithNodeId {\n type: \"varianted\";\n children: VariantNode[];\n}\n\nexport interface TabbedNode extends WithNodeId {\n type: \"tabbed\";\n children: TabChild[];\n}\n\nexport interface SidebarRootNode extends WithNodeId {\n type: \"sidebarRoot\";\n children: SidebarRootChild[];\n}\n\nexport interface SidebarGroupNode extends WithNodeId {\n type: \"sidebarGroup\";\n children: NavigationChild[];\n}\n\nexport interface EndpointPairNode extends WithNodeId {\n type: \"endpointPair\";\n stream: EndpointNode;\n nonStream: EndpointNode;\n}\n\nexport interface LinkNode extends WithNodeId {\n type: \"link\";\n title: string;\n icon: string | undefined;\n url: Url;\n target: LinkTarget | undefined;\n}\n\nexport interface RootNode extends WithNodeMetadata, WithRedirect {\n type: \"root\";\n version: \"v2\";\n child: RootChild;\n roles: RoleId[] | undefined;\n}\n\nexport interface InternalProductNode extends WithNodeMetadata, WithRedirect {\n type: \"product\";\n default: boolean;\n productId: ProductId;\n child: ProductChild;\n subtitle: string;\n image: FileId | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface ExternalProductNode extends WithNodeId, WithPermissions, WithFeatureFlags {\n type: \"productLink\";\n default: boolean;\n productId: ProductId;\n title: string;\n href: Url;\n target: LinkTarget | undefined;\n subtitle: string;\n icon: string | undefined;\n image: FileId | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface VersionNode extends WithNodeMetadata, WithRedirect {\n type: \"version\";\n default: boolean;\n versionId: VersionId;\n child: VersionChild;\n availability: Availability | undefined;\n landingPage: LandingPageNode | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface VariantNode extends WithNodeMetadata, WithRedirect {\n type: \"variant\";\n default: boolean;\n variantId: VariantId;\n subtitle: string | undefined;\n image: FileId | undefined;\n children: VariantChild[];\n}\n\nexport interface TabNode extends WithNodeMetadata, WithRedirect {\n type: \"tab\";\n child: SidebarRootNode;\n}\n\nexport interface PageNode extends WithNodeMetadata, WithPage {\n type: \"page\";\n availability: Availability | undefined;\n}\n\nexport interface LandingPageNode extends WithNodeMetadata, WithPage {\n type: \"landingPage\";\n}\n\nexport interface SectionNode extends WithNodeMetadata, WithOverviewPage, WithRedirect {\n type: \"section\";\n collapsible: boolean | undefined;\n collapsedByDefault: boolean | undefined;\n children: NavigationChild[];\n availability: Availability | undefined;\n}\n\nexport interface ChangelogNode extends WithNodeMetadata, WithOverviewPage {\n type: \"changelog\";\n children: ChangelogYearNode[];\n}\n\nexport interface ChangelogYearNode extends WithNodeMetadata {\n type: \"changelogYear\";\n year: number;\n children: ChangelogMonthNode[];\n}\n\nexport interface ChangelogMonthNode extends WithNodeMetadata {\n type: \"changelogMonth\";\n month: number;\n children: ChangelogEntryNode[];\n}\n\nexport interface ChangelogEntryNode extends WithNodeMetadata, WithPage {\n type: \"changelogEntry\";\n date: string;\n tags: string[] | undefined;\n}\n\nexport interface ApiReferenceNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiReference\";\n paginated: boolean | undefined;\n showErrors: boolean | undefined;\n hideTitle: boolean | undefined;\n children: ApiPackageChild[];\n changelog: ChangelogNode | undefined;\n playground: PlaygroundSettings | undefined;\n postmanCollectionUrl: string | undefined;\n}\n\nexport interface EndpointNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"endpoint\";\n method: HttpMethod;\n endpointId: EndpointId;\n isResponseStream: boolean | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebSocketNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"webSocket\";\n webSocketId: WebSocketId;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebhookNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"webhook\";\n method: HttpMethod;\n webhookId: WebhookId;\n}\n\nexport interface GrpcNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"grpc\";\n method: GrpcMethod;\n grpcId: GrpcId;\n}\n\nexport interface GraphQlNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"graphql\";\n operationType: GraphQlOperationType;\n graphqlOperationId: GraphQlOperationId;\n /** Additional operation IDs when this node represents a namespace group (e.g. fieldPath grouping). */\n graphqlOperationIds: GraphQlOperationId[] | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\n/**\n * A navigation node representing a single GraphQL schema type (object, input,\n * enum, scalar, interface, or union) as opposed to a GraphQL operation.\n *\n * This node is a navigable leaf, mirroring {@link GraphQlNode}. Generating these\n * nodes from a schema (FER-10879) and rendering a dedicated type page\n * (FER-10880) are tracked separately.\n */\nexport interface GraphQlTypeNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"graphqlType\";\n typeId: TypeId;\n typeCategory: GraphQlTypeCategory;\n}\n\nexport interface ApiPackageNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiPackage\";\n children: ApiPackageChild[];\n playground: PlaygroundSettings | undefined;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA6BO,SAAS,KAAK,OAAqB;AACtC,SAAO;AACX;AAMO,SAAS,MAAM,OAAsB;AACxC,SAAO;AACX;AAMO,SAAS,OAAO,OAAuB;AAC1C,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/navigation/types/latest.ts"],"sourcesContent":["import type {\n EndpointId,\n EnvironmentId,\n FileId,\n GraphQlOperationId,\n GraphQlOperationType,\n GraphQlTypeCategory,\n TypeId,\n WebhookId,\n WebSocketId\n} from \"../../orpc-client/api/shared.js\";\nimport type {\n AnnouncementConfig,\n ApiDefinitionId,\n Availability,\n GrpcId,\n GrpcMethod,\n HttpMethod,\n LinkTarget,\n PageId,\n RoleId,\n Url,\n VersionId\n} from \"../../orpc-client/shared.js\";\n\nexport type Slug = string & {\n navigation_latest_Slug: void;\n};\n\nexport function Slug(value: string): Slug {\n return value as unknown as Slug;\n}\n\nexport type TabId = string & {\n navigation_latest_TabId: void;\n};\n\nexport function TabId(value: string): TabId {\n return value as unknown as TabId;\n}\n\nexport type NodeId = string & {\n navigation_latest_NodeId: void;\n};\n\nexport function NodeId(value: string): NodeId {\n return value as unknown as NodeId;\n}\n\nexport type ProductId = string & {\n navigation_latest_ProductId: void;\n};\n\nexport function ProductId(value: string): ProductId {\n return value as unknown as ProductId;\n}\n\nexport type VariantId = string & {\n navigation_latest_VariantId: void;\n};\n\nexport function VariantId(value: string): VariantId {\n return value as unknown as VariantId;\n}\n\nexport type RootChild = VersionedNode | UnversionedNode | ProductGroupNode;\n\nexport type ProductNode = InternalProductNode | ExternalProductNode;\n\nexport type ProductChild = VersionedNode | UnversionedNode;\n\nexport type VersionChild = TabbedNode | SidebarRootNode | VariantedNode;\n\nexport type VariantChild = ApiReferenceNode | SectionNode | SidebarGroupNode | PageNode | LinkNode | ChangelogNode;\n\nexport type TabChild = TabNode | LinkNode | ChangelogNode;\n\nexport type SidebarRootChild = SidebarGroupNode | ApiReferenceNode | SectionNode | VariantedNode;\n\nexport type NavigationChild = ApiReferenceNode | SectionNode | PageNode | LinkNode | ChangelogNode | VariantedNode;\n\nexport type ApiPackageChild =\n | ApiPackageNode\n | EndpointNode\n | EndpointPairNode\n | WebSocketNode\n | WebhookNode\n | GrpcNode\n | GraphQlNode\n | GraphQlTypeNode\n | PageNode\n | LinkNode;\n\nexport interface WithNodeId {\n id: NodeId;\n collapsed: boolean | \"open-by-default\" | undefined;\n}\n\nexport interface WithPermissions {\n viewers: RoleId[] | undefined;\n orphaned: boolean | undefined;\n}\n\nexport interface WithFeatureFlags {\n featureFlags: FeatureFlagOptions[] | undefined;\n}\n\nexport interface WithNodeMetadata extends WithNodeId, WithPermissions, WithFeatureFlags {\n title: string;\n slug: Slug;\n canonicalSlug: Slug | undefined;\n icon: string | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface WithPage {\n pageId: PageId;\n noindex: boolean | undefined;\n}\n\nexport interface WithOverviewPage {\n overviewPageId: PageId | undefined;\n noindex: boolean | undefined;\n}\n\nexport interface WithApiDefinitionId {\n apiDefinitionId: ApiDefinitionId;\n availability: Availability | undefined;\n}\n\nexport interface WithRedirect {\n pointsTo: Slug | undefined;\n}\n\nexport interface FeatureFlagOptions {\n flag: string;\n fallbackValue: unknown | undefined;\n match: unknown | undefined;\n}\n\nexport interface BreadcrumbItem {\n title: string;\n pointsTo: Slug | undefined;\n}\n\nexport interface PlaygroundButtonSettings {\n href: Url | undefined;\n}\n\nexport interface PlaygroundSettings {\n environments: EnvironmentId[] | undefined;\n button: PlaygroundButtonSettings | undefined;\n \"limit-websocket-messages-per-connection\": number | undefined;\n hidden: boolean | undefined;\n // when true, optional parameters that declare a default (or x-fern-default) are\n // pre-filled and sent from the API Explorer playground. defaults to false.\n \"send-optional-defaults\": boolean | undefined;\n}\n\nexport type { GraphQlOperationType };\nexport type { GraphQlTypeCategory };\n\nexport interface ProductGroupNode extends WithNodeId {\n type: \"productgroup\";\n landingPage: LandingPageNode | undefined;\n children: ProductNode[];\n /** Site-level changelog shared by all products; slugged off the root, not shown in the product switcher. */\n changelog?: ChangelogNode | undefined;\n}\n\nexport interface VersionedNode extends WithNodeId {\n type: \"versioned\";\n children: VersionNode[];\n}\n\nexport interface UnversionedNode extends WithNodeId {\n type: \"unversioned\";\n child: VersionChild;\n landingPage: LandingPageNode | undefined;\n}\n\nexport interface VariantedNode extends WithNodeId {\n type: \"varianted\";\n children: VariantNode[];\n}\n\nexport interface TabbedNode extends WithNodeId {\n type: \"tabbed\";\n children: TabChild[];\n}\n\nexport interface SidebarRootNode extends WithNodeId {\n type: \"sidebarRoot\";\n children: SidebarRootChild[];\n}\n\nexport interface SidebarGroupNode extends WithNodeId {\n type: \"sidebarGroup\";\n children: NavigationChild[];\n}\n\nexport interface EndpointPairNode extends WithNodeId {\n type: \"endpointPair\";\n stream: EndpointNode;\n nonStream: EndpointNode;\n}\n\nexport interface LinkNode extends WithNodeId {\n type: \"link\";\n title: string;\n icon: string | undefined;\n url: Url;\n target: LinkTarget | undefined;\n}\n\nexport interface RootNode extends WithNodeMetadata, WithRedirect {\n type: \"root\";\n version: \"v2\";\n child: RootChild;\n roles: RoleId[] | undefined;\n}\n\nexport interface InternalProductNode extends WithNodeMetadata, WithRedirect {\n type: \"product\";\n default: boolean;\n productId: ProductId;\n child: ProductChild;\n subtitle: string;\n image: FileId | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface ExternalProductNode extends WithNodeId, WithPermissions, WithFeatureFlags {\n type: \"productLink\";\n default: boolean;\n productId: ProductId;\n title: string;\n href: Url;\n target: LinkTarget | undefined;\n subtitle: string;\n icon: string | undefined;\n image: FileId | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface VersionNode extends WithNodeMetadata, WithRedirect {\n type: \"version\";\n default: boolean;\n versionId: VersionId;\n child: VersionChild;\n availability: Availability | undefined;\n landingPage: LandingPageNode | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface VariantNode extends WithNodeMetadata, WithRedirect {\n type: \"variant\";\n default: boolean;\n variantId: VariantId;\n subtitle: string | undefined;\n image: FileId | undefined;\n children: VariantChild[];\n}\n\nexport interface TabNode extends WithNodeMetadata, WithRedirect {\n type: \"tab\";\n child: SidebarRootNode;\n}\n\nexport interface PageNode extends WithNodeMetadata, WithPage {\n type: \"page\";\n availability: Availability | undefined;\n}\n\nexport interface LandingPageNode extends WithNodeMetadata, WithPage {\n type: \"landingPage\";\n}\n\nexport interface SectionNode extends WithNodeMetadata, WithOverviewPage, WithRedirect {\n type: \"section\";\n collapsible: boolean | undefined;\n collapsedByDefault: boolean | undefined;\n children: NavigationChild[];\n availability: Availability | undefined;\n}\n\nexport interface ChangelogNode extends WithNodeMetadata, WithOverviewPage {\n type: \"changelog\";\n children: ChangelogYearNode[];\n}\n\nexport interface ChangelogYearNode extends WithNodeMetadata {\n type: \"changelogYear\";\n year: number;\n children: ChangelogMonthNode[];\n}\n\nexport interface ChangelogMonthNode extends WithNodeMetadata {\n type: \"changelogMonth\";\n month: number;\n children: ChangelogEntryNode[];\n}\n\nexport interface ChangelogEntryNode extends WithNodeMetadata, WithPage {\n type: \"changelogEntry\";\n date: string;\n tags: string[] | undefined;\n}\n\nexport interface ApiReferenceNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiReference\";\n paginated: boolean | undefined;\n showErrors: boolean | undefined;\n hideTitle: boolean | undefined;\n children: ApiPackageChild[];\n changelog: ChangelogNode | undefined;\n playground: PlaygroundSettings | undefined;\n postmanCollectionUrl: string | undefined;\n}\n\nexport interface EndpointNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"endpoint\";\n method: HttpMethod;\n endpointId: EndpointId;\n isResponseStream: boolean | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebSocketNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"webSocket\";\n webSocketId: WebSocketId;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebhookNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"webhook\";\n method: HttpMethod;\n webhookId: WebhookId;\n}\n\nexport interface GrpcNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"grpc\";\n method: GrpcMethod;\n grpcId: GrpcId;\n}\n\nexport interface GraphQlNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"graphql\";\n operationType: GraphQlOperationType;\n graphqlOperationId: GraphQlOperationId;\n /** Additional operation IDs when this node represents a namespace group (e.g. fieldPath grouping). */\n graphqlOperationIds: GraphQlOperationId[] | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\n/**\n * A navigation node representing a single GraphQL schema type (object, input,\n * enum, scalar, interface, or union) as opposed to a GraphQL operation.\n *\n * This node is a navigable leaf, mirroring {@link GraphQlNode}. Generating these\n * nodes from a schema (FER-10879) and rendering a dedicated type page\n * (FER-10880) are tracked separately.\n */\nexport interface GraphQlTypeNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"graphqlType\";\n typeId: TypeId;\n typeCategory: GraphQlTypeCategory;\n}\n\nexport interface ApiPackageNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiPackage\";\n children: ApiPackageChild[];\n playground: PlaygroundSettings | undefined;\n}\n"],"mappings":";AA6BO,SAAS,KAAK,OAAqB;AACtC,SAAO;AACX;AAMO,SAAS,MAAM,OAAsB;AACxC,SAAO;AACX;AAMO,SAAS,OAAO,OAAuB;AAC1C,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../../../src/navigation/types/latest.ts"],"sourcesContent":["import type {\n EndpointId,\n EnvironmentId,\n FileId,\n GraphQlOperationId,\n GraphQlOperationType,\n GraphQlTypeCategory,\n TypeId,\n WebhookId,\n WebSocketId\n} from \"../../orpc-client/api/shared.js\";\nimport type {\n AnnouncementConfig,\n ApiDefinitionId,\n Availability,\n GrpcId,\n GrpcMethod,\n HttpMethod,\n LinkTarget,\n PageId,\n RoleId,\n Url,\n VersionId\n} from \"../../orpc-client/shared.js\";\n\nexport type Slug = string & {\n navigation_latest_Slug: void;\n};\n\nexport function Slug(value: string): Slug {\n return value as unknown as Slug;\n}\n\nexport type TabId = string & {\n navigation_latest_TabId: void;\n};\n\nexport function TabId(value: string): TabId {\n return value as unknown as TabId;\n}\n\nexport type NodeId = string & {\n navigation_latest_NodeId: void;\n};\n\nexport function NodeId(value: string): NodeId {\n return value as unknown as NodeId;\n}\n\nexport type ProductId = string & {\n navigation_latest_ProductId: void;\n};\n\nexport function ProductId(value: string): ProductId {\n return value as unknown as ProductId;\n}\n\nexport type VariantId = string & {\n navigation_latest_VariantId: void;\n};\n\nexport function VariantId(value: string): VariantId {\n return value as unknown as VariantId;\n}\n\nexport type RootChild = VersionedNode | UnversionedNode | ProductGroupNode;\n\nexport type ProductNode = InternalProductNode | ExternalProductNode;\n\nexport type ProductChild = VersionedNode | UnversionedNode;\n\nexport type VersionChild = TabbedNode | SidebarRootNode | VariantedNode;\n\nexport type VariantChild = ApiReferenceNode | SectionNode | SidebarGroupNode | PageNode | LinkNode | ChangelogNode;\n\nexport type TabChild = TabNode | LinkNode | ChangelogNode;\n\nexport type SidebarRootChild = SidebarGroupNode | ApiReferenceNode | SectionNode | VariantedNode;\n\nexport type NavigationChild = ApiReferenceNode | SectionNode | PageNode | LinkNode | ChangelogNode | VariantedNode;\n\nexport type ApiPackageChild =\n | ApiPackageNode\n | EndpointNode\n | EndpointPairNode\n | WebSocketNode\n | WebhookNode\n | GrpcNode\n | GraphQlNode\n | GraphQlTypeNode\n | PageNode\n | LinkNode;\n\nexport interface WithNodeId {\n id: NodeId;\n collapsed: boolean | \"open-by-default\" | undefined;\n}\n\nexport interface WithPermissions {\n viewers: RoleId[] | undefined;\n orphaned: boolean | undefined;\n}\n\nexport interface WithFeatureFlags {\n featureFlags: FeatureFlagOptions[] | undefined;\n}\n\nexport interface WithNodeMetadata extends WithNodeId, WithPermissions, WithFeatureFlags {\n title: string;\n slug: Slug;\n canonicalSlug: Slug | undefined;\n icon: string | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface WithPage {\n pageId: PageId;\n noindex: boolean | undefined;\n}\n\nexport interface WithOverviewPage {\n overviewPageId: PageId | undefined;\n noindex: boolean | undefined;\n}\n\nexport interface WithApiDefinitionId {\n apiDefinitionId: ApiDefinitionId;\n availability: Availability | undefined;\n}\n\nexport interface WithRedirect {\n pointsTo: Slug | undefined;\n}\n\nexport interface FeatureFlagOptions {\n flag: string;\n fallbackValue: unknown | undefined;\n match: unknown | undefined;\n}\n\nexport interface BreadcrumbItem {\n title: string;\n pointsTo: Slug | undefined;\n}\n\nexport interface PlaygroundButtonSettings {\n href: Url | undefined;\n}\n\nexport interface PlaygroundSettings {\n environments: EnvironmentId[] | undefined;\n button: PlaygroundButtonSettings | undefined;\n \"limit-websocket-messages-per-connection\": number | undefined;\n hidden: boolean | undefined;\n // when true, optional parameters that declare a default (or x-fern-default) are\n // pre-filled and sent from the API Explorer playground. defaults to false.\n \"send-optional-defaults\": boolean | undefined;\n}\n\nexport type { GraphQlOperationType };\nexport type { GraphQlTypeCategory };\n\nexport interface ProductGroupNode extends WithNodeId {\n type: \"productgroup\";\n landingPage: LandingPageNode | undefined;\n children: ProductNode[];\n /** Site-level changelog shared by all products; slugged off the root, not shown in the product switcher. */\n changelog?: ChangelogNode | undefined;\n}\n\nexport interface VersionedNode extends WithNodeId {\n type: \"versioned\";\n children: VersionNode[];\n}\n\nexport interface UnversionedNode extends WithNodeId {\n type: \"unversioned\";\n child: VersionChild;\n landingPage: LandingPageNode | undefined;\n}\n\nexport interface VariantedNode extends WithNodeId {\n type: \"varianted\";\n children: VariantNode[];\n}\n\nexport interface TabbedNode extends WithNodeId {\n type: \"tabbed\";\n children: TabChild[];\n}\n\nexport interface SidebarRootNode extends WithNodeId {\n type: \"sidebarRoot\";\n children: SidebarRootChild[];\n}\n\nexport interface SidebarGroupNode extends WithNodeId {\n type: \"sidebarGroup\";\n children: NavigationChild[];\n}\n\nexport interface EndpointPairNode extends WithNodeId {\n type: \"endpointPair\";\n stream: EndpointNode;\n nonStream: EndpointNode;\n}\n\nexport interface LinkNode extends WithNodeId {\n type: \"link\";\n title: string;\n icon: string | undefined;\n url: Url;\n target: LinkTarget | undefined;\n}\n\nexport interface RootNode extends WithNodeMetadata, WithRedirect {\n type: \"root\";\n version: \"v2\";\n child: RootChild;\n roles: RoleId[] | undefined;\n}\n\nexport interface InternalProductNode extends WithNodeMetadata, WithRedirect {\n type: \"product\";\n default: boolean;\n productId: ProductId;\n child: ProductChild;\n subtitle: string;\n image: FileId | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface ExternalProductNode extends WithNodeId, WithPermissions, WithFeatureFlags {\n type: \"productLink\";\n default: boolean;\n productId: ProductId;\n title: string;\n href: Url;\n target: LinkTarget | undefined;\n subtitle: string;\n icon: string | undefined;\n image: FileId | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface VersionNode extends WithNodeMetadata, WithRedirect {\n type: \"version\";\n default: boolean;\n versionId: VersionId;\n child: VersionChild;\n availability: Availability | undefined;\n landingPage: LandingPageNode | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface VariantNode extends WithNodeMetadata, WithRedirect {\n type: \"variant\";\n default: boolean;\n variantId: VariantId;\n subtitle: string | undefined;\n image: FileId | undefined;\n children: VariantChild[];\n}\n\nexport interface TabNode extends WithNodeMetadata, WithRedirect {\n type: \"tab\";\n child: SidebarRootNode;\n}\n\nexport interface PageNode extends WithNodeMetadata, WithPage {\n type: \"page\";\n availability: Availability | undefined;\n}\n\nexport interface LandingPageNode extends WithNodeMetadata, WithPage {\n type: \"landingPage\";\n}\n\nexport interface SectionNode extends WithNodeMetadata, WithOverviewPage, WithRedirect {\n type: \"section\";\n collapsible: boolean | undefined;\n collapsedByDefault: boolean | undefined;\n children: NavigationChild[];\n availability: Availability | undefined;\n}\n\nexport interface ChangelogNode extends WithNodeMetadata, WithOverviewPage {\n type: \"changelog\";\n children: ChangelogYearNode[];\n}\n\nexport interface ChangelogYearNode extends WithNodeMetadata {\n type: \"changelogYear\";\n year: number;\n children: ChangelogMonthNode[];\n}\n\nexport interface ChangelogMonthNode extends WithNodeMetadata {\n type: \"changelogMonth\";\n month: number;\n children: ChangelogEntryNode[];\n}\n\nexport interface ChangelogEntryNode extends WithNodeMetadata, WithPage {\n type: \"changelogEntry\";\n date: string;\n tags: string[] | undefined;\n}\n\nexport interface ApiReferenceNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiReference\";\n paginated: boolean | undefined;\n showErrors: boolean | undefined;\n hideTitle: boolean | undefined;\n children: ApiPackageChild[];\n changelog: ChangelogNode | undefined;\n playground: PlaygroundSettings | undefined;\n postmanCollectionUrl: string | undefined;\n}\n\nexport interface EndpointNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"endpoint\";\n method: HttpMethod;\n endpointId: EndpointId;\n isResponseStream: boolean | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebSocketNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"webSocket\";\n webSocketId: WebSocketId;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebhookNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"webhook\";\n method: HttpMethod;\n webhookId: WebhookId;\n}\n\nexport interface GrpcNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"grpc\";\n method: GrpcMethod;\n grpcId: GrpcId;\n}\n\nexport interface GraphQlNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"graphql\";\n operationType: GraphQlOperationType;\n graphqlOperationId: GraphQlOperationId;\n /** Additional operation IDs when this node represents a namespace group (e.g. fieldPath grouping). */\n graphqlOperationIds: GraphQlOperationId[] | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\n/**\n * A navigation node representing a single GraphQL schema type (object, input,\n * enum, scalar, interface, or union) as opposed to a GraphQL operation.\n *\n * This node is a navigable leaf, mirroring {@link GraphQlNode}. Generating these\n * nodes from a schema (FER-10879) and rendering a dedicated type page\n * (FER-10880) are tracked separately.\n */\nexport interface GraphQlTypeNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"graphqlType\";\n typeId: TypeId;\n typeCategory: GraphQlTypeCategory;\n}\n\nexport interface ApiPackageNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiPackage\";\n children: ApiPackageChild[];\n playground: PlaygroundSettings | undefined;\n}\n"],"mappings":";AA6BO,SAAS,KAAK,OAAqB;AACtC,SAAO;AACX;AAMO,SAAS,MAAM,OAAsB;AACxC,SAAO;AACX;AAMO,SAAS,OAAO,OAAuB;AAC1C,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/navigation/types/v1.ts"],"sourcesContent":["import type {\n EndpointId,\n EnvironmentId,\n FileId,\n GraphQlOperationId,\n GraphQlOperationType,\n GraphQlTypeCategory,\n TypeId,\n WebhookId,\n WebSocketId\n} from \"../../orpc-client/api/shared.js\";\nimport type {\n AnnouncementConfig,\n ApiDefinitionId,\n GrpcId,\n GrpcMethod,\n HttpMethod,\n LinkTarget,\n PageId,\n RoleId,\n Url,\n VersionId\n} from \"../../orpc-client/shared.js\";\nimport type { FeatureFlagOptions, WithFeatureFlags } from \"./latest.js\";\n\nexport type Slug = string & {\n navigation_v1_Slug: void;\n};\n\nexport function Slug(value: string): Slug {\n return value as unknown as Slug;\n}\n\nexport type TabId = string & {\n navigation_v1_TabId: void;\n};\n\nexport function TabId(value: string): TabId {\n return value as unknown as TabId;\n}\n\nexport type NodeId = string & {\n navigation_v1_NodeId: void;\n};\n\nexport function NodeId(value: string): NodeId {\n return value as unknown as NodeId;\n}\n\nexport type ProductId = string & {\n navigation_v1_ProductId: void;\n};\n\nexport function ProductId(value: string): ProductId {\n return value as unknown as ProductId;\n}\n\nexport type VariantId = string & {\n navigation_v1_VariantId: void;\n};\n\nexport function VariantId(value: string): VariantId {\n return value as unknown as VariantId;\n}\n\nexport const NavigationV1Availability = {\n Alpha: \"alpha\",\n Stable: \"stable\",\n GenerallyAvailable: \"generally-available\",\n InDevelopment: \"in-development\",\n PreRelease: \"pre-release\",\n Beta: \"beta\",\n Preview: \"preview\",\n Deprecated: \"deprecated\",\n Legacy: \"legacy\"\n} as const;\nexport type NavigationV1Availability = (typeof NavigationV1Availability)[keyof typeof NavigationV1Availability];\n\nexport type RootChild = VersionedNode | UnversionedNode | ProductGroupNode;\n\nexport type ProductNode = InternalProductNode | ExternalProductNode;\n\nexport type ProductChild = VersionedNode | UnversionedNode;\n\nexport type VersionChild = TabbedNode | SidebarRootNode | VariantedNode;\n\nexport type VariantChild = ApiReferenceNode | SectionNode | SidebarGroupNode | PageNode | LinkNode | ChangelogNode;\n\nexport type TabChild = TabNode | LinkNode | ChangelogNode;\n\nexport type SidebarRootChild = SidebarGroupNode | ApiReferenceNode | SectionNode | VariantedNode;\n\nexport type NavigationChild = ApiReferenceNode | SectionNode | PageNode | LinkNode | ChangelogNode | VariantedNode;\n\nexport type ApiPackageChild =\n | ApiPackageNode\n | EndpointNode\n | EndpointPairNode\n | WebSocketNode\n | WebhookNode\n | GrpcNode\n | GraphQlNode\n | GraphQlTypeNode\n | PageNode\n | LinkNode;\n\nexport interface WithNodeId {\n id: NodeId;\n collapsed: boolean | \"open-by-default\" | undefined;\n}\n\nexport interface WithPermissions {\n viewers: RoleId[] | undefined;\n orphaned: boolean | undefined;\n}\n\nexport interface WithNodeMetadata extends WithNodeId, WithPermissions, WithFeatureFlags {\n title: string;\n slug: Slug;\n icon: string | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface WithPage {\n pageId: PageId;\n noindex: boolean | undefined;\n}\n\nexport interface WithOverviewPage {\n overviewPageId: PageId | undefined;\n noindex: boolean | undefined;\n}\n\nexport interface WithApiDefinitionId {\n apiDefinitionId: ApiDefinitionId;\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface WithRedirect {\n pointsTo: Slug | undefined;\n}\n\nexport interface PlaygroundButtonSettings {\n href: Url | undefined;\n}\n\nexport interface PlaygroundSettings {\n environments: EnvironmentId[] | undefined;\n button: PlaygroundButtonSettings | undefined;\n \"limit-websocket-messages-per-connection\": number | undefined;\n hidden: boolean | undefined;\n // when true, optional parameters that declare a default (or x-fern-default) are\n // pre-filled and sent from the API Explorer playground. defaults to false.\n \"send-optional-defaults\": boolean | undefined;\n}\n\nexport type { GraphQlOperationType };\n\nexport interface ProductGroupNode extends WithNodeId {\n type: \"productgroup\";\n landingPage: LandingPageNode | undefined;\n children: ProductNode[];\n /** Site-level changelog shared by all products; slugged off the root, not shown in the product switcher. */\n changelog?: ChangelogNode | undefined;\n}\n\nexport interface VersionedNode extends WithNodeId {\n type: \"versioned\";\n children: VersionNode[];\n}\n\nexport interface UnversionedNode extends WithNodeId {\n type: \"unversioned\";\n child: VersionChild;\n landingPage: LandingPageNode | undefined;\n}\n\nexport interface VariantedNode extends WithNodeId {\n type: \"varianted\";\n children: VariantNode[];\n}\n\nexport interface TabbedNode extends WithNodeId {\n type: \"tabbed\";\n children: TabChild[];\n}\n\nexport interface SidebarRootNode extends WithNodeId {\n type: \"sidebarRoot\";\n children: SidebarRootChild[];\n}\n\nexport interface SidebarGroupNode extends WithNodeId {\n type: \"sidebarGroup\";\n children: NavigationChild[];\n}\n\nexport interface EndpointPairNode extends WithNodeId {\n type: \"endpointPair\";\n stream: EndpointNode;\n nonStream: EndpointNode;\n}\n\nexport interface LinkNode extends WithNodeId {\n type: \"link\";\n title: string;\n icon: string | undefined;\n url: Url;\n target: LinkTarget | undefined;\n}\n\nexport interface RootNode extends WithNodeMetadata, WithRedirect {\n type: \"root\";\n version: \"v1\";\n child: RootChild;\n roles: RoleId[] | undefined;\n}\n\nexport interface InternalProductNode extends WithNodeMetadata, WithRedirect {\n type: \"product\";\n default: boolean;\n productId: ProductId;\n child: ProductChild;\n subtitle: string;\n image: FileId | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface ExternalProductNode extends WithNodeId, WithPermissions {\n type: \"productLink\";\n default: boolean;\n productId: ProductId;\n title: string;\n href: Url;\n target: LinkTarget | undefined;\n subtitle: string;\n icon: string | undefined;\n image: FileId | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface VersionNode extends WithNodeMetadata, WithRedirect {\n type: \"version\";\n default: boolean;\n versionId: VersionId;\n child: VersionChild;\n availability: NavigationV1Availability | undefined;\n landingPage: LandingPageNode | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface VariantNode extends WithNodeMetadata, WithRedirect {\n type: \"variant\";\n default: boolean;\n variantId: VariantId;\n subtitle: string | undefined;\n image: FileId | undefined;\n children: VariantChild[];\n}\n\nexport interface TabNode extends WithNodeMetadata, WithRedirect {\n type: \"tab\";\n child: SidebarRootNode;\n}\n\nexport interface PageNode extends WithNodeMetadata, WithPage {\n type: \"page\";\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface LandingPageNode extends WithNodeMetadata, WithPage {\n type: \"landingPage\";\n}\n\nexport interface SectionNode extends WithNodeMetadata, WithOverviewPage, WithRedirect {\n type: \"section\";\n collapsible: boolean | undefined;\n collapsedByDefault: boolean | undefined;\n children: NavigationChild[];\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface ChangelogNode extends WithNodeMetadata, WithOverviewPage {\n type: \"changelog\";\n children: ChangelogYearNode[];\n}\n\nexport interface ChangelogYearNode extends WithNodeMetadata {\n type: \"changelogYear\";\n year: number;\n children: ChangelogMonthNode[];\n}\n\nexport interface ChangelogMonthNode extends WithNodeMetadata {\n type: \"changelogMonth\";\n month: number;\n children: ChangelogEntryNode[];\n}\n\nexport interface ChangelogEntryNode extends WithNodeMetadata, WithPage {\n type: \"changelogEntry\";\n date: string;\n tags: string[] | undefined;\n}\n\nexport interface ApiReferenceNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiReference\";\n paginated: boolean | undefined;\n showErrors: boolean | undefined;\n hideTitle: boolean | undefined;\n children: ApiPackageChild[];\n changelog: ChangelogNode | undefined;\n playground: PlaygroundSettings | undefined;\n postmanCollectionUrl: string | undefined;\n}\n\nexport interface EndpointNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"endpoint\";\n method: HttpMethod;\n endpointId: EndpointId;\n isResponseStream: boolean | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebSocketNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"webSocket\";\n webSocketId: WebSocketId;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebhookNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"webhook\";\n method: HttpMethod;\n webhookId: WebhookId;\n}\n\nexport interface GrpcNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"grpc\";\n method: GrpcMethod;\n grpcId: GrpcId;\n}\n\nexport interface GraphQlNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"graphql\";\n operationType: GraphQlOperationType;\n graphqlOperationId: GraphQlOperationId;\n /** Additional operation IDs when this node represents a namespace group (e.g. fieldPath grouping). */\n graphqlOperationIds: GraphQlOperationId[] | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\n/**\n * A navigation node representing a single GraphQL schema type (object, input,\n * enum, scalar, interface, or union) as opposed to a GraphQL operation.\n *\n * Mirrors {@link FernNavigation.GraphQlTypeNode} in the latest model; this is the\n * shape the CLI writes, which the v1 -> latest migrator converts.\n */\nexport interface GraphQlTypeNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"graphqlType\";\n typeId: TypeId;\n typeCategory: GraphQlTypeCategory;\n}\n\nexport interface ApiPackageNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiPackage\";\n children: ApiPackageChild[];\n playground: PlaygroundSettings | undefined;\n}\n\nexport { type FeatureFlagOptions, type WithFeatureFlags };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA6BO,SAAS,KAAK,OAAqB;AACtC,SAAO;AACX;AAMO,SAAS,MAAM,OAAsB;AACxC,SAAO;AACX;AAMO,SAAS,OAAO,OAAuB;AAC1C,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAEO,IAAM,2BAA2B;AAAA,EACpC,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,oBAAoB;AAAA,EACpB,eAAe;AAAA,EACf,YAAY;AAAA,EACZ,MAAM;AAAA,EACN,SAAS;AAAA,EACT,YAAY;AAAA,EACZ,QAAQ;AACZ;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../../../src/navigation/types/v1.ts"],"sourcesContent":["import type {\n EndpointId,\n EnvironmentId,\n FileId,\n GraphQlOperationId,\n GraphQlOperationType,\n GraphQlTypeCategory,\n TypeId,\n WebhookId,\n WebSocketId\n} from \"../../orpc-client/api/shared.js\";\nimport type {\n AnnouncementConfig,\n ApiDefinitionId,\n GrpcId,\n GrpcMethod,\n HttpMethod,\n LinkTarget,\n PageId,\n RoleId,\n Url,\n VersionId\n} from \"../../orpc-client/shared.js\";\nimport type { FeatureFlagOptions, WithFeatureFlags } from \"./latest.js\";\n\nexport type Slug = string & {\n navigation_v1_Slug: void;\n};\n\nexport function Slug(value: string): Slug {\n return value as unknown as Slug;\n}\n\nexport type TabId = string & {\n navigation_v1_TabId: void;\n};\n\nexport function TabId(value: string): TabId {\n return value as unknown as TabId;\n}\n\nexport type NodeId = string & {\n navigation_v1_NodeId: void;\n};\n\nexport function NodeId(value: string): NodeId {\n return value as unknown as NodeId;\n}\n\nexport type ProductId = string & {\n navigation_v1_ProductId: void;\n};\n\nexport function ProductId(value: string): ProductId {\n return value as unknown as ProductId;\n}\n\nexport type VariantId = string & {\n navigation_v1_VariantId: void;\n};\n\nexport function VariantId(value: string): VariantId {\n return value as unknown as VariantId;\n}\n\nexport const NavigationV1Availability = {\n Alpha: \"alpha\",\n Stable: \"stable\",\n GenerallyAvailable: \"generally-available\",\n InDevelopment: \"in-development\",\n PreRelease: \"pre-release\",\n Beta: \"beta\",\n Preview: \"preview\",\n Deprecated: \"deprecated\",\n Legacy: \"legacy\"\n} as const;\nexport type NavigationV1Availability = (typeof NavigationV1Availability)[keyof typeof NavigationV1Availability];\n\nexport type RootChild = VersionedNode | UnversionedNode | ProductGroupNode;\n\nexport type ProductNode = InternalProductNode | ExternalProductNode;\n\nexport type ProductChild = VersionedNode | UnversionedNode;\n\nexport type VersionChild = TabbedNode | SidebarRootNode | VariantedNode;\n\nexport type VariantChild = ApiReferenceNode | SectionNode | SidebarGroupNode | PageNode | LinkNode | ChangelogNode;\n\nexport type TabChild = TabNode | LinkNode | ChangelogNode;\n\nexport type SidebarRootChild = SidebarGroupNode | ApiReferenceNode | SectionNode | VariantedNode;\n\nexport type NavigationChild = ApiReferenceNode | SectionNode | PageNode | LinkNode | ChangelogNode | VariantedNode;\n\nexport type ApiPackageChild =\n | ApiPackageNode\n | EndpointNode\n | EndpointPairNode\n | WebSocketNode\n | WebhookNode\n | GrpcNode\n | GraphQlNode\n | GraphQlTypeNode\n | PageNode\n | LinkNode;\n\nexport interface WithNodeId {\n id: NodeId;\n collapsed: boolean | \"open-by-default\" | undefined;\n}\n\nexport interface WithPermissions {\n viewers: RoleId[] | undefined;\n orphaned: boolean | undefined;\n}\n\nexport interface WithNodeMetadata extends WithNodeId, WithPermissions, WithFeatureFlags {\n title: string;\n slug: Slug;\n icon: string | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface WithPage {\n pageId: PageId;\n noindex: boolean | undefined;\n}\n\nexport interface WithOverviewPage {\n overviewPageId: PageId | undefined;\n noindex: boolean | undefined;\n}\n\nexport interface WithApiDefinitionId {\n apiDefinitionId: ApiDefinitionId;\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface WithRedirect {\n pointsTo: Slug | undefined;\n}\n\nexport interface PlaygroundButtonSettings {\n href: Url | undefined;\n}\n\nexport interface PlaygroundSettings {\n environments: EnvironmentId[] | undefined;\n button: PlaygroundButtonSettings | undefined;\n \"limit-websocket-messages-per-connection\": number | undefined;\n hidden: boolean | undefined;\n // when true, optional parameters that declare a default (or x-fern-default) are\n // pre-filled and sent from the API Explorer playground. defaults to false.\n \"send-optional-defaults\": boolean | undefined;\n}\n\nexport type { GraphQlOperationType };\n\nexport interface ProductGroupNode extends WithNodeId {\n type: \"productgroup\";\n landingPage: LandingPageNode | undefined;\n children: ProductNode[];\n /** Site-level changelog shared by all products; slugged off the root, not shown in the product switcher. */\n changelog?: ChangelogNode | undefined;\n}\n\nexport interface VersionedNode extends WithNodeId {\n type: \"versioned\";\n children: VersionNode[];\n}\n\nexport interface UnversionedNode extends WithNodeId {\n type: \"unversioned\";\n child: VersionChild;\n landingPage: LandingPageNode | undefined;\n}\n\nexport interface VariantedNode extends WithNodeId {\n type: \"varianted\";\n children: VariantNode[];\n}\n\nexport interface TabbedNode extends WithNodeId {\n type: \"tabbed\";\n children: TabChild[];\n}\n\nexport interface SidebarRootNode extends WithNodeId {\n type: \"sidebarRoot\";\n children: SidebarRootChild[];\n}\n\nexport interface SidebarGroupNode extends WithNodeId {\n type: \"sidebarGroup\";\n children: NavigationChild[];\n}\n\nexport interface EndpointPairNode extends WithNodeId {\n type: \"endpointPair\";\n stream: EndpointNode;\n nonStream: EndpointNode;\n}\n\nexport interface LinkNode extends WithNodeId {\n type: \"link\";\n title: string;\n icon: string | undefined;\n url: Url;\n target: LinkTarget | undefined;\n}\n\nexport interface RootNode extends WithNodeMetadata, WithRedirect {\n type: \"root\";\n version: \"v1\";\n child: RootChild;\n roles: RoleId[] | undefined;\n}\n\nexport interface InternalProductNode extends WithNodeMetadata, WithRedirect {\n type: \"product\";\n default: boolean;\n productId: ProductId;\n child: ProductChild;\n subtitle: string;\n image: FileId | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface ExternalProductNode extends WithNodeId, WithPermissions {\n type: \"productLink\";\n default: boolean;\n productId: ProductId;\n title: string;\n href: Url;\n target: LinkTarget | undefined;\n subtitle: string;\n icon: string | undefined;\n image: FileId | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface VersionNode extends WithNodeMetadata, WithRedirect {\n type: \"version\";\n default: boolean;\n versionId: VersionId;\n child: VersionChild;\n availability: NavigationV1Availability | undefined;\n landingPage: LandingPageNode | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface VariantNode extends WithNodeMetadata, WithRedirect {\n type: \"variant\";\n default: boolean;\n variantId: VariantId;\n subtitle: string | undefined;\n image: FileId | undefined;\n children: VariantChild[];\n}\n\nexport interface TabNode extends WithNodeMetadata, WithRedirect {\n type: \"tab\";\n child: SidebarRootNode;\n}\n\nexport interface PageNode extends WithNodeMetadata, WithPage {\n type: \"page\";\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface LandingPageNode extends WithNodeMetadata, WithPage {\n type: \"landingPage\";\n}\n\nexport interface SectionNode extends WithNodeMetadata, WithOverviewPage, WithRedirect {\n type: \"section\";\n collapsible: boolean | undefined;\n collapsedByDefault: boolean | undefined;\n children: NavigationChild[];\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface ChangelogNode extends WithNodeMetadata, WithOverviewPage {\n type: \"changelog\";\n children: ChangelogYearNode[];\n}\n\nexport interface ChangelogYearNode extends WithNodeMetadata {\n type: \"changelogYear\";\n year: number;\n children: ChangelogMonthNode[];\n}\n\nexport interface ChangelogMonthNode extends WithNodeMetadata {\n type: \"changelogMonth\";\n month: number;\n children: ChangelogEntryNode[];\n}\n\nexport interface ChangelogEntryNode extends WithNodeMetadata, WithPage {\n type: \"changelogEntry\";\n date: string;\n tags: string[] | undefined;\n}\n\nexport interface ApiReferenceNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiReference\";\n paginated: boolean | undefined;\n showErrors: boolean | undefined;\n hideTitle: boolean | undefined;\n children: ApiPackageChild[];\n changelog: ChangelogNode | undefined;\n playground: PlaygroundSettings | undefined;\n postmanCollectionUrl: string | undefined;\n}\n\nexport interface EndpointNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"endpoint\";\n method: HttpMethod;\n endpointId: EndpointId;\n isResponseStream: boolean | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebSocketNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"webSocket\";\n webSocketId: WebSocketId;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebhookNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"webhook\";\n method: HttpMethod;\n webhookId: WebhookId;\n}\n\nexport interface GrpcNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"grpc\";\n method: GrpcMethod;\n grpcId: GrpcId;\n}\n\nexport interface GraphQlNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"graphql\";\n operationType: GraphQlOperationType;\n graphqlOperationId: GraphQlOperationId;\n /** Additional operation IDs when this node represents a namespace group (e.g. fieldPath grouping). */\n graphqlOperationIds: GraphQlOperationId[] | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\n/**\n * A navigation node representing a single GraphQL schema type (object, input,\n * enum, scalar, interface, or union) as opposed to a GraphQL operation.\n *\n * Mirrors {@link FernNavigation.GraphQlTypeNode} in the latest model; this is the\n * shape the CLI writes, which the v1 -> latest migrator converts.\n */\nexport interface GraphQlTypeNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"graphqlType\";\n typeId: TypeId;\n typeCategory: GraphQlTypeCategory;\n}\n\nexport interface ApiPackageNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiPackage\";\n children: ApiPackageChild[];\n playground: PlaygroundSettings | undefined;\n}\n\nexport { type FeatureFlagOptions, type WithFeatureFlags };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA6BO,SAAS,KAAK,OAAqB;AACtC,SAAO;AACX;AAMO,SAAS,MAAM,OAAsB;AACxC,SAAO;AACX;AAMO,SAAS,OAAO,OAAuB;AAC1C,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAEO,IAAM,2BAA2B;AAAA,EACpC,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,oBAAoB;AAAA,EACpB,eAAe;AAAA,EACf,YAAY;AAAA,EACZ,MAAM;AAAA,EACN,SAAS;AAAA,EACT,YAAY;AAAA,EACZ,QAAQ;AACZ;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/navigation/types/v1.ts"],"sourcesContent":["import type {\n EndpointId,\n EnvironmentId,\n FileId,\n GraphQlOperationId,\n GraphQlOperationType,\n GraphQlTypeCategory,\n TypeId,\n WebhookId,\n WebSocketId\n} from \"../../orpc-client/api/shared.js\";\nimport type {\n AnnouncementConfig,\n ApiDefinitionId,\n GrpcId,\n GrpcMethod,\n HttpMethod,\n LinkTarget,\n PageId,\n RoleId,\n Url,\n VersionId\n} from \"../../orpc-client/shared.js\";\nimport type { FeatureFlagOptions, WithFeatureFlags } from \"./latest.js\";\n\nexport type Slug = string & {\n navigation_v1_Slug: void;\n};\n\nexport function Slug(value: string): Slug {\n return value as unknown as Slug;\n}\n\nexport type TabId = string & {\n navigation_v1_TabId: void;\n};\n\nexport function TabId(value: string): TabId {\n return value as unknown as TabId;\n}\n\nexport type NodeId = string & {\n navigation_v1_NodeId: void;\n};\n\nexport function NodeId(value: string): NodeId {\n return value as unknown as NodeId;\n}\n\nexport type ProductId = string & {\n navigation_v1_ProductId: void;\n};\n\nexport function ProductId(value: string): ProductId {\n return value as unknown as ProductId;\n}\n\nexport type VariantId = string & {\n navigation_v1_VariantId: void;\n};\n\nexport function VariantId(value: string): VariantId {\n return value as unknown as VariantId;\n}\n\nexport const NavigationV1Availability = {\n Alpha: \"alpha\",\n Stable: \"stable\",\n GenerallyAvailable: \"generally-available\",\n InDevelopment: \"in-development\",\n PreRelease: \"pre-release\",\n Beta: \"beta\",\n Preview: \"preview\",\n Deprecated: \"deprecated\",\n Legacy: \"legacy\"\n} as const;\nexport type NavigationV1Availability = (typeof NavigationV1Availability)[keyof typeof NavigationV1Availability];\n\nexport type RootChild = VersionedNode | UnversionedNode | ProductGroupNode;\n\nexport type ProductNode = InternalProductNode | ExternalProductNode;\n\nexport type ProductChild = VersionedNode | UnversionedNode;\n\nexport type VersionChild = TabbedNode | SidebarRootNode | VariantedNode;\n\nexport type VariantChild = ApiReferenceNode | SectionNode | SidebarGroupNode | PageNode | LinkNode | ChangelogNode;\n\nexport type TabChild = TabNode | LinkNode | ChangelogNode;\n\nexport type SidebarRootChild = SidebarGroupNode | ApiReferenceNode | SectionNode | VariantedNode;\n\nexport type NavigationChild = ApiReferenceNode | SectionNode | PageNode | LinkNode | ChangelogNode | VariantedNode;\n\nexport type ApiPackageChild =\n | ApiPackageNode\n | EndpointNode\n | EndpointPairNode\n | WebSocketNode\n | WebhookNode\n | GrpcNode\n | GraphQlNode\n | GraphQlTypeNode\n | PageNode\n | LinkNode;\n\nexport interface WithNodeId {\n id: NodeId;\n collapsed: boolean | \"open-by-default\" | undefined;\n}\n\nexport interface WithPermissions {\n viewers: RoleId[] | undefined;\n orphaned: boolean | undefined;\n}\n\nexport interface WithNodeMetadata extends WithNodeId, WithPermissions, WithFeatureFlags {\n title: string;\n slug: Slug;\n icon: string | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface WithPage {\n pageId: PageId;\n noindex: boolean | undefined;\n}\n\nexport interface WithOverviewPage {\n overviewPageId: PageId | undefined;\n noindex: boolean | undefined;\n}\n\nexport interface WithApiDefinitionId {\n apiDefinitionId: ApiDefinitionId;\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface WithRedirect {\n pointsTo: Slug | undefined;\n}\n\nexport interface PlaygroundButtonSettings {\n href: Url | undefined;\n}\n\nexport interface PlaygroundSettings {\n environments: EnvironmentId[] | undefined;\n button: PlaygroundButtonSettings | undefined;\n \"limit-websocket-messages-per-connection\": number | undefined;\n hidden: boolean | undefined;\n // when true, optional parameters that declare a default (or x-fern-default) are\n // pre-filled and sent from the API Explorer playground. defaults to false.\n \"send-optional-defaults\": boolean | undefined;\n}\n\nexport type { GraphQlOperationType };\n\nexport interface ProductGroupNode extends WithNodeId {\n type: \"productgroup\";\n landingPage: LandingPageNode | undefined;\n children: ProductNode[];\n /** Site-level changelog shared by all products; slugged off the root, not shown in the product switcher. */\n changelog?: ChangelogNode | undefined;\n}\n\nexport interface VersionedNode extends WithNodeId {\n type: \"versioned\";\n children: VersionNode[];\n}\n\nexport interface UnversionedNode extends WithNodeId {\n type: \"unversioned\";\n child: VersionChild;\n landingPage: LandingPageNode | undefined;\n}\n\nexport interface VariantedNode extends WithNodeId {\n type: \"varianted\";\n children: VariantNode[];\n}\n\nexport interface TabbedNode extends WithNodeId {\n type: \"tabbed\";\n children: TabChild[];\n}\n\nexport interface SidebarRootNode extends WithNodeId {\n type: \"sidebarRoot\";\n children: SidebarRootChild[];\n}\n\nexport interface SidebarGroupNode extends WithNodeId {\n type: \"sidebarGroup\";\n children: NavigationChild[];\n}\n\nexport interface EndpointPairNode extends WithNodeId {\n type: \"endpointPair\";\n stream: EndpointNode;\n nonStream: EndpointNode;\n}\n\nexport interface LinkNode extends WithNodeId {\n type: \"link\";\n title: string;\n icon: string | undefined;\n url: Url;\n target: LinkTarget | undefined;\n}\n\nexport interface RootNode extends WithNodeMetadata, WithRedirect {\n type: \"root\";\n version: \"v1\";\n child: RootChild;\n roles: RoleId[] | undefined;\n}\n\nexport interface InternalProductNode extends WithNodeMetadata, WithRedirect {\n type: \"product\";\n default: boolean;\n productId: ProductId;\n child: ProductChild;\n subtitle: string;\n image: FileId | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface ExternalProductNode extends WithNodeId, WithPermissions {\n type: \"productLink\";\n default: boolean;\n productId: ProductId;\n title: string;\n href: Url;\n target: LinkTarget | undefined;\n subtitle: string;\n icon: string | undefined;\n image: FileId | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface VersionNode extends WithNodeMetadata, WithRedirect {\n type: \"version\";\n default: boolean;\n versionId: VersionId;\n child: VersionChild;\n availability: NavigationV1Availability | undefined;\n landingPage: LandingPageNode | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface VariantNode extends WithNodeMetadata, WithRedirect {\n type: \"variant\";\n default: boolean;\n variantId: VariantId;\n subtitle: string | undefined;\n image: FileId | undefined;\n children: VariantChild[];\n}\n\nexport interface TabNode extends WithNodeMetadata, WithRedirect {\n type: \"tab\";\n child: SidebarRootNode;\n}\n\nexport interface PageNode extends WithNodeMetadata, WithPage {\n type: \"page\";\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface LandingPageNode extends WithNodeMetadata, WithPage {\n type: \"landingPage\";\n}\n\nexport interface SectionNode extends WithNodeMetadata, WithOverviewPage, WithRedirect {\n type: \"section\";\n collapsible: boolean | undefined;\n collapsedByDefault: boolean | undefined;\n children: NavigationChild[];\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface ChangelogNode extends WithNodeMetadata, WithOverviewPage {\n type: \"changelog\";\n children: ChangelogYearNode[];\n}\n\nexport interface ChangelogYearNode extends WithNodeMetadata {\n type: \"changelogYear\";\n year: number;\n children: ChangelogMonthNode[];\n}\n\nexport interface ChangelogMonthNode extends WithNodeMetadata {\n type: \"changelogMonth\";\n month: number;\n children: ChangelogEntryNode[];\n}\n\nexport interface ChangelogEntryNode extends WithNodeMetadata, WithPage {\n type: \"changelogEntry\";\n date: string;\n tags: string[] | undefined;\n}\n\nexport interface ApiReferenceNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiReference\";\n paginated: boolean | undefined;\n showErrors: boolean | undefined;\n hideTitle: boolean | undefined;\n children: ApiPackageChild[];\n changelog: ChangelogNode | undefined;\n playground: PlaygroundSettings | undefined;\n postmanCollectionUrl: string | undefined;\n}\n\nexport interface EndpointNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"endpoint\";\n method: HttpMethod;\n endpointId: EndpointId;\n isResponseStream: boolean | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebSocketNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"webSocket\";\n webSocketId: WebSocketId;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebhookNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"webhook\";\n method: HttpMethod;\n webhookId: WebhookId;\n}\n\nexport interface GrpcNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"grpc\";\n method: GrpcMethod;\n grpcId: GrpcId;\n}\n\nexport interface GraphQlNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"graphql\";\n operationType: GraphQlOperationType;\n graphqlOperationId: GraphQlOperationId;\n /** Additional operation IDs when this node represents a namespace group (e.g. fieldPath grouping). */\n graphqlOperationIds: GraphQlOperationId[] | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\n/**\n * A navigation node representing a single GraphQL schema type (object, input,\n * enum, scalar, interface, or union) as opposed to a GraphQL operation.\n *\n * Mirrors {@link FernNavigation.GraphQlTypeNode} in the latest model; this is the\n * shape the CLI writes, which the v1 -> latest migrator converts.\n */\nexport interface GraphQlTypeNode extends WithNodeMetadata, WithApiDefinitionId {\n type: \"graphqlType\";\n typeId: TypeId;\n typeCategory: GraphQlTypeCategory;\n}\n\nexport interface ApiPackageNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiPackage\";\n children: ApiPackageChild[];\n playground: PlaygroundSettings | undefined;\n}\n\nexport { type FeatureFlagOptions, type WithFeatureFlags };\n"],"mappings":";AA6BO,SAAS,KAAK,OAAqB;AACtC,SAAO;AACX;AAMO,SAAS,MAAM,OAAsB;AACxC,SAAO;AACX;AAMO,SAAS,OAAO,OAAuB;AAC1C,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAEO,IAAM,2BAA2B;AAAA,EACpC,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,oBAAoB;AAAA,EACpB,eAAe;AAAA,EACf,YAAY;AAAA,EACZ,MAAM;AAAA,EACN,SAAS;AAAA,EACT,YAAY;AAAA,EACZ,QAAQ;AACZ;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../../../src/navigation/types/v1.ts"],"sourcesContent":["import type {\n EndpointId,\n EnvironmentId,\n FileId,\n GraphQlOperationId,\n GraphQlOperationType,\n GraphQlTypeCategory,\n TypeId,\n WebhookId,\n WebSocketId\n} from \"../../orpc-client/api/shared.js\";\nimport type {\n AnnouncementConfig,\n ApiDefinitionId,\n GrpcId,\n GrpcMethod,\n HttpMethod,\n LinkTarget,\n PageId,\n RoleId,\n Url,\n VersionId\n} from \"../../orpc-client/shared.js\";\nimport type { FeatureFlagOptions, WithFeatureFlags } from \"./latest.js\";\n\nexport type Slug = string & {\n navigation_v1_Slug: void;\n};\n\nexport function Slug(value: string): Slug {\n return value as unknown as Slug;\n}\n\nexport type TabId = string & {\n navigation_v1_TabId: void;\n};\n\nexport function TabId(value: string): TabId {\n return value as unknown as TabId;\n}\n\nexport type NodeId = string & {\n navigation_v1_NodeId: void;\n};\n\nexport function NodeId(value: string): NodeId {\n return value as unknown as NodeId;\n}\n\nexport type ProductId = string & {\n navigation_v1_ProductId: void;\n};\n\nexport function ProductId(value: string): ProductId {\n return value as unknown as ProductId;\n}\n\nexport type VariantId = string & {\n navigation_v1_VariantId: void;\n};\n\nexport function VariantId(value: string): VariantId {\n return value as unknown as VariantId;\n}\n\nexport const NavigationV1Availability = {\n Alpha: \"alpha\",\n Stable: \"stable\",\n GenerallyAvailable: \"generally-available\",\n InDevelopment: \"in-development\",\n PreRelease: \"pre-release\",\n Beta: \"beta\",\n Preview: \"preview\",\n Deprecated: \"deprecated\",\n Legacy: \"legacy\"\n} as const;\nexport type NavigationV1Availability = (typeof NavigationV1Availability)[keyof typeof NavigationV1Availability];\n\nexport type RootChild = VersionedNode | UnversionedNode | ProductGroupNode;\n\nexport type ProductNode = InternalProductNode | ExternalProductNode;\n\nexport type ProductChild = VersionedNode | UnversionedNode;\n\nexport type VersionChild = TabbedNode | SidebarRootNode | VariantedNode;\n\nexport type VariantChild = ApiReferenceNode | SectionNode | SidebarGroupNode | PageNode | LinkNode | ChangelogNode;\n\nexport type TabChild = TabNode | LinkNode | ChangelogNode;\n\nexport type SidebarRootChild = SidebarGroupNode | ApiReferenceNode | SectionNode | VariantedNode;\n\nexport type NavigationChild = ApiReferenceNode | SectionNode | PageNode | LinkNode | ChangelogNode | VariantedNode;\n\nexport type ApiPackageChild =\n | ApiPackageNode\n | EndpointNode\n | EndpointPairNode\n | WebSocketNode\n | WebhookNode\n | GrpcNode\n | GraphQlNode\n | GraphQlTypeNode\n | PageNode\n | LinkNode;\n\nexport interface WithNodeId {\n id: NodeId;\n collapsed: boolean | \"open-by-default\" | undefined;\n}\n\nexport interface WithPermissions {\n viewers: RoleId[] | undefined;\n orphaned: boolean | undefined;\n}\n\nexport interface WithNodeMetadata extends WithNodeId, WithPermissions, WithFeatureFlags {\n title: string;\n slug: Slug;\n icon: string | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface WithPage {\n pageId: PageId;\n noindex: boolean | undefined;\n}\n\nexport interface WithOverviewPage {\n overviewPageId: PageId | undefined;\n noindex: boolean | undefined;\n}\n\nexport interface WithApiDefinitionId {\n apiDefinitionId: ApiDefinitionId;\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface WithRedirect {\n pointsTo: Slug | undefined;\n}\n\nexport interface PlaygroundButtonSettings {\n href: Url | undefined;\n}\n\nexport interface PlaygroundSettings {\n environments: EnvironmentId[] | undefined;\n button: PlaygroundButtonSettings | undefined;\n \"limit-websocket-messages-per-connection\": number | undefined;\n hidden: boolean | undefined;\n // when true, optional parameters that declare a default (or x-fern-default) are\n // pre-filled and sent from the API Explorer playground. defaults to false.\n \"send-optional-defaults\": boolean | undefined;\n}\n\nexport type { GraphQlOperationType };\n\nexport interface ProductGroupNode extends WithNodeId {\n type: \"productgroup\";\n landingPage: LandingPageNode | undefined;\n children: ProductNode[];\n /** Site-level changelog shared by all products; slugged off the root, not shown in the product switcher. */\n changelog?: ChangelogNode | undefined;\n}\n\nexport interface VersionedNode extends WithNodeId {\n type: \"versioned\";\n children: VersionNode[];\n}\n\nexport interface UnversionedNode extends WithNodeId {\n type: \"unversioned\";\n child: VersionChild;\n landingPage: LandingPageNode | undefined;\n}\n\nexport interface VariantedNode extends WithNodeId {\n type: \"varianted\";\n children: VariantNode[];\n}\n\nexport interface TabbedNode extends WithNodeId {\n type: \"tabbed\";\n children: TabChild[];\n}\n\nexport interface SidebarRootNode extends WithNodeId {\n type: \"sidebarRoot\";\n children: SidebarRootChild[];\n}\n\nexport interface SidebarGroupNode extends WithNodeId {\n type: \"sidebarGroup\";\n children: NavigationChild[];\n}\n\nexport interface EndpointPairNode extends WithNodeId {\n type: \"endpointPair\";\n stream: EndpointNode;\n nonStream: EndpointNode;\n}\n\nexport interface LinkNode extends WithNodeId {\n type: \"link\";\n title: string;\n icon: string | undefined;\n url: Url;\n target: LinkTarget | undefined;\n}\n\nexport interface RootNode extends WithNodeMetadata, WithRedirect {\n type: \"root\";\n version: \"v1\";\n child: RootChild;\n roles: RoleId[] | undefined;\n}\n\nexport interface InternalProductNode extends WithNodeMetadata, WithRedirect {\n type: \"product\";\n default: boolean;\n productId: ProductId;\n child: ProductChild;\n subtitle: string;\n image: FileId | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface ExternalProductNode extends WithNodeId, WithPermissions {\n type: \"productLink\";\n default: boolean;\n productId: ProductId;\n title: string;\n href: Url;\n target: LinkTarget | undefined;\n subtitle: string;\n icon: string | undefined;\n image: FileId | undefined;\n hidden: boolean | undefined;\n authed: boolean | undefined;\n}\n\nexport interface VersionNode extends WithNodeMetadata, WithRedirect {\n type: \"version\";\n default: boolean;\n versionId: VersionId;\n child: VersionChild;\n availability: NavigationV1Availability | undefined;\n landingPage: LandingPageNode | undefined;\n announcement: AnnouncementConfig | undefined;\n}\n\nexport interface VariantNode extends WithNodeMetadata, WithRedirect {\n type: \"variant\";\n default: boolean;\n variantId: VariantId;\n subtitle: string | undefined;\n image: FileId | undefined;\n children: VariantChild[];\n}\n\nexport interface TabNode extends WithNodeMetadata, WithRedirect {\n type: \"tab\";\n child: SidebarRootNode;\n}\n\nexport interface PageNode extends WithNodeMetadata, WithPage {\n type: \"page\";\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface LandingPageNode extends WithNodeMetadata, WithPage {\n type: \"landingPage\";\n}\n\nexport interface SectionNode extends WithNodeMetadata, WithOverviewPage, WithRedirect {\n type: \"section\";\n collapsible: boolean | undefined;\n collapsedByDefault: boolean | undefined;\n children: NavigationChild[];\n availability: NavigationV1Availability | undefined;\n}\n\nexport interface ChangelogNode extends WithNodeMetadata, WithOverviewPage {\n type: \"changelog\";\n children: ChangelogYearNode[];\n}\n\nexport interface ChangelogYearNode extends WithNodeMetadata {\n type: \"changelogYear\";\n year: number;\n children: ChangelogMonthNode[];\n}\n\nexport interface ChangelogMonthNode extends WithNodeMetadata {\n type: \"changelogMonth\";\n month: number;\n children: ChangelogEntryNode[];\n}\n\nexport interface ChangelogEntryNode extends WithNodeMetadata, WithPage {\n type: \"changelogEntry\";\n date: string;\n tags: string[] | undefined;\n}\n\nexport interface ApiReferenceNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiReference\";\n paginated: boolean | undefined;\n showErrors: boolean | undefined;\n hideTitle: boolean | undefined;\n children: ApiPackageChild[];\n changelog: ChangelogNode | undefined;\n playground: PlaygroundSettings | undefined;\n postmanCollectionUrl: string | undefined;\n}\n\nexport interface EndpointNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"endpoint\";\n method: HttpMethod;\n endpointId: EndpointId;\n isResponseStream: boolean | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebSocketNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"webSocket\";\n webSocketId: WebSocketId;\n playground: PlaygroundSettings | undefined;\n}\n\nexport interface WebhookNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"webhook\";\n method: HttpMethod;\n webhookId: WebhookId;\n}\n\nexport interface GrpcNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"grpc\";\n method: GrpcMethod;\n grpcId: GrpcId;\n}\n\nexport interface GraphQlNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"graphql\";\n operationType: GraphQlOperationType;\n graphqlOperationId: GraphQlOperationId;\n /** Additional operation IDs when this node represents a namespace group (e.g. fieldPath grouping). */\n graphqlOperationIds: GraphQlOperationId[] | undefined;\n playground: PlaygroundSettings | undefined;\n}\n\n/**\n * A navigation node representing a single GraphQL schema type (object, input,\n * enum, scalar, interface, or union) as opposed to a GraphQL operation.\n *\n * Mirrors {@link FernNavigation.GraphQlTypeNode} in the latest model; this is the\n * shape the CLI writes, which the v1 -> latest migrator converts.\n */\nexport interface GraphQlTypeNode extends WithNodeMetadata, WithApiDefinitionId {\n noindex?: boolean | undefined;\n type: \"graphqlType\";\n typeId: TypeId;\n typeCategory: GraphQlTypeCategory;\n}\n\nexport interface ApiPackageNode extends WithNodeMetadata, WithOverviewPage, WithApiDefinitionId, WithRedirect {\n type: \"apiPackage\";\n children: ApiPackageChild[];\n playground: PlaygroundSettings | undefined;\n}\n\nexport { type FeatureFlagOptions, type WithFeatureFlags };\n"],"mappings":";AA6BO,SAAS,KAAK,OAAqB;AACtC,SAAO;AACX;AAMO,SAAS,MAAM,OAAsB;AACxC,SAAO;AACX;AAMO,SAAS,OAAO,OAAuB;AAC1C,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAMO,SAAS,UAAU,OAA0B;AAChD,SAAO;AACX;AAEO,IAAM,2BAA2B;AAAA,EACpC,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,oBAAoB;AAAA,EACpB,eAAe;AAAA,EACf,YAAY;AAAA,EACZ,MAAM;AAAA,EACN,SAAS;AAAA,EACT,YAAY;AAAA,EACZ,QAAQ;AACZ;","names":[]}
|
|
@@ -187,6 +187,7 @@ __export(latest_exports, {
|
|
|
187
187
|
isLeaf: () => isLeaf,
|
|
188
188
|
isMarkdownLeaf: () => isMarkdownLeaf,
|
|
189
189
|
isNeighbor: () => isNeighbor,
|
|
190
|
+
isNoindexNode: () => isNoindexNode,
|
|
190
191
|
isPage: () => isPage,
|
|
191
192
|
isProductGroupNode: () => isProductGroupNode,
|
|
192
193
|
isProductNode: () => isProductNode,
|
|
@@ -1040,6 +1041,26 @@ function isInternalProductNode(node) {
|
|
|
1040
1041
|
return node.type === "product";
|
|
1041
1042
|
}
|
|
1042
1043
|
|
|
1044
|
+
// src/navigation/versions/latest/NavigationNodeSection.ts
|
|
1045
|
+
function isSection(node) {
|
|
1046
|
+
return node.type === "section" || node.type === "apiReference" || node.type === "changelog" || node.type === "apiPackage";
|
|
1047
|
+
}
|
|
1048
|
+
|
|
1049
|
+
// src/navigation/versions/latest/NavigationNodeSectionOverview.ts
|
|
1050
|
+
function isSectionOverview(node) {
|
|
1051
|
+
return isSection(node) && node.overviewPageId != null;
|
|
1052
|
+
}
|
|
1053
|
+
|
|
1054
|
+
// src/navigation/versions/latest/NavigationNodeMarkdown.ts
|
|
1055
|
+
function hasMarkdown(node) {
|
|
1056
|
+
return isMarkdownLeaf(node) || isSectionOverview(node);
|
|
1057
|
+
}
|
|
1058
|
+
|
|
1059
|
+
// src/navigation/versions/latest/isNoindexNode.ts
|
|
1060
|
+
function isNoindexNode(node) {
|
|
1061
|
+
return (hasMarkdown(node) || isApiLeaf(node)) && node.noindex === true;
|
|
1062
|
+
}
|
|
1063
|
+
|
|
1043
1064
|
// src/navigation/versions/latest/isProductGroupNode.ts
|
|
1044
1065
|
function isProductGroupNode(node) {
|
|
1045
1066
|
return node.type === "productgroup";
|
|
@@ -1080,21 +1101,6 @@ function isVersionNode(node) {
|
|
|
1080
1101
|
return node.type === "version";
|
|
1081
1102
|
}
|
|
1082
1103
|
|
|
1083
|
-
// src/navigation/versions/latest/NavigationNodeSection.ts
|
|
1084
|
-
function isSection(node) {
|
|
1085
|
-
return node.type === "section" || node.type === "apiReference" || node.type === "changelog" || node.type === "apiPackage";
|
|
1086
|
-
}
|
|
1087
|
-
|
|
1088
|
-
// src/navigation/versions/latest/NavigationNodeSectionOverview.ts
|
|
1089
|
-
function isSectionOverview(node) {
|
|
1090
|
-
return isSection(node) && node.overviewPageId != null;
|
|
1091
|
-
}
|
|
1092
|
-
|
|
1093
|
-
// src/navigation/versions/latest/NavigationNodeMarkdown.ts
|
|
1094
|
-
function hasMarkdown(node) {
|
|
1095
|
-
return isMarkdownLeaf(node) || isSectionOverview(node);
|
|
1096
|
-
}
|
|
1097
|
-
|
|
1098
1104
|
// src/navigation/versions/latest/NavigationNodeNeighbor.ts
|
|
1099
1105
|
function isNeighbor(node) {
|
|
1100
1106
|
return isApiLeaf(node) || node.type === "page" || node.type === "changelog" || node.type === "changelogEntry" || isSectionOverview(node);
|
|
@@ -1366,6 +1372,7 @@ function traverseDF(node, visit) {
|
|
|
1366
1372
|
isLeaf,
|
|
1367
1373
|
isMarkdownLeaf,
|
|
1368
1374
|
isNeighbor,
|
|
1375
|
+
isNoindexNode,
|
|
1369
1376
|
isPage,
|
|
1370
1377
|
isProductGroupNode,
|
|
1371
1378
|
isProductNode,
|