chore(cli): bump fdr version to enable websocket playground limiting

docs-yml.schema.json

@@ -879,6 +879,16 @@
               "type": "null"
             }
           ]
+        },
+        "limit-websocket-messages-per-connection": {
+          "oneOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "additionalProperties": false

fern/apis/docs-yml/definition/docs.yml

@@ -974,6 +974,10 @@ types:
           If not provided, all environments are allowed. And if the provided list is empty, the playground should be disabled.
       button: optional<PlaygroundButtonSettings>
       oauth: optional<boolean>
+      "limit-websocket-messages-per-connection":
+        type: optional<integer>
+        docs: |
+          The maximum number of websocket messages per connection in the playground.
 
   PlaygroundButtonSettings:
     properties:

packages/cli/cli/versions.yml

@@ -1,7 +1,15 @@
 - changelogEntry:
-    - summary: |
-        The Fern CLI temporarily does not support RBAC/Audiences (they will be added in again shortly). 
-      type: internal
+  - summary: |
+      - enables `limit-websocket-messages-per-connection` in playground settings for websockets.
+        this allows for the limiting of received messages per websocket connection in the playground for a demo.
+    type: feat
+  irVersion: 53
+  version: 0.45.0-rc26
+
+- changelogEntry:
+  - summary: |
+      The Fern CLI temporarily does not support RBAC/Audiences (they will be added in again shortly). 
+    type: internal
   irVersion: 53
   version: 0.45.0-rc25
 

packages/cli/configuration/package.json

@@ -32,7 +32,7 @@
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/task-context": "workspace:*",
     "@fern-api/fern-definition-schema": "workspace:*",
-    "@fern-fern/fdr-cjs-sdk": "0.0.5833",
+    "@fern-fern/fdr-cjs-sdk": "0.121.2-9e12414a0", 
     "@fern-fern/fiddle-sdk": "0.0.584",
     "@fern-fern/generators-sdk": "0.114.0-5745f9e74",
     "find-up": "^6.3.0",

packages/cli/configuration/src/docs-yml/schemas/sdk/api/resources/docs/types/PlaygroundSettings.ts

@@ -9,4 +9,6 @@ export interface PlaygroundSettings {
     environments?: string[];
     button?: FernDocsConfig.PlaygroundButtonSettings;
     oauth?: boolean;
+    /** The maximum number of websocket messages per connection in the playground. */
+    limitWebsocketMessagesPerConnection?: number;
 }

packages/cli/configuration/src/docs-yml/schemas/sdk/serialization/resources/docs/types/PlaygroundSettings.ts

@@ -13,12 +13,17 @@ export const PlaygroundSettings: core.serialization.ObjectSchema<
     environments: core.serialization.list(core.serialization.string()).optional(),
     button: core.serialization.lazyObject(async () => (await import("../../..")).PlaygroundButtonSettings).optional(),
     oauth: core.serialization.boolean().optional(),
+    limitWebsocketMessagesPerConnection: core.serialization.property(
+        "limit-websocket-messages-per-connection",
+        core.serialization.number().optional()
+    ),
 });
 
 export declare namespace PlaygroundSettings {
     interface Raw {
         environments?: string[] | null;
         button?: serializers.PlaygroundButtonSettings.Raw | null;
         oauth?: boolean | null;
+        "limit-websocket-messages-per-connection"?: number | null;
     }
 }

packages/cli/configuration/src/generators-yml/schemas/core/schemas/utils/isPlainObject.ts

@@ -1,15 +1,15 @@
 // borrowed from https://github.com/lodash/lodash/blob/master/isPlainObject.js
 export function isPlainObject(value: unknown): value is Record<string, unknown> {
-    if (typeof value !== "object" || value === null) {
+    if (typeof value !== "object" || value == null) {
         return false;
     }
 
-    if (Object.getPrototypeOf(value) === null) {
+    if (Object.getPrototypeOf(value) == null) {
         return true;
     }
 
     let proto = value;
-    while (Object.getPrototypeOf(proto) !== null) {
+    while (Object.getPrototypeOf(proto) != null) {
         proto = Object.getPrototypeOf(proto);
     }
 

packages/cli/docs-importers/commons/package.json

@@ -31,7 +31,7 @@
     "@fern-api/configuration": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/task-context": "workspace:*",
-    "@fern-fern/fdr-cjs-sdk": "0.111.0-51d403bce",
+    "@fern-fern/fdr-cjs-sdk": "0.121.2-9e12414a0",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {

packages/cli/docs-importers/mintlify/package.json

@@ -34,7 +34,7 @@
     "@fern-api/task-context": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/logger": "workspace:*",
-    "@fern-fern/fdr-cjs-sdk": "0.111.0-51d403bce",
+    "@fern-fern/fdr-cjs-sdk": "0.121.2-9e12414a0",
     "gray-matter": "^4.0.3"
   },
   "devDependencies": {

packages/cli/docs-markdown-utils/package.json

@@ -30,7 +30,7 @@
   "dependencies": {
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/task-context": "workspace:*",
-    "@fern-fern/fdr-cjs-sdk": "0.0.5833",
+    "@fern-fern/fdr-cjs-sdk": "0.121.2-9e12414a0",
     "gray-matter": "^4.0.3",
     "mdast-util-from-markdown": "^2.0.1",
     "mdast-util-mdx": "^3.0.0",

packages/cli/docs-preview/package.json

@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@fern-api/docs-resolver": "workspace:*",
-    "@fern-api/fdr-sdk": "0.115.0-3cf21db72",
+    "@fern-api/fdr-sdk": "0.121.2-9e12414a0",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/ir-sdk": "workspace:*",
     "@fern-api/logger": "workspace:*",

packages/cli/docs-preview/src/previewDocs.ts

@@ -1,4 +1,5 @@
 import { DocsDefinitionResolver } from "@fern-api/docs-resolver";
+
 import {
     APIV1Read,
     APIV1Write,
@@ -105,7 +106,7 @@ class ReferencedAPICollector {
     }: {
         ir: IntermediateRepresentation;
         snippetsConfig: APIV1Write.SnippetsConfig;
-        playgroundConfig?: DocsV1Read.PlaygroundConfig;
+        playgroundConfig?: { oauth?: boolean };
     }): APIDefinitionID {
         try {
             const id = uuidv4();

packages/cli/docs-preview/src/runPreviewServer.ts

@@ -39,8 +39,7 @@ const EMPTY_DOCS_DEFINITION: DocsV1Read.DocsDefinition = {
         analyticsConfig: undefined,
         integrations: undefined,
         css: undefined,
-        js: undefined,
-        playground: undefined
+        js: undefined
     },
     search: {
         type: "legacyMultiAlgoliaIndex",

packages/cli/docs-resolver/package.json

@@ -30,8 +30,8 @@
     "@fern-api/configuration": "workspace:*",
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/docs-markdown-utils": "workspace:*",
-    "@fern-api/fdr-sdk": "0.115.0-3cf21db72",
-    "@fern-api/ui-core-utils": "0.115.0-3cf21db72",
+    "@fern-api/fdr-sdk": "0.121.2-9e12414a0",
+    "@fern-api/ui-core-utils": "0.121.2-9e12414a0",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/ir-generator": "workspace:*",
     "@fern-api/ir-sdk": "workspace:*",

packages/cli/docs-resolver/src/ApiReferenceNodeConverter.ts

@@ -670,6 +670,10 @@ export class ApiReferenceNodeConverter {
                 button:
                     playgroundSettings.button != null && playgroundSettings.button.href
                         ? { href: FernNavigation.V1.Url(playgroundSettings.button.href) }
+                        : undefined,
+                "limit-websocket-messages-per-connection":
+                    playgroundSettings.limitWebsocketMessagesPerConnection != null
+                        ? playgroundSettings.limitWebsocketMessagesPerConnection
                         : undefined
             };
         }

packages/cli/docs-resolver/src/DocsDefinitionResolver.ts

@@ -37,14 +37,16 @@ export interface UploadedFile extends FilePathPair {
     fileId: string;
 }
 
+export type PlaygroundConfig = Pick<docsYml.RawSchemas.PlaygroundSettings, "oauth">;
+
 type AsyncOrSync<T> = T | Promise<T>;
 
 type UploadFilesFn = (files: FilePathPair[]) => AsyncOrSync<UploadedFile[]>;
 
 type RegisterApiFn = (opts: {
     ir: IntermediateRepresentation;
     snippetsConfig: APIV1Write.SnippetsConfig;
-    playgroundConfig?: DocsV1Write.PlaygroundConfig;
+    playgroundConfig?: PlaygroundConfig;
     apiName?: string;
 }) => AsyncOrSync<string>;
 
@@ -315,7 +317,6 @@ export class DocsDefinitionResolver {
                 this.parsedDocsConfig.announcement != null
                     ? { text: this.parsedDocsConfig.announcement.message }
                     : undefined,
-            playground: undefined,
             // deprecated
             logo: undefined,
             logoV2: undefined,

packages/cli/docs-resolver/src/utils/convertIrToApiDefinition.ts

@@ -7,6 +7,7 @@ import {
 } from "@fern-api/fdr-sdk";
 import { IntermediateRepresentation } from "@fern-api/ir-sdk";
 import { convertIrToFdrApi } from "@fern-api/register";
+import { PlaygroundConfig } from "../DocsDefinitionResolver";
 
 const EMPTY_SNIPPET_HOLDER = new SDKSnippetHolder({
     snippetsBySdkId: {},
@@ -19,7 +20,7 @@ const EMPTY_SNIPPET_HOLDER = new SDKSnippetHolder({
 export function convertIrToApiDefinition(
     ir: IntermediateRepresentation,
     apiDefinitionId: string,
-    playgroundConfig?: DocsV1Read.PlaygroundConfig
+    playgroundConfig?: PlaygroundConfig
 ): APIV1Read.ApiDefinition {
     // the navigation constructor doesn't need to know about snippets, so we can pass an empty object
     return convertDbAPIDefinitionToRead(

packages/cli/ete-tests/package.json

@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@fern-api/configuration": "workspace:*",
-    "@fern-fern/fdr-cjs-sdk": "0.0.5833",
+    "@fern-fern/fdr-cjs-sdk": "0.121.2-9e12414a0",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/logging-execa": "workspace:*",
     "@fern-typescript/fetcher": "workspace:*",

packages/cli/generation/remote-generation/remote-workspace-runner/package.json

@@ -34,7 +34,7 @@
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/docs-resolver": "workspace:*",
     "@fern-api/logging-execa": "workspace:*",
-    "@fern-fern/fdr-cjs-sdk": "0.0.5833",
+    "@fern-fern/fdr-cjs-sdk": "0.121.2-9e12414a0",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/ir-generator": "workspace:*",
     "@fern-api/ir-migrations": "workspace:*",

packages/cli/register/package.json

@@ -32,7 +32,7 @@
     "@fern-api/configuration": "workspace:*",
     "@fern-api/core": "workspace:*",
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/fdr-cjs-sdk": "0.0.5833",
+    "@fern-fern/fdr-cjs-sdk": "0.121.2-9e12414a0",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/ir-generator": "workspace:*",
     "@fern-api/ir-sdk": "workspace:*",
@@ -43,7 +43,7 @@
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "18.7.18",
+    "@types/node": "18.7.18", 
     "depcheck": "^1.4.6",
     "eslint": "^8.56.0",
     "globals": "link:@types/vitest/globals",

packages/cli/register/src/ir-to-fdr-converter/covertAuth.ts → packages/cli/register/src/ir-to-fdr-converter/convertAuth.ts

@@ -1,7 +1,10 @@
 import { assertNever } from "@fern-api/core-utils";
 import { FernIr as Ir } from "@fern-api/ir-sdk";
 import { FernRegistry as FdrCjsSdk } from "@fern-fern/fdr-cjs-sdk";
-import { PlaygroundConfig } from "@fern-fern/fdr-cjs-sdk/api/resources/docs/resources/v1/resources/commons";
+
+export interface PlaygroundConfig {
+    oauth?: boolean;
+};
 
 export function convertAuth(
     auth: Ir.auth.ApiAuth,

packages/cli/register/src/ir-to-fdr-converter/convertIrToFdrApi.ts

@@ -1,9 +1,8 @@
 import { IntermediateRepresentation } from "@fern-api/ir-sdk";
 import { FernRegistry as FdrCjsSdk } from "@fern-fern/fdr-cjs-sdk";
-import { PlaygroundConfig } from "@fern-fern/fdr-cjs-sdk/api/resources/docs/resources/v1/resources/commons";
 import { convertIrAvailability, convertPackage } from "./convertPackage";
 import { convertTypeReference, convertTypeShape } from "./convertTypeShape";
-import { convertAuth } from "./covertAuth";
+import { convertAuth, PlaygroundConfig } from "./convertAuth";
 
 export function convertIrToFdrApi({
     ir,

packages/cli/register/src/registerApi.ts

@@ -6,8 +6,8 @@ import { IntermediateRepresentation } from "@fern-api/ir-sdk";
 import { TaskContext } from "@fern-api/task-context";
 import { FernWorkspace } from "@fern-api/api-workspace-commons";
 import { FernRegistry as FdrCjsSdk } from "@fern-fern/fdr-cjs-sdk";
-import { PlaygroundConfig } from "@fern-fern/fdr-cjs-sdk/api/resources/docs/resources/v1/resources/commons";
 import { convertIrToFdrApi } from "./ir-to-fdr-converter/convertIrToFdrApi";
+import { PlaygroundConfig } from "./ir-to-fdr-converter/convertAuth";
 
 export async function registerApi({
     organization,

packages/core/package.json

@@ -28,14 +28,14 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/fdr-cjs-sdk": "0.0.5833",
+    "@fern-fern/fdr-cjs-sdk": "0.121.2-9e12414a0",
     "@fern-fern/generators-sdk": "0.114.0-5745f9e74",
     "@fern-api/venus-api-sdk": "0.0.38",
     "@fern-fern/fdr-test-sdk": "^0.0.5297",
     "@fern-fern/fiddle-sdk": "0.0.584"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.12",
+    "@types/jest": "^29.5.12", 
     "@types/node": "18.7.18",
     "depcheck": "^1.4.6",
     "eslint": "^8.56.0",