@crvouga/mockingbird-service-formbricks 1.7.1 → 2.0.0

package/openapi.yaml

@@ -0,0 +1,555 @@
+openapi: 3.1.0
+info:
+  title: Formbricks client + management API (Mockingbird subset)
+  description: |
+    Stateful mock subset of open-source Formbricks (6.x): the client environment state (surveys)
+    and response creation the JS SDK uses, the v1 management API for responses and surveys
+    (`x-api-key`), and the widget script the web SDK loads. Errors use Formbricks' v1
+    `{code, message, details}` shape (`apps/web/app/lib/api/response.ts`). Client routes take a
+    workspace id or a legacy (pre-5) environment id in the path.
+  version: "1"
+  x-mockingbird-upstream:
+    note: >-
+      Hand-authored from upstream Formbricks 6.0.0 (https://github.com/formbricks/formbricks):
+      apps/web/app/api/v1/client/[workspaceId]/environment, apps/web/app/api/v2/client/[workspaceId]/responses,
+      apps/web/app/api/v1/management/{responses,surveys}, and the response pipeline's webhook body
+      (apps/web/modules/response-pipeline). Docs: https://formbricks.com/docs
+servers:
+  - url: https://app.formbricks.com
+paths:
+  /api/v1/client/{workspaceId}/environment:
+    parameters:
+      - $ref: "#/components/parameters/WorkspaceId"
+    get:
+      operationId: GetEnvironmentState
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: The environment state the SDK caches (surveys, action classes, project)
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [data]
+                properties:
+                  data:
+                    type: object
+                    required: [data, expiresAt]
+                    properties:
+                      data:
+                        type: object
+                        required: [surveys, actionClasses, project]
+                        properties:
+                          surveys:
+                            type: array
+                            items:
+                              $ref: "#/components/schemas/Survey"
+                          actionClasses:
+                            type: array
+                            items:
+                              type: object
+                          project:
+                            type: object
+                      expiresAt:
+                        type: string
+                        x-mockingbird-volatile:
+                          kind: timestamp
+        "400":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /api/v2/client/{workspaceId}/responses:
+    parameters:
+      - $ref: "#/components/parameters/WorkspaceId"
+    post:
+      operationId: CreateClientResponse
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [surveyId, finished, data]
+              properties:
+                surveyId:
+                  type: string
+                  x-mockingbird-resource-ref:
+                    type: survey
+                    missing: czzzzzzzzzzzzzzzzzzzzzzzz
+                finished:
+                  type: boolean
+                data:
+                  $ref: "#/components/schemas/ResponseData"
+                contactId:
+                  type: ["string", "null"]
+                displayId:
+                  type: ["string", "null"]
+                singleUseId:
+                  type: ["string", "null"]
+                endingId:
+                  type: ["string", "null"]
+                language:
+                  type: string
+                  maxLength: 10
+                variables:
+                  type: object
+                ttc:
+                  type: object
+                  additionalProperties:
+                    type: number
+                meta:
+                  type: object
+                  properties:
+                    source:
+                      type: string
+                    url:
+                      type: string
+                    action:
+                      type: string
+                    pagePath:
+                      type: string
+                    utmSource:
+                      type: string
+      responses:
+        "200":
+          description: The created response's id
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [data]
+                properties:
+                  data:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        x-mockingbird-resource:
+                          type: response
+                          identity: true
+                      quotaFull:
+                        type: boolean
+        "400":
+          $ref: "#/components/responses/Error"
+        "403":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /api/v1/management/responses:
+    get:
+      operationId: ListResponses
+      security:
+        - apiKey: []
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      parameters:
+        - name: surveyId
+          in: query
+          schema:
+            type: string
+            x-mockingbird-resource-ref:
+              type: survey
+              missing: czzzzzzzzzzzzzzzzzzzzzzzz
+        - name: limit
+          in: query
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+        - name: skip
+          in: query
+          schema:
+            type: integer
+            minimum: 0
+            maximum: 100
+      responses:
+        "200":
+          description: Responses, newest first
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [data]
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/Response"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /api/v1/management/responses/{responseId}:
+    parameters:
+      - name: responseId
+        in: path
+        required: true
+        schema:
+          type: string
+          x-mockingbird-resource-ref:
+            type: response
+            missing: czzzzzzzzzzzzzzzzzzzzzzzy
+    get:
+      operationId: GetResponse
+      security:
+        - apiKey: []
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: One response
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [data]
+                properties:
+                  data:
+                    $ref: "#/components/schemas/Response"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /api/v1/management/surveys:
+    get:
+      operationId: ListSurveys
+      security:
+        - apiKey: []
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      parameters:
+        - name: limit
+          in: query
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+        - name: offset
+          in: query
+          schema:
+            type: integer
+            minimum: 0
+            maximum: 100
+      responses:
+        "200":
+          description: Surveys, most recently updated first
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [data]
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/Survey"
+        "401":
+          $ref: "#/components/responses/Error"
+    post:
+      operationId: CreateSurvey
+      security:
+        - apiKey: []
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [workspaceId, name, blocks]
+              properties:
+                workspaceId:
+                  description: A workspace id, or (as `environmentId`) a legacy environment id.
+                  type: string
+                  enum: [cworkspace000000000000001, cenvironment0000000000001]
+                name:
+                  type: string
+                  minLength: 1
+                  maxLength: 80
+                type:
+                  type: string
+                  enum: [app, link]
+                status:
+                  type: string
+                  enum: [draft, inProgress, paused, completed]
+                blocks:
+                  description: >-
+                    The survey's blocks of elements. The legacy `questions` array (one element per
+                    block) is also accepted, but not together with `blocks`.
+                  type: array
+                  minItems: 1
+                  maxItems: 3
+                  items:
+                    type: object
+                    required: [id, elements]
+                    properties:
+                      id:
+                        type: string
+                        minLength: 1
+                        maxLength: 30
+                      name:
+                        type: string
+                        maxLength: 30
+                      elements:
+                        type: array
+                        minItems: 1
+                        maxItems: 3
+                        items:
+                          $ref: "#/components/schemas/Element"
+      responses:
+        "200":
+          description: The created survey
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [data]
+                properties:
+                  data:
+                    $ref: "#/components/schemas/Survey"
+        "400":
+          $ref: "#/components/responses/Error"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /api/v1/management/surveys/{surveyId}:
+    parameters:
+      - name: surveyId
+        in: path
+        required: true
+        schema:
+          type: string
+          x-mockingbird-resource-ref:
+            type: survey
+            missing: czzzzzzzzzzzzzzzzzzzzzzzz
+    get:
+      operationId: GetSurvey
+      security:
+        - apiKey: []
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: One survey
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [data]
+                properties:
+                  data:
+                    $ref: "#/components/schemas/Survey"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /js/formbricks.umd.cjs:
+    get:
+      operationId: GetWidgetScript
+      description: The widget bundle the web SDK loads; served as a no-op script.
+      security: []
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: A no-op script defining `window.formbricks`
+          content:
+            application/javascript:
+              schema:
+                type: string
+components:
+  securitySchemes:
+    apiKey:
+      type: apiKey
+      in: header
+      name: x-api-key
+  parameters:
+    WorkspaceId:
+      name: workspaceId
+      in: path
+      required: true
+      description: A workspace id, or a legacy (pre-Formbricks-5) environment id.
+      schema:
+        type: string
+        enum: [cworkspace000000000000001, cenvironment0000000000001]
+  responses:
+    Error:
+      description: Formbricks' v1 `{code, message, details}` error
+      content:
+        application/json:
+          schema:
+            type: object
+            required: [code, message, details]
+            properties:
+              code:
+                type: string
+                enum:
+                  - not_found
+                  - gone
+                  - bad_request
+                  - internal_server_error
+                  - unauthorized
+                  - method_not_allowed
+                  - not_authenticated
+                  - forbidden
+                  - too_many_requests
+                  - conflict
+                  - payload_too_large
+              message:
+                type: string
+              details:
+                type: object
+  schemas:
+    ResponseData:
+      type: object
+      maxProperties: 5
+      additionalProperties:
+        anyOf:
+          - type: string
+            maxLength: 60
+          - type: number
+          - type: array
+            maxItems: 3
+            items:
+              type: string
+              maxLength: 30
+          - type: object
+            maxProperties: 3
+            additionalProperties:
+              type: string
+              maxLength: 30
+    Element:
+      type: object
+      required: [id, type, headline]
+      properties:
+        id:
+          type: string
+          minLength: 1
+          maxLength: 30
+        type:
+          type: string
+          enum: [openText, multipleChoiceSingle, multipleChoiceMulti, nps, rating, date, cta, consent]
+        headline:
+          type: object
+          required: [default]
+          properties:
+            default:
+              type: string
+              maxLength: 80
+        required:
+          type: boolean
+        inputType:
+          type: string
+          enum: [text, email, url, number, phone]
+    Survey:
+      type: object
+      required: [id, name, type, status]
+      properties:
+        id:
+          type: string
+          x-mockingbird-resource:
+            type: survey
+            identity: true
+        name:
+          type: string
+        type:
+          type: string
+        status:
+          type: string
+        workspaceId:
+          type: string
+        environmentId:
+          description: The legacy environment id of the survey's workspace (v1 compatibility).
+          type: string
+        questions:
+          type: ["array", "object"]
+        blocks:
+          type: array
+        createdAt:
+          type: string
+          x-mockingbird-volatile:
+            kind: timestamp
+        updatedAt:
+          type: string
+          x-mockingbird-volatile:
+            kind: timestamp
+    Response:
+      type: object
+      required: [id, createdAt, updatedAt, surveyId, finished, data]
+      properties:
+        id:
+          type: string
+          x-mockingbird-resource:
+            type: response
+            identity: true
+        createdAt:
+          type: string
+          x-mockingbird-volatile:
+            kind: timestamp
+        updatedAt:
+          type: string
+          x-mockingbird-volatile:
+            kind: timestamp
+        surveyId:
+          type: string
+        displayId:
+          type: ["string", "null"]
+        contact:
+          type: ["object", "null"]
+          properties:
+            id:
+              type: string
+              x-mockingbird-volatile:
+                kind: id
+            userId:
+              type: string
+        contactAttributes:
+          type: ["object", "null"]
+        finished:
+          type: boolean
+        endingId:
+          type: ["string", "null"]
+        data:
+          description: An object, or (for some deployments) the same object as a JSON string.
+          type: ["object", "string"]
+        variables:
+          type: object
+        ttc:
+          type: object
+        tags:
+          type: array
+        meta:
+          type: object
+        singleUseId:
+          type: ["string", "null"]
+        language:
+          type: ["string", "null"]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crvouga/mockingbird-service-formbricks",
-  "version": "1.7.1",
+  "version": "2.0.0",
   "description": "Stateful mock of open-source Formbricks: the client environment state (seeded with a synthetic survey corpus), response creation with upstream's validation and {code, message, details} errors, the v1 management API, the widget script, and signed response webhooks.",
   "license": "MIT",
   "type": "module",
@@ -8,7 +8,10 @@
   "files": [
     "dist",
     "README.md",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "DISCOVERY.md",
+    "SUPPORT.md",
+    "openapi.yaml"
   ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -57,7 +60,29 @@
       "docs": "https://formbricks.com/docs"
     },
     "parity": "Surveys, responses, and webhooks",
-    "parityTier": "cold"
+    "parityTier": "cold",
+    "discovery": {
+      "guide": "DISCOVERY.md",
+      "behavior": "README.md",
+      "capabilities": "SUPPORT.md",
+      "contract": "openapi.yaml",
+      "types": "dist/index.d.ts",
+      "oracle": {
+        "kind": "Live vendor API or sandbox",
+        "command": "bun run parity:service -- formbricks",
+        "note": "Run from a Mockingbird checkout; credentials come only from .env.local or GitHub Actions secrets. Missing credentials exit 2."
+      },
+      "introspection": [
+        "GET /__admin/health",
+        "GET /__admin",
+        "GET /__admin/state",
+        "GET /__admin/requests",
+        "GET /__admin/metrics",
+        "GET /__admin/faults/presets",
+        "GET /__admin/ui"
+      ],
+      "reporting": "https://github.com/crvouga/mockingbird/blob/main/docs/REPORTING_ISSUES.md"
+    }
   },
   "scripts": {
     "generate": "bun ../../openapi/codegen/dist/cli.js",
@@ -72,7 +97,7 @@
     "pack:check": "bun ../../../scripts/pack-check.ts"
   },
   "dependencies": {
-    "@crvouga/mockingbird-service-sqlite": "1.3.0",
+    "@crvouga/mockingbird-service-sqlite": "2.0.0",
     "hono": "4.11.9"
   },
   "devDependencies": {