budibase/packages/server/specs/resources/application.ts

import userResource from "./user"
import { object } from "./utils"
import Resource from "./utils/Resource"

const application = {
  _id: "app_metadata",
  appId: "app_dev_957b12f943d348faa61db7e18e088d0f",
  version: "1.0.58-alpha.0",
  name: "App name",
  url: "/app-url",
  tenantId: "default",
  updatedAt: "2022-02-22T13:00:54.035Z",
  createdAt: "2022-02-11T18:02:26.961Z",
  status: "development",
  lockedBy: userResource.getExamples().user.value.user,
}

const deployment = {
  _id: "ef12381f934b4f129675cdbb76eff3c2",
  status: "SUCCESS",
  appUrl: "/app-url",
}

const base = {
  name: {
    description: "The name of the app.",
    type: "string",
  },
  url: {
    description:
      "The URL by which the app is accessed, this must be URL encoded.",
    type: "string",
  },
}

const applicationSchema = object(base, { required: ["name"] })

const applicationOutputSchema = object(
  {
    ...base,
    _id: {
      description: "The ID of the app.",
      type: "string",
    },
    status: {
      description:
        "The status of the app, stating it if is the development or published version.",
      type: "string",
      enum: ["development", "published"],
    },
    createdAt: {
      description:
        "States when the app was created, will be constant. Stored in ISO format.",
      type: "string",
    },
    updatedAt: {
      description:
        "States the last time the app was updated - stored in ISO format.",
      type: "string",
    },
    version: {
      description:
        "States the version of the Budibase client this app is currently based on.",
      type: "string",
    },
    tenantId: {
      description:
        "In a multi-tenant environment this will state the tenant this app is within.",
      type: "string",
    },
    lockedBy: {
      description: "The user this app is currently being built by.",
      type: "object",
    },
  },
  {
    required: [
      "_id",
      "name",
      "url",
      "status",
      "createdAt",
      "updatedAt",
      "version",
    ],
  }
)

const deploymentOutputSchema = object({
  _id: {
    description: "The ID of the app.",
    type: "string",
  },
  status: {
    description: "Status of the deployment, whether it succeeded or failed",
    type: "string",
    enum: ["SUCCESS", "FAILURE"],
  },
  appUrl: {
    description: "The URL of the published app",
    type: "string",
  },
})

export default new Resource()
  .setExamples({
    application: {
      value: {
        data: application,
      },
    },
    applications: {
      value: {
        data: [application],
      },
    },
    deploymentOutput: {
      value: {
        data: deployment,
      },
    },
  })
  .setSchemas({
    application: applicationSchema,
    applicationOutput: object({
      data: applicationOutputSchema,
    }),
    applicationSearch: object({
      data: {
        type: "array",
        items: applicationOutputSchema,
      },
    }),
    deploymentOutput: object({
      data: deploymentOutputSchema,
    }),
    appExport: object({
      encryptPassword: {
        description: "An optional password used to encrypt the export.",
        type: "string",
      },
      excludeRows: {
        description:
          "Set whether the internal table rows should be excluded from the export.",
        type: "boolean",
      },
    }),
  })