From 771d502b9e80bedd92e29fcd7eaeb859a9a2b3c7 Mon Sep 17 00:00:00 2001 From: leorossi <leorossi@users.noreply.github.com> Date: Fri, 22 Sep 2023 09:26:05 +0000 Subject: [PATCH] [automated commit] Bump docs to version 0.46.1 --- .../contributing/contributing.md | 0 .../contributing/documentation-style-guide.md | 0 .../getting-started/architecture.md | 0 .../movie-quotes-app-tutorial.md | 0 .../new-api-project-instructions.md | 0 .../platformatic-architecture.png | Bin .../platformatid-db-architecture.excalidraw | 0 .../getting-started/quick-start-guide.md | 0 .../extend-graphql.md | 0 .../add-custom-functionality/extend-rest.md | 0 .../add-custom-functionality/introduction.md | 0 .../add-custom-functionality/prerequisites.md | 0 .../add-custom-functionality/raw-sql.md | 0 .../compiling-typescript-for-deployment.md | 0 .../guides/debug-platformatic-db.md | 0 .../guides/deploying-on-lambda.md | 0 .../deployment/advanced-fly-io-deployment.md | 0 .../deploy-to-fly-io-with-sqlite.md | 0 .../guides/deployment/deployment.md | 0 .../guides/dockerize-platformatic-app.md | 0 ...d-code-to-consume-platformatic-rest-api.md | 4 +- .../guides/images/frontend-screenshot-1.jpg | Bin .../guides/images/frontend-screenshot-2.jpg | Bin .../guides/images/frontend-screenshot-3.jpg | Bin .../guides/images/frontend-screenshot-4.jpg | Bin .../guides/jwt-auth0.md | 0 ...ing-express-app-to-platformatic-service.md | 0 ...ing-fastify-app-to-platformatic-service.md | 0 .../guides/monitoring.md | 0 .../packaging-an-application-as-a-module.md | 0 .../guides/prisma.md | 0 .../guides/securing-platformatic-db.md | 0 .../guides/seed-a-database.md | 0 .../telemetry-images/compose-openapi.png | Bin .../guides/telemetry-images/jaeger-1.png | Bin .../guides/telemetry-images/jaeger-2.png | Bin .../guides/telemetry-images/jaeger-3.png | Bin .../guides/telemetry.md | 0 .../deploy-database-neon.md | 0 .../app-workspace-static-deployed.png | Bin .../button-continue-with-github.png | Bin .../quick-start-guide/cloud-apps-empty.png | Bin .../github-pr-deploy-comment.png | Bin .../github-pr-deploy-in-progress.png | Bin .../quick-start-guide/hello-json-response.png | Bin .../platformatic-db-swagger-ui.png | Bin .../workspace-create-dynamic.png | Bin .../platformatic-cloud/pricing.md | 0 .../platformatic-cloud/quick-start-guide.md | 0 .../reference/cli.md | 11 +- .../reference/client/frontend.md | 2 +- .../reference/client/introduction.md | 0 .../reference/client/programmatic.md | 0 .../reference/composer/api-modification.md | 0 .../reference/composer/configuration.md | 0 .../reference/composer/introduction.md | 0 .../reference/composer/plugin.md | 0 .../reference/composer/programmatic.md | 0 .../db/authorization/images/http.png | Bin .../reference/db/authorization/images/jwt.png | Bin .../images/sources/http.excalidraw | 0 .../images/sources/jwt.excalidraw | 0 .../images/sources/webhook.excalidraw | 0 .../db/authorization/images/webhook.png | Bin .../db/authorization/introduction.md | 0 .../reference/db/authorization/rules.md | 0 .../reference/db/authorization/strategies.md | 0 .../db/authorization/user-roles-metadata.md | 0 .../reference/db/configuration.md | 0 .../reference/db/introduction.md | 0 .../reference/db/logging.md | 0 .../reference/db/migrations.md | 0 .../reference/db/plugin.md | 0 .../reference/db/programmatic.md | 0 .../reference/db/schema-support.md | 0 .../version-0.46.1/reference/errors.md | 309 ++++++++++++++++++ .../reference/runtime/configuration.md | 0 .../reference/runtime/introduction.md | 0 .../reference/runtime/programmatic.md | 0 .../reference/service/configuration.md | 0 .../reference/service/introduction.md | 4 + .../reference/service/plugin.md | 0 .../reference/service/programmatic.md | 53 +++ .../reference/sql-events/fastify-plugin.md | 0 .../reference/sql-events/introduction.md | 0 .../sql-graphql/examples/deleteEntity.js | 0 .../sql-graphql/examples/insertEntity.js | 0 .../reference/sql-graphql/examples/query.js | 0 .../sql-graphql/examples/saveEntity.js | 0 .../reference/sql-graphql/ignore.md | 4 +- .../reference/sql-graphql/introduction.md | 0 .../reference/sql-graphql/many-to-many.md | 0 .../reference/sql-graphql/mutations.md | 0 .../reference/sql-graphql/queries.md | 0 .../reference/sql-graphql/subscriptions.md | 0 .../reference/sql-mapper/entities/api.md | 0 .../reference/sql-mapper/entities/example.md | 0 .../reference/sql-mapper/entities/fields.md | 0 .../reference/sql-mapper/entities/hooks.md | 0 .../sql-mapper/entities/introduction.md | 0 .../sql-mapper/entities/relations.md | 0 .../sql-mapper/entities/timestamps.md | 0 .../sql-mapper/entities/transactions.md | 0 .../reference/sql-mapper/examples/count.js | 0 .../reference/sql-mapper/examples/delete.js | 0 .../sql-mapper/examples/fastify-plugin.js | 0 .../reference/sql-mapper/examples/fields.js | 0 .../reference/sql-mapper/examples/find.js | 0 .../reference/sql-mapper/examples/hooks.js | 0 .../reference/sql-mapper/examples/insert.js | 0 .../sql-mapper/examples/relations.js | 0 .../reference/sql-mapper/examples/save.js | 0 .../reference/sql-mapper/fastify-plugin.md | 25 ++ .../sql-mapper/images/plt-db-hooks.svg | 0 .../reference/sql-mapper/introduction.md | 0 .../reference/sql-openapi/api.md | 0 .../reference/sql-openapi/ignore.md | 4 +- .../reference/sql-openapi/introduction.md | 0 ...bars.json => version-0.46.1-sidebars.json} | 0 versions.json | 4 +- 120 files changed, 406 insertions(+), 14 deletions(-) rename versioned_docs/{version-0.43.0 => version-0.46.1}/contributing/contributing.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/contributing/documentation-style-guide.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/getting-started/architecture.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/getting-started/movie-quotes-app-tutorial.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/getting-started/new-api-project-instructions.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/getting-started/platformatic-architecture.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/getting-started/platformatid-db-architecture.excalidraw (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/getting-started/quick-start-guide.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/add-custom-functionality/extend-graphql.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/add-custom-functionality/extend-rest.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/add-custom-functionality/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/add-custom-functionality/prerequisites.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/add-custom-functionality/raw-sql.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/compiling-typescript-for-deployment.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/debug-platformatic-db.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/deploying-on-lambda.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/deployment/advanced-fly-io-deployment.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/deployment/deploy-to-fly-io-with-sqlite.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/deployment/deployment.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/dockerize-platformatic-app.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/generate-frontend-code-to-consume-platformatic-rest-api.md (98%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/images/frontend-screenshot-1.jpg (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/images/frontend-screenshot-2.jpg (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/images/frontend-screenshot-3.jpg (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/images/frontend-screenshot-4.jpg (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/jwt-auth0.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/migrating-express-app-to-platformatic-service.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/migrating-fastify-app-to-platformatic-service.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/monitoring.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/packaging-an-application-as-a-module.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/prisma.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/securing-platformatic-db.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/seed-a-database.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/telemetry-images/compose-openapi.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/telemetry-images/jaeger-1.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/telemetry-images/jaeger-2.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/telemetry-images/jaeger-3.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/guides/telemetry.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/deploy-database-neon.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/images/quick-start-guide/app-workspace-static-deployed.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/images/quick-start-guide/button-continue-with-github.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/images/quick-start-guide/cloud-apps-empty.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/images/quick-start-guide/github-pr-deploy-comment.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/images/quick-start-guide/github-pr-deploy-in-progress.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/images/quick-start-guide/hello-json-response.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/images/quick-start-guide/platformatic-db-swagger-ui.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/images/quick-start-guide/workspace-create-dynamic.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/pricing.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/platformatic-cloud/quick-start-guide.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/cli.md (98%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/client/frontend.md (96%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/client/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/client/programmatic.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/composer/api-modification.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/composer/configuration.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/composer/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/composer/plugin.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/composer/programmatic.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/images/http.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/images/jwt.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/images/sources/http.excalidraw (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/images/sources/jwt.excalidraw (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/images/sources/webhook.excalidraw (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/images/webhook.png (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/rules.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/strategies.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/authorization/user-roles-metadata.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/configuration.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/logging.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/migrations.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/plugin.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/programmatic.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/db/schema-support.md (100%) create mode 100644 versioned_docs/version-0.46.1/reference/errors.md rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/runtime/configuration.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/runtime/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/runtime/programmatic.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/service/configuration.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/service/introduction.md (93%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/service/plugin.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/service/programmatic.md (61%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-events/fastify-plugin.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-events/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/examples/deleteEntity.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/examples/insertEntity.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/examples/query.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/examples/saveEntity.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/ignore.md (90%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/many-to-many.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/mutations.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/queries.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-graphql/subscriptions.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/entities/api.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/entities/example.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/entities/fields.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/entities/hooks.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/entities/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/entities/relations.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/entities/timestamps.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/entities/transactions.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/examples/count.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/examples/delete.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/examples/fastify-plugin.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/examples/fields.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/examples/find.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/examples/hooks.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/examples/insert.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/examples/relations.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/examples/save.js (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/fastify-plugin.md (78%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/images/plt-db-hooks.svg (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-mapper/introduction.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-openapi/api.md (100%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-openapi/ignore.md (90%) rename versioned_docs/{version-0.43.0 => version-0.46.1}/reference/sql-openapi/introduction.md (100%) rename versioned_sidebars/{version-0.43.0-sidebars.json => version-0.46.1-sidebars.json} (100%) diff --git a/versioned_docs/version-0.43.0/contributing/contributing.md b/versioned_docs/version-0.46.1/contributing/contributing.md similarity index 100% rename from versioned_docs/version-0.43.0/contributing/contributing.md rename to versioned_docs/version-0.46.1/contributing/contributing.md diff --git a/versioned_docs/version-0.43.0/contributing/documentation-style-guide.md b/versioned_docs/version-0.46.1/contributing/documentation-style-guide.md similarity index 100% rename from versioned_docs/version-0.43.0/contributing/documentation-style-guide.md rename to versioned_docs/version-0.46.1/contributing/documentation-style-guide.md diff --git a/versioned_docs/version-0.43.0/getting-started/architecture.md b/versioned_docs/version-0.46.1/getting-started/architecture.md similarity index 100% rename from versioned_docs/version-0.43.0/getting-started/architecture.md rename to versioned_docs/version-0.46.1/getting-started/architecture.md diff --git a/versioned_docs/version-0.43.0/getting-started/movie-quotes-app-tutorial.md b/versioned_docs/version-0.46.1/getting-started/movie-quotes-app-tutorial.md similarity index 100% rename from versioned_docs/version-0.43.0/getting-started/movie-quotes-app-tutorial.md rename to versioned_docs/version-0.46.1/getting-started/movie-quotes-app-tutorial.md diff --git a/versioned_docs/version-0.43.0/getting-started/new-api-project-instructions.md b/versioned_docs/version-0.46.1/getting-started/new-api-project-instructions.md similarity index 100% rename from versioned_docs/version-0.43.0/getting-started/new-api-project-instructions.md rename to versioned_docs/version-0.46.1/getting-started/new-api-project-instructions.md diff --git a/versioned_docs/version-0.43.0/getting-started/platformatic-architecture.png b/versioned_docs/version-0.46.1/getting-started/platformatic-architecture.png similarity index 100% rename from versioned_docs/version-0.43.0/getting-started/platformatic-architecture.png rename to versioned_docs/version-0.46.1/getting-started/platformatic-architecture.png diff --git a/versioned_docs/version-0.43.0/getting-started/platformatid-db-architecture.excalidraw b/versioned_docs/version-0.46.1/getting-started/platformatid-db-architecture.excalidraw similarity index 100% rename from versioned_docs/version-0.43.0/getting-started/platformatid-db-architecture.excalidraw rename to versioned_docs/version-0.46.1/getting-started/platformatid-db-architecture.excalidraw diff --git a/versioned_docs/version-0.43.0/getting-started/quick-start-guide.md b/versioned_docs/version-0.46.1/getting-started/quick-start-guide.md similarity index 100% rename from versioned_docs/version-0.43.0/getting-started/quick-start-guide.md rename to versioned_docs/version-0.46.1/getting-started/quick-start-guide.md diff --git a/versioned_docs/version-0.43.0/guides/add-custom-functionality/extend-graphql.md b/versioned_docs/version-0.46.1/guides/add-custom-functionality/extend-graphql.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/add-custom-functionality/extend-graphql.md rename to versioned_docs/version-0.46.1/guides/add-custom-functionality/extend-graphql.md diff --git a/versioned_docs/version-0.43.0/guides/add-custom-functionality/extend-rest.md b/versioned_docs/version-0.46.1/guides/add-custom-functionality/extend-rest.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/add-custom-functionality/extend-rest.md rename to versioned_docs/version-0.46.1/guides/add-custom-functionality/extend-rest.md diff --git a/versioned_docs/version-0.43.0/guides/add-custom-functionality/introduction.md b/versioned_docs/version-0.46.1/guides/add-custom-functionality/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/add-custom-functionality/introduction.md rename to versioned_docs/version-0.46.1/guides/add-custom-functionality/introduction.md diff --git a/versioned_docs/version-0.43.0/guides/add-custom-functionality/prerequisites.md b/versioned_docs/version-0.46.1/guides/add-custom-functionality/prerequisites.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/add-custom-functionality/prerequisites.md rename to versioned_docs/version-0.46.1/guides/add-custom-functionality/prerequisites.md diff --git a/versioned_docs/version-0.43.0/guides/add-custom-functionality/raw-sql.md b/versioned_docs/version-0.46.1/guides/add-custom-functionality/raw-sql.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/add-custom-functionality/raw-sql.md rename to versioned_docs/version-0.46.1/guides/add-custom-functionality/raw-sql.md diff --git a/versioned_docs/version-0.43.0/guides/compiling-typescript-for-deployment.md b/versioned_docs/version-0.46.1/guides/compiling-typescript-for-deployment.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/compiling-typescript-for-deployment.md rename to versioned_docs/version-0.46.1/guides/compiling-typescript-for-deployment.md diff --git a/versioned_docs/version-0.43.0/guides/debug-platformatic-db.md b/versioned_docs/version-0.46.1/guides/debug-platformatic-db.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/debug-platformatic-db.md rename to versioned_docs/version-0.46.1/guides/debug-platformatic-db.md diff --git a/versioned_docs/version-0.43.0/guides/deploying-on-lambda.md b/versioned_docs/version-0.46.1/guides/deploying-on-lambda.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/deploying-on-lambda.md rename to versioned_docs/version-0.46.1/guides/deploying-on-lambda.md diff --git a/versioned_docs/version-0.43.0/guides/deployment/advanced-fly-io-deployment.md b/versioned_docs/version-0.46.1/guides/deployment/advanced-fly-io-deployment.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/deployment/advanced-fly-io-deployment.md rename to versioned_docs/version-0.46.1/guides/deployment/advanced-fly-io-deployment.md diff --git a/versioned_docs/version-0.43.0/guides/deployment/deploy-to-fly-io-with-sqlite.md b/versioned_docs/version-0.46.1/guides/deployment/deploy-to-fly-io-with-sqlite.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/deployment/deploy-to-fly-io-with-sqlite.md rename to versioned_docs/version-0.46.1/guides/deployment/deploy-to-fly-io-with-sqlite.md diff --git a/versioned_docs/version-0.43.0/guides/deployment/deployment.md b/versioned_docs/version-0.46.1/guides/deployment/deployment.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/deployment/deployment.md rename to versioned_docs/version-0.46.1/guides/deployment/deployment.md diff --git a/versioned_docs/version-0.43.0/guides/dockerize-platformatic-app.md b/versioned_docs/version-0.46.1/guides/dockerize-platformatic-app.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/dockerize-platformatic-app.md rename to versioned_docs/version-0.46.1/guides/dockerize-platformatic-app.md diff --git a/versioned_docs/version-0.43.0/guides/generate-frontend-code-to-consume-platformatic-rest-api.md b/versioned_docs/version-0.46.1/guides/generate-frontend-code-to-consume-platformatic-rest-api.md similarity index 98% rename from versioned_docs/version-0.43.0/guides/generate-frontend-code-to-consume-platformatic-rest-api.md rename to versioned_docs/version-0.46.1/guides/generate-frontend-code-to-consume-platformatic-rest-api.md index d1d9418773..1e36556eba 100644 --- a/versioned_docs/version-0.43.0/guides/generate-frontend-code-to-consume-platformatic-rest-api.md +++ b/versioned_docs/version-0.46.1/guides/generate-frontend-code-to-consume-platformatic-rest-api.md @@ -109,7 +109,7 @@ Now that either the Platformatic app and the front-end app are running, go to th ```bash cd rest-api-frontend/src -npx platformatic frontend http://127.0.0.1:3042 ts +npx platformatic client http://127.0.0.1:3042 --frontend --language ts ``` Refer to the [Platformatic CLI frontend command](https://docs.platformatic.dev/docs/reference/cli#frontend) @@ -176,7 +176,7 @@ You can add a `--name` option to the command line to provide a custom name for t ```bash cd rest-api-frontend/src -npx platformatic frontend --name foobar http://127.0.0.1:3042 ts +npx platformatic client http://127.0.0.1:3042 --frontend --name foobar --language ts ``` will generated `foobar.ts` and `foobar-types.d.ts` diff --git a/versioned_docs/version-0.43.0/guides/images/frontend-screenshot-1.jpg b/versioned_docs/version-0.46.1/guides/images/frontend-screenshot-1.jpg similarity index 100% rename from versioned_docs/version-0.43.0/guides/images/frontend-screenshot-1.jpg rename to versioned_docs/version-0.46.1/guides/images/frontend-screenshot-1.jpg diff --git a/versioned_docs/version-0.43.0/guides/images/frontend-screenshot-2.jpg b/versioned_docs/version-0.46.1/guides/images/frontend-screenshot-2.jpg similarity index 100% rename from versioned_docs/version-0.43.0/guides/images/frontend-screenshot-2.jpg rename to versioned_docs/version-0.46.1/guides/images/frontend-screenshot-2.jpg diff --git a/versioned_docs/version-0.43.0/guides/images/frontend-screenshot-3.jpg b/versioned_docs/version-0.46.1/guides/images/frontend-screenshot-3.jpg similarity index 100% rename from versioned_docs/version-0.43.0/guides/images/frontend-screenshot-3.jpg rename to versioned_docs/version-0.46.1/guides/images/frontend-screenshot-3.jpg diff --git a/versioned_docs/version-0.43.0/guides/images/frontend-screenshot-4.jpg b/versioned_docs/version-0.46.1/guides/images/frontend-screenshot-4.jpg similarity index 100% rename from versioned_docs/version-0.43.0/guides/images/frontend-screenshot-4.jpg rename to versioned_docs/version-0.46.1/guides/images/frontend-screenshot-4.jpg diff --git a/versioned_docs/version-0.43.0/guides/jwt-auth0.md b/versioned_docs/version-0.46.1/guides/jwt-auth0.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/jwt-auth0.md rename to versioned_docs/version-0.46.1/guides/jwt-auth0.md diff --git a/versioned_docs/version-0.43.0/guides/migrating-express-app-to-platformatic-service.md b/versioned_docs/version-0.46.1/guides/migrating-express-app-to-platformatic-service.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/migrating-express-app-to-platformatic-service.md rename to versioned_docs/version-0.46.1/guides/migrating-express-app-to-platformatic-service.md diff --git a/versioned_docs/version-0.43.0/guides/migrating-fastify-app-to-platformatic-service.md b/versioned_docs/version-0.46.1/guides/migrating-fastify-app-to-platformatic-service.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/migrating-fastify-app-to-platformatic-service.md rename to versioned_docs/version-0.46.1/guides/migrating-fastify-app-to-platformatic-service.md diff --git a/versioned_docs/version-0.43.0/guides/monitoring.md b/versioned_docs/version-0.46.1/guides/monitoring.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/monitoring.md rename to versioned_docs/version-0.46.1/guides/monitoring.md diff --git a/versioned_docs/version-0.43.0/guides/packaging-an-application-as-a-module.md b/versioned_docs/version-0.46.1/guides/packaging-an-application-as-a-module.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/packaging-an-application-as-a-module.md rename to versioned_docs/version-0.46.1/guides/packaging-an-application-as-a-module.md diff --git a/versioned_docs/version-0.43.0/guides/prisma.md b/versioned_docs/version-0.46.1/guides/prisma.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/prisma.md rename to versioned_docs/version-0.46.1/guides/prisma.md diff --git a/versioned_docs/version-0.43.0/guides/securing-platformatic-db.md b/versioned_docs/version-0.46.1/guides/securing-platformatic-db.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/securing-platformatic-db.md rename to versioned_docs/version-0.46.1/guides/securing-platformatic-db.md diff --git a/versioned_docs/version-0.43.0/guides/seed-a-database.md b/versioned_docs/version-0.46.1/guides/seed-a-database.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/seed-a-database.md rename to versioned_docs/version-0.46.1/guides/seed-a-database.md diff --git a/versioned_docs/version-0.43.0/guides/telemetry-images/compose-openapi.png b/versioned_docs/version-0.46.1/guides/telemetry-images/compose-openapi.png similarity index 100% rename from versioned_docs/version-0.43.0/guides/telemetry-images/compose-openapi.png rename to versioned_docs/version-0.46.1/guides/telemetry-images/compose-openapi.png diff --git a/versioned_docs/version-0.43.0/guides/telemetry-images/jaeger-1.png b/versioned_docs/version-0.46.1/guides/telemetry-images/jaeger-1.png similarity index 100% rename from versioned_docs/version-0.43.0/guides/telemetry-images/jaeger-1.png rename to versioned_docs/version-0.46.1/guides/telemetry-images/jaeger-1.png diff --git a/versioned_docs/version-0.43.0/guides/telemetry-images/jaeger-2.png b/versioned_docs/version-0.46.1/guides/telemetry-images/jaeger-2.png similarity index 100% rename from versioned_docs/version-0.43.0/guides/telemetry-images/jaeger-2.png rename to versioned_docs/version-0.46.1/guides/telemetry-images/jaeger-2.png diff --git a/versioned_docs/version-0.43.0/guides/telemetry-images/jaeger-3.png b/versioned_docs/version-0.46.1/guides/telemetry-images/jaeger-3.png similarity index 100% rename from versioned_docs/version-0.43.0/guides/telemetry-images/jaeger-3.png rename to versioned_docs/version-0.46.1/guides/telemetry-images/jaeger-3.png diff --git a/versioned_docs/version-0.43.0/guides/telemetry.md b/versioned_docs/version-0.46.1/guides/telemetry.md similarity index 100% rename from versioned_docs/version-0.43.0/guides/telemetry.md rename to versioned_docs/version-0.46.1/guides/telemetry.md diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/deploy-database-neon.md b/versioned_docs/version-0.46.1/platformatic-cloud/deploy-database-neon.md similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/deploy-database-neon.md rename to versioned_docs/version-0.46.1/platformatic-cloud/deploy-database-neon.md diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/app-workspace-static-deployed.png b/versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/app-workspace-static-deployed.png similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/app-workspace-static-deployed.png rename to versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/app-workspace-static-deployed.png diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/button-continue-with-github.png b/versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/button-continue-with-github.png similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/button-continue-with-github.png rename to versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/button-continue-with-github.png diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/cloud-apps-empty.png b/versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/cloud-apps-empty.png similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/cloud-apps-empty.png rename to versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/cloud-apps-empty.png diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/github-pr-deploy-comment.png b/versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/github-pr-deploy-comment.png similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/github-pr-deploy-comment.png rename to versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/github-pr-deploy-comment.png diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/github-pr-deploy-in-progress.png b/versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/github-pr-deploy-in-progress.png similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/github-pr-deploy-in-progress.png rename to versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/github-pr-deploy-in-progress.png diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/hello-json-response.png b/versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/hello-json-response.png similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/hello-json-response.png rename to versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/hello-json-response.png diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/platformatic-db-swagger-ui.png b/versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/platformatic-db-swagger-ui.png similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/platformatic-db-swagger-ui.png rename to versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/platformatic-db-swagger-ui.png diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/workspace-create-dynamic.png b/versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/workspace-create-dynamic.png similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/images/quick-start-guide/workspace-create-dynamic.png rename to versioned_docs/version-0.46.1/platformatic-cloud/images/quick-start-guide/workspace-create-dynamic.png diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/pricing.md b/versioned_docs/version-0.46.1/platformatic-cloud/pricing.md similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/pricing.md rename to versioned_docs/version-0.46.1/platformatic-cloud/pricing.md diff --git a/versioned_docs/version-0.43.0/platformatic-cloud/quick-start-guide.md b/versioned_docs/version-0.46.1/platformatic-cloud/quick-start-guide.md similarity index 100% rename from versioned_docs/version-0.43.0/platformatic-cloud/quick-start-guide.md rename to versioned_docs/version-0.46.1/platformatic-cloud/quick-start-guide.md diff --git a/versioned_docs/version-0.43.0/reference/cli.md b/versioned_docs/version-0.46.1/reference/cli.md similarity index 98% rename from versioned_docs/version-0.43.0/reference/cli.md rename to versioned_docs/version-0.46.1/reference/cli.md index 167ef234ab..fd799355e6 100644 --- a/versioned_docs/version-0.43.0/reference/cli.md +++ b/versioned_docs/version-0.46.1/reference/cli.md @@ -93,7 +93,6 @@ Welcome to Platformatic. Available commands are: * `deploy` - deploy a Platformatic application to the cloud. * `runtime` - start Platformatic Runtime; type `platformatic runtime help` to know more. * `start` - start a Platformatic application. -* `frontend`- create frontend code to consume the REST APIs. #### compile @@ -273,11 +272,13 @@ Options: * `-n, --name <name>` - Name of the client. * `-f, --folder <name>` - Name of the plugin folder, defaults to --name value. * `-t, --typescript` - Generate the client plugin in TypeScript. +* `--frontend` - Generated a browser-compatible client that uses `fetch` * `--full-response` - Client will return full response object rather than just the body. -* `--full-request` - Client will be called with all parameters wrapped in `body`, `headers` and `query` properties. +* `--full-request` - Client will be called with all parameters wrapped in `body`, `headers` and `query` properties. Ignored if `--frontend` * `--full` - Enables both `--full-request` and `--full-response` overriding them. -* `--optional-headers <headers>` - Comma separated string of headers that will be marked as optional in the type file -* `--validate-response` - If set, will validate the response body against the schema. +* `--optional-headers <headers>` - Comma separated string of headers that will be marked as optional in the type file. Ignored if `--frontend` +* `--validate-response` - If set, will validate the response body against the schema. Ignored if `--frontend` +* `--language js|ts` - Generate a Javascript or Typescript frontend client. Only works if `--frontend` @@ -743,7 +744,7 @@ save the following as `platformatic.service.json`: ### frontend ```bash -platformatic frontend <url> <language> +platformatic client <url> --frontend --language <language> ``` diff --git a/versioned_docs/version-0.43.0/reference/client/frontend.md b/versioned_docs/version-0.46.1/reference/client/frontend.md similarity index 96% rename from versioned_docs/version-0.43.0/reference/client/frontend.md rename to versioned_docs/version-0.46.1/reference/client/frontend.md index 5273d3ff23..6721486a1e 100644 --- a/versioned_docs/version-0.43.0/reference/client/frontend.md +++ b/versioned_docs/version-0.46.1/reference/client/frontend.md @@ -5,7 +5,7 @@ Create implementation and type files that exposes a client for a remote OpenAPI To create a client for a remote OpenAPI API, you can use the following command: ```bash -$ platformatic frontend http://exmaple.com/to/schema/file <language> --name <clientname> +$ platformatic client http://exmaple.com/to/schema/file --frontend --language <language> --name <clientname> ``` where `<language>` can be either `js` or `ts`. diff --git a/versioned_docs/version-0.43.0/reference/client/introduction.md b/versioned_docs/version-0.46.1/reference/client/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/client/introduction.md rename to versioned_docs/version-0.46.1/reference/client/introduction.md diff --git a/versioned_docs/version-0.43.0/reference/client/programmatic.md b/versioned_docs/version-0.46.1/reference/client/programmatic.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/client/programmatic.md rename to versioned_docs/version-0.46.1/reference/client/programmatic.md diff --git a/versioned_docs/version-0.43.0/reference/composer/api-modification.md b/versioned_docs/version-0.46.1/reference/composer/api-modification.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/composer/api-modification.md rename to versioned_docs/version-0.46.1/reference/composer/api-modification.md diff --git a/versioned_docs/version-0.43.0/reference/composer/configuration.md b/versioned_docs/version-0.46.1/reference/composer/configuration.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/composer/configuration.md rename to versioned_docs/version-0.46.1/reference/composer/configuration.md diff --git a/versioned_docs/version-0.43.0/reference/composer/introduction.md b/versioned_docs/version-0.46.1/reference/composer/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/composer/introduction.md rename to versioned_docs/version-0.46.1/reference/composer/introduction.md diff --git a/versioned_docs/version-0.43.0/reference/composer/plugin.md b/versioned_docs/version-0.46.1/reference/composer/plugin.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/composer/plugin.md rename to versioned_docs/version-0.46.1/reference/composer/plugin.md diff --git a/versioned_docs/version-0.43.0/reference/composer/programmatic.md b/versioned_docs/version-0.46.1/reference/composer/programmatic.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/composer/programmatic.md rename to versioned_docs/version-0.46.1/reference/composer/programmatic.md diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/images/http.png b/versioned_docs/version-0.46.1/reference/db/authorization/images/http.png similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/images/http.png rename to versioned_docs/version-0.46.1/reference/db/authorization/images/http.png diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/images/jwt.png b/versioned_docs/version-0.46.1/reference/db/authorization/images/jwt.png similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/images/jwt.png rename to versioned_docs/version-0.46.1/reference/db/authorization/images/jwt.png diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/images/sources/http.excalidraw b/versioned_docs/version-0.46.1/reference/db/authorization/images/sources/http.excalidraw similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/images/sources/http.excalidraw rename to versioned_docs/version-0.46.1/reference/db/authorization/images/sources/http.excalidraw diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/images/sources/jwt.excalidraw b/versioned_docs/version-0.46.1/reference/db/authorization/images/sources/jwt.excalidraw similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/images/sources/jwt.excalidraw rename to versioned_docs/version-0.46.1/reference/db/authorization/images/sources/jwt.excalidraw diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/images/sources/webhook.excalidraw b/versioned_docs/version-0.46.1/reference/db/authorization/images/sources/webhook.excalidraw similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/images/sources/webhook.excalidraw rename to versioned_docs/version-0.46.1/reference/db/authorization/images/sources/webhook.excalidraw diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/images/webhook.png b/versioned_docs/version-0.46.1/reference/db/authorization/images/webhook.png similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/images/webhook.png rename to versioned_docs/version-0.46.1/reference/db/authorization/images/webhook.png diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/introduction.md b/versioned_docs/version-0.46.1/reference/db/authorization/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/introduction.md rename to versioned_docs/version-0.46.1/reference/db/authorization/introduction.md diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/rules.md b/versioned_docs/version-0.46.1/reference/db/authorization/rules.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/rules.md rename to versioned_docs/version-0.46.1/reference/db/authorization/rules.md diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/strategies.md b/versioned_docs/version-0.46.1/reference/db/authorization/strategies.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/strategies.md rename to versioned_docs/version-0.46.1/reference/db/authorization/strategies.md diff --git a/versioned_docs/version-0.43.0/reference/db/authorization/user-roles-metadata.md b/versioned_docs/version-0.46.1/reference/db/authorization/user-roles-metadata.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/authorization/user-roles-metadata.md rename to versioned_docs/version-0.46.1/reference/db/authorization/user-roles-metadata.md diff --git a/versioned_docs/version-0.43.0/reference/db/configuration.md b/versioned_docs/version-0.46.1/reference/db/configuration.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/configuration.md rename to versioned_docs/version-0.46.1/reference/db/configuration.md diff --git a/versioned_docs/version-0.43.0/reference/db/introduction.md b/versioned_docs/version-0.46.1/reference/db/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/introduction.md rename to versioned_docs/version-0.46.1/reference/db/introduction.md diff --git a/versioned_docs/version-0.43.0/reference/db/logging.md b/versioned_docs/version-0.46.1/reference/db/logging.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/logging.md rename to versioned_docs/version-0.46.1/reference/db/logging.md diff --git a/versioned_docs/version-0.43.0/reference/db/migrations.md b/versioned_docs/version-0.46.1/reference/db/migrations.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/migrations.md rename to versioned_docs/version-0.46.1/reference/db/migrations.md diff --git a/versioned_docs/version-0.43.0/reference/db/plugin.md b/versioned_docs/version-0.46.1/reference/db/plugin.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/plugin.md rename to versioned_docs/version-0.46.1/reference/db/plugin.md diff --git a/versioned_docs/version-0.43.0/reference/db/programmatic.md b/versioned_docs/version-0.46.1/reference/db/programmatic.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/programmatic.md rename to versioned_docs/version-0.46.1/reference/db/programmatic.md diff --git a/versioned_docs/version-0.43.0/reference/db/schema-support.md b/versioned_docs/version-0.46.1/reference/db/schema-support.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/db/schema-support.md rename to versioned_docs/version-0.46.1/reference/db/schema-support.md diff --git a/versioned_docs/version-0.46.1/reference/errors.md b/versioned_docs/version-0.46.1/reference/errors.md new file mode 100644 index 0000000000..f607c0674c --- /dev/null +++ b/versioned_docs/version-0.46.1/reference/errors.md @@ -0,0 +1,309 @@ +# Platformatic Errors + +## @platformatic/authenticate + +### PLT_AUTHENTICATE_UNABLE_TO_CONTACT_LOGIN_SERVICE +**Message:** Unable to contact login service + +### PLT_AUTHENTICATE_UNABLE_TO_RETRIEVE_TOKENS +**Message:** Unable to retrieve tokens + +### PLT_AUTHENTICATE_USER_DID_NOT_AUTHENTICATE_BEFORE_EXPIRY +**Message:** User did not authenticate before expiry + +### PLT_AUTHENTICATE_CONFIG_OPTION_REQUIRES_PATH_TO_FILE +**Message:** --config option requires path to a file + +### PLT_AUTHENTICATE_UNABLE_TO_GET_USER_DATA +**Message:** Unable to get user data + +### PLT_AUTHENTICATE_UNABLE_TO_CLAIM_INVITE +**Message:** Unable to claim invite + +### PLT_AUTHENTICATE_MISSING_INVITE +**Message:** Missing invite + +## @platformatic/client + +### PLT_CLIENT_OPTIONS_URL_REQUIRED +**Message:** options.url is required + +## @platformatic/client-cli + +### PLT_CLIENT_CLI_UNKNOWN_TYPE +**Message:** Unknown type %s + +### PLT_CLIENT_CLI_TYPE_NOT_SUPPORTED +**Message:** Type %s not supported + +## @platformatic/composer + +### PLT_COMPOSER_FASTIFY_INSTANCE_IS_ALREADY_LISTENING +**Message:** Fastify instance is already listening. Cannot call "addComposerOnRouteHook"! + +### PLT_COMPOSER_FAILED_TO_FETCH_OPENAPI_SCHEMA +**Message:** Failed to fetch OpenAPI schema from %s + +### PLT_COMPOSER_VALIDATION_ERRORS +**Message:** Validation errors: %s + +### PLT_COMPOSER_PATH_ALREADY_EXISTS +**Message:** Path "%s" already exists + +### PLT_COMPOSER_COULD_NOT_READ_OPENAPI_CONFIG +**Message:** Could not read openapi config for "%s" service + +## @platformatic/config + +### PLT_CONFIG_CONFIGURATION_DOES_NOT_VALIDATE_AGAINST_SCHEMA +**Message:** The configuration does not validate against the configuration schema + +### PLT_CONFIG_SOURCE_MISSING +**Message:** Source missing. + +### PLT_CONFIG_INVALID_PLACEHOLDER +**Message:** %s is an invalid placeholder. All placeholders must be prefixed with PLT_. +Did you mean PLT_%s? + +### PLT_CONFIG_ENV_VAR_MISSING +**Message:** %s env variable is missing. + +### PLT_CONFIG_CANNOT_PARSE_CONFIG_FILE +**Message:** Cannot parse config file. %s + +### PLT_CONFIG_VALIDATION_ERRORS +**Message:** Validation errors: %s + +### PLT_CONFIG_APP_MUST_BE_A_FUNCTION +**Message:** app must be a function + +### PLT_CONFIG_SCHEMA_MUST_BE_DEFINED +**Message:** schema must be defined + +### PLT_CONFIG_SCHEMA_ID_MUST_BE_A_STRING +**Message:** schema.$id must be a string with length > 0 + +### PLT_CONFIG_CONFIG_TYPE_MUST_BE_A_STRING +**Message:** configType must be a string + +### PLT_CONFIG_ADD_A_MODULE_PROPERTY_TO_THE_CONFIG_OR_ADD_A_KNOWN_SCHEMA +**Message:** Add a module property to the config or add a known $schema. + +### PLT_CONFIG_VERSION_MISMATCH +**Message:** Version mismatch. You are running Platformatic %s but your app requires %s + +### PLT_CONFIG_NO_CONFIG_FILE_FOUND +**Message:** no config file found + +## @platformatic/db + +### PLT_DB_MIGRATE_ERROR +**Message:** Missing "migrations" section in config file + +### PLT_DB_UNKNOWN_DATABASE_ERROR +**Message:** Unknown database + +### PLT_DB_MIGRATE_ERROR +**Message:** Migrations directory %s does not exist + +### PLT_DB_MISSING_SEED_FILE_ERROR +**Message:** Missing seed file + +### PLT_DB_MIGRATIONS_TO_APPLY_ERROR +**Message:** You have migrations to apply. Please run `platformatic db migrations apply` first. + +## @platformatic/db-authorization + +### PLT_DB_AUTH_UNAUTHORIZED +**Message:** operation not allowed + +### PLT_DB_AUTH_FIELD_UNAUTHORIZED +**Message:** field not allowed: %s + +### PLT_DB_AUTH_NOT_NULLABLE_MISSING +**Message:** missing not nullable field: "%s" in save rule for entity "%s" + +## @platformatic/db-core + +**No errors defined** + +## @platformatic/deploy-client + +### PLT_SQL_DEPLOY_CLIENT_REQUEST_FAILED +**Message:** Request failed with status code: %s %s + +### PLT_SQL_DEPLOY_CLIENT_COULD_NOT_MAKE_PREWARM_CALL +**Message:** Could not make a prewarm call: %s + +### PLT_SQL_DEPLOY_CLIENT_INVALID_PLATFORMATIC_WORKSPACE_KEY +**Message:** Invalid platformatic_workspace_key provided + +### PLT_SQL_DEPLOY_CLIENT_COULD_NOT_CREATE_BUNDLE +**Message:** Could not create a bundle: %s + +### PLT_SQL_DEPLOY_CLIENT_FAILED_TO_UPLOAD_CODE_ARCHIVE +**Message:** Failed to upload code archive: %s + +### PLT_SQL_DEPLOY_CLIENT_COULD_NOT_CREATE_DEPLOYMENT +**Message:** Could not create a deployment: %s + +### PLT_SQL_DEPLOY_CLIENT_MISSING_CONFIG_FILE +**Message:** Missing config file! + +## @platformatic/metaconfig + +### PLT_SQL_METACONFIG_MISSING_FILE_OR_CONFIG +**Message:** missing file or config to analyze + +### PLT_SQL_METACONFIG_MISSING_SCHEMA +**Message:** missing $schema, unable to determine the version + +### PLT_SQL_METACONFIG_UNABLE_TO_DETERMINE_VERSION +**Message:** unable to determine the version + +### PLT_SQL_METACONFIG_INVALID_CONFIG_FILE_EXTENSION +**Message:** Invalid config file extension. Only yml, yaml, json, json5, toml, tml are supported. + +## @platformatic/runtime + +### PLT_SQL_RUNTIME_RUNTIME_EXIT +**Message:** The runtime exited before the operation completed + +### PLT_SQL_RUNTIME_UNKNOWN_RUNTIME_API_COMMAND +**Message:** Unknown Runtime API command "%s" + +### PLT_SQL_RUNTIME_SERVICE_NOT_FOUND +**Message:** Service with id '%s' not found + +### PLT_SQL_RUNTIME_SERVICE_NOT_STARTED +**Message:** Service with id '%s' is not started + +### PLT_SQL_RUNTIME_FAILED_TO_RETRIEVE_OPENAPI_SCHEMA +**Message:** Failed to retrieve OpenAPI schema for service with id "%s": %s + +### PLT_SQL_RUNTIME_APPLICATION_ALREADY_STARTED +**Message:** Application is already started + +### PLT_SQL_RUNTIME_APPLICATION_NOT_STARTED +**Message:** Application has not been started + +### PLT_SQL_RUNTIME_CONFIG_PATH_MUST_BE_STRING +**Message:** Config path must be a string + +### PLT_SQL_RUNTIME_NO_CONFIG_FILE_FOUND +**Message:** No config file found for service '%s' + +### PLT_SQL_RUNTIME_INVALID_ENTRYPOINT +**Message:** Invalid entrypoint: '%s' does not exist + +### PLT_SQL_RUNTIME_MISSING_DEPENDENCY +**Message:** Missing dependency: "%s" + +### PLT_SQL_RUNTIME_INSPECT_AND_INSPECT_BRK +**Message:** --inspect and --inspect-brk cannot be used together + +### PLT_SQL_RUNTIME_INSPECTOR_PORT +**Message:** Inspector port must be 0 or in range 1024 to 65535 + +### PLT_SQL_RUNTIME_INSPECTOR_HOST +**Message:** Inspector host cannot be empty + +### PLT_SQL_RUNTIME_CANNOT_MAP_SPECIFIER_TO_ABSOLUTE_PATH +**Message:** Cannot map "%s" to an absolute path + +### PLT_SQL_RUNTIME_NODE_INSPECTOR_FLAGS_NOT_SUPPORTED +**Message:** The Node.js inspector flags are not supported. Please use 'platformatic start --inspect' instead. + +## @platformatic/service + +**No errors defined** + +## @platformatic/sql-mapper + +### PLT_SQL_MAPPER_CANNOT_FIND_ENTITY +**Message:** Cannot find entity %s + +### PLT_SQL_MAPPER_SPECIFY_PROTOCOLS +**Message:** You must specify either postgres, mysql or sqlite as protocols + +### PLT_SQL_MAPPER_CONNECTION_STRING_REQUIRED +**Message:** connectionString is required + +### PLT_SQL_MAPPER_TABLE_MUST_BE_A_STRING +**Message:** Table must be a string, got %s + +### PLT_SQL_MAPPER_UNKNOWN_FIELD +**Message:** Unknown field %s + +### PLT_SQL_MAPPER_INPUT_NOT_PROVIDED +**Message:** Input not provided. + +### PLT_SQL_MAPPER_UNSUPPORTED_WHERE_CLAUSE +**Message:** Unsupported where clause %s + +### PLT_SQL_MAPPER_UNSUPPORTED_OPERATOR +**Message:** Unsupported operator for Array field + +### PLT_SQL_MAPPER_UNSUPPORTED_OPERATOR_FOR_NON_ARRAY +**Message:** Unsupported operator for non Array field + +### PLT_SQL_MAPPER_PARAM_NOT_ALLOWED +**Message:** Param offset=%s not allowed. It must be not negative value. + +### PLT_SQL_MAPPER_INVALID_PRIMARY_KEY_TYPE +**Message:** Invalid Primary Key type: "%s". We support the following: %s + +### PLT_SQL_MAPPER_PARAM_LIMIT_NOT_ALLOWED +**Message:** Param limit=%s not allowed. Max accepted value %s. + +### PLT_SQL_MAPPER_PARAM_LIMIT_MUST_BE_NOT_NEGATIVE +**Message:** Param limit=%s not allowed. It must be a not negative value. + +### PLT_SQL_MAPPER_MISSING_VALUE_FOR_PRIMARY_KEY +**Message:** Missing value for primary key %s + +### PLT_SQL_MAPPER_SQLITE_ONLY_SUPPORTS_AUTO_INCREMENT_ON_ONE_COLUMN +**Message:** SQLite only supports autoIncrement on one column + +## @platformatic/sql-openapi + +### PLT_SQL_OPENAPI_UNABLE_CREATE_ROUTE_FOR_REVERSE_RELATIONSHIP +**Message:** Unable to create the route for the reverse relationship + +### PLT_SQL_OPENAPI_UNABLE_CREATE_ROUTE_FOR_PK_COL_RELATIONSHIP +**Message:** Unable to create the route for the PK col relationship + +## @platformatic/sql-graphql + +### PLT_SQL_GRAPHQL_UNABLE_GENERATE_GRAPHQL_ENUM_TYPE +**Message:** Unable to generate GraphQLEnumType + +### PLT_SQL_GRAPHQL_UNSUPPORTED_KIND +**Message:** Unsupported kind: %s + +### PLT_SQL_GRAPHQL_ERROR_PRINTING_GRAPHQL_SCHEMA +**Message:** Error printing the GraphQL schema + +## @platformatic/sql-events + +### PLT_SQL_EVENTS_OBJECT_IS_REQUIRED_UNDER_THE_DATA_PROPERTY +**Message:** The object that will be published is required under the data property + +### PLT_SQL_EVENTS_PRIMARY_KEY_IS_NECESSARY_INSIDE_DATA +**Message:** The primaryKey is necessary inside data + +### PLT_SQL_EVENTS_NO_SUCH_ACTION +**Message:** No such action %s + +## @platformatic/sql-json-schema-mapper + +**No errors defined** + +## @platformatic/telemetry + +**No errors defined** + +## @platformatic/utils + +### PLT_SQL_UTILS_PATH_OPTION_REQUIRED +**Message:** path option is required diff --git a/versioned_docs/version-0.43.0/reference/runtime/configuration.md b/versioned_docs/version-0.46.1/reference/runtime/configuration.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/runtime/configuration.md rename to versioned_docs/version-0.46.1/reference/runtime/configuration.md diff --git a/versioned_docs/version-0.43.0/reference/runtime/introduction.md b/versioned_docs/version-0.46.1/reference/runtime/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/runtime/introduction.md rename to versioned_docs/version-0.46.1/reference/runtime/introduction.md diff --git a/versioned_docs/version-0.43.0/reference/runtime/programmatic.md b/versioned_docs/version-0.46.1/reference/runtime/programmatic.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/runtime/programmatic.md rename to versioned_docs/version-0.46.1/reference/runtime/programmatic.md diff --git a/versioned_docs/version-0.43.0/reference/service/configuration.md b/versioned_docs/version-0.46.1/reference/service/configuration.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/service/configuration.md rename to versioned_docs/version-0.46.1/reference/service/configuration.md diff --git a/versioned_docs/version-0.43.0/reference/service/introduction.md b/versioned_docs/version-0.46.1/reference/service/introduction.md similarity index 93% rename from versioned_docs/version-0.43.0/reference/service/introduction.md rename to versioned_docs/version-0.46.1/reference/service/introduction.md index b05acdcdbb..17ae1908d7 100644 --- a/versioned_docs/version-0.43.0/reference/service/introduction.md +++ b/versioned_docs/version-0.46.1/reference/service/introduction.md @@ -31,3 +31,7 @@ If you run into a bug or have a suggestion for improvement, please If you're only interested in the features available in Platformatic Service, you can simply switch `platformatic` with `@platformatic/service` in the `dependencies` of your `package.json`, so that you'll only import fewer deps. You can use the `plt-service` command, it's the equivalent of `plt service`. + +## TypeScript + +To generate the types for the application, run `platformatic db types`. diff --git a/versioned_docs/version-0.43.0/reference/service/plugin.md b/versioned_docs/version-0.46.1/reference/service/plugin.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/service/plugin.md rename to versioned_docs/version-0.46.1/reference/service/plugin.md diff --git a/versioned_docs/version-0.43.0/reference/service/programmatic.md b/versioned_docs/version-0.46.1/reference/service/programmatic.md similarity index 61% rename from versioned_docs/version-0.43.0/reference/service/programmatic.md rename to versioned_docs/version-0.46.1/reference/service/programmatic.md index f1e0d56df4..8119745801 100644 --- a/versioned_docs/version-0.43.0/reference/service/programmatic.md +++ b/versioned_docs/version-0.46.1/reference/service/programmatic.md @@ -98,3 +98,56 @@ console.log(await res.json()) await service.close() ``` + +## TypeScript support + + +In order for this module to work on a TypeScript setup (outside of an application created with `create-platformatic`), +you have to add the following to your types: + +```ts +import { FastifyInstance } from 'fastify' +import { PlatformaticApp, PlatformaticServiceConfig } from '@platformatic/service' + +declare module 'fastify' { + interface FastifyInstance { + platformatic: PlatformaticApp<PlatformaticServiceConfig> + } +} +``` + +Then, you can use it: + +```ts +/// <reference path="./global.d.ts" /> +import { FastifyInstance } from 'fastify' + +export default async function (app: FastifyInstance) { + app.get('/', async () => { + return app.platformatic.config + }) +} +``` + +You can always generate a file called `global.d.ts` with the above content via the `platformatic service types` command. + + +### Usage with custom configuration + +If you are creating a reusable application on top of Platformatic Service, you would need to create the types for your schema, +using [json-schema-to-typescript](https://www.npmjs.com/package/json-schema-to-typescript) in a `./config.d.ts` file and +use it like so: + +```ts +import { FastifyInstance } from 'fastify' +import { PlatformaticApp } from '@platformatic/service' +import { YourApp } from './config' + +declare module 'fastify' { + interface FastifyInstance { + platformatic: PlatformaticApp<YourApp> + } +} +``` + +Note that you can construct `platformatic` like any other union types, adding other definitions. diff --git a/versioned_docs/version-0.43.0/reference/sql-events/fastify-plugin.md b/versioned_docs/version-0.46.1/reference/sql-events/fastify-plugin.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-events/fastify-plugin.md rename to versioned_docs/version-0.46.1/reference/sql-events/fastify-plugin.md diff --git a/versioned_docs/version-0.43.0/reference/sql-events/introduction.md b/versioned_docs/version-0.46.1/reference/sql-events/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-events/introduction.md rename to versioned_docs/version-0.46.1/reference/sql-events/introduction.md diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/examples/deleteEntity.js b/versioned_docs/version-0.46.1/reference/sql-graphql/examples/deleteEntity.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-graphql/examples/deleteEntity.js rename to versioned_docs/version-0.46.1/reference/sql-graphql/examples/deleteEntity.js diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/examples/insertEntity.js b/versioned_docs/version-0.46.1/reference/sql-graphql/examples/insertEntity.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-graphql/examples/insertEntity.js rename to versioned_docs/version-0.46.1/reference/sql-graphql/examples/insertEntity.js diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/examples/query.js b/versioned_docs/version-0.46.1/reference/sql-graphql/examples/query.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-graphql/examples/query.js rename to versioned_docs/version-0.46.1/reference/sql-graphql/examples/query.js diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/examples/saveEntity.js b/versioned_docs/version-0.46.1/reference/sql-graphql/examples/saveEntity.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-graphql/examples/saveEntity.js rename to versioned_docs/version-0.46.1/reference/sql-graphql/examples/saveEntity.js diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/ignore.md b/versioned_docs/version-0.46.1/reference/sql-graphql/ignore.md similarity index 90% rename from versioned_docs/version-0.43.0/reference/sql-graphql/ignore.md rename to versioned_docs/version-0.46.1/reference/sql-graphql/ignore.md index 66d59e16fd..090e7a63f8 100644 --- a/versioned_docs/version-0.43.0/reference/sql-graphql/ignore.md +++ b/versioned_docs/version-0.46.1/reference/sql-graphql/ignore.md @@ -7,7 +7,7 @@ To ignore types: ```javascript app.register(require('@platformatic/sql-graphql'), { ignore: { - categories: true + category: true } }) ``` @@ -17,7 +17,7 @@ To ignore individual fields: ```javascript app.register(require('@platformatic/sql-graphql'), { ignore: { - categories: { + category: { name: true } } diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/introduction.md b/versioned_docs/version-0.46.1/reference/sql-graphql/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-graphql/introduction.md rename to versioned_docs/version-0.46.1/reference/sql-graphql/introduction.md diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/many-to-many.md b/versioned_docs/version-0.46.1/reference/sql-graphql/many-to-many.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-graphql/many-to-many.md rename to versioned_docs/version-0.46.1/reference/sql-graphql/many-to-many.md diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/mutations.md b/versioned_docs/version-0.46.1/reference/sql-graphql/mutations.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-graphql/mutations.md rename to versioned_docs/version-0.46.1/reference/sql-graphql/mutations.md diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/queries.md b/versioned_docs/version-0.46.1/reference/sql-graphql/queries.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-graphql/queries.md rename to versioned_docs/version-0.46.1/reference/sql-graphql/queries.md diff --git a/versioned_docs/version-0.43.0/reference/sql-graphql/subscriptions.md b/versioned_docs/version-0.46.1/reference/sql-graphql/subscriptions.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-graphql/subscriptions.md rename to versioned_docs/version-0.46.1/reference/sql-graphql/subscriptions.md diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/entities/api.md b/versioned_docs/version-0.46.1/reference/sql-mapper/entities/api.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/entities/api.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/entities/api.md diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/entities/example.md b/versioned_docs/version-0.46.1/reference/sql-mapper/entities/example.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/entities/example.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/entities/example.md diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/entities/fields.md b/versioned_docs/version-0.46.1/reference/sql-mapper/entities/fields.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/entities/fields.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/entities/fields.md diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/entities/hooks.md b/versioned_docs/version-0.46.1/reference/sql-mapper/entities/hooks.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/entities/hooks.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/entities/hooks.md diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/entities/introduction.md b/versioned_docs/version-0.46.1/reference/sql-mapper/entities/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/entities/introduction.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/entities/introduction.md diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/entities/relations.md b/versioned_docs/version-0.46.1/reference/sql-mapper/entities/relations.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/entities/relations.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/entities/relations.md diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/entities/timestamps.md b/versioned_docs/version-0.46.1/reference/sql-mapper/entities/timestamps.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/entities/timestamps.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/entities/timestamps.md diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/entities/transactions.md b/versioned_docs/version-0.46.1/reference/sql-mapper/entities/transactions.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/entities/transactions.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/entities/transactions.md diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/examples/count.js b/versioned_docs/version-0.46.1/reference/sql-mapper/examples/count.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/examples/count.js rename to versioned_docs/version-0.46.1/reference/sql-mapper/examples/count.js diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/examples/delete.js b/versioned_docs/version-0.46.1/reference/sql-mapper/examples/delete.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/examples/delete.js rename to versioned_docs/version-0.46.1/reference/sql-mapper/examples/delete.js diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/examples/fastify-plugin.js b/versioned_docs/version-0.46.1/reference/sql-mapper/examples/fastify-plugin.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/examples/fastify-plugin.js rename to versioned_docs/version-0.46.1/reference/sql-mapper/examples/fastify-plugin.js diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/examples/fields.js b/versioned_docs/version-0.46.1/reference/sql-mapper/examples/fields.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/examples/fields.js rename to versioned_docs/version-0.46.1/reference/sql-mapper/examples/fields.js diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/examples/find.js b/versioned_docs/version-0.46.1/reference/sql-mapper/examples/find.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/examples/find.js rename to versioned_docs/version-0.46.1/reference/sql-mapper/examples/find.js diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/examples/hooks.js b/versioned_docs/version-0.46.1/reference/sql-mapper/examples/hooks.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/examples/hooks.js rename to versioned_docs/version-0.46.1/reference/sql-mapper/examples/hooks.js diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/examples/insert.js b/versioned_docs/version-0.46.1/reference/sql-mapper/examples/insert.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/examples/insert.js rename to versioned_docs/version-0.46.1/reference/sql-mapper/examples/insert.js diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/examples/relations.js b/versioned_docs/version-0.46.1/reference/sql-mapper/examples/relations.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/examples/relations.js rename to versioned_docs/version-0.46.1/reference/sql-mapper/examples/relations.js diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/examples/save.js b/versioned_docs/version-0.46.1/reference/sql-mapper/examples/save.js similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/examples/save.js rename to versioned_docs/version-0.46.1/reference/sql-mapper/examples/save.js diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/fastify-plugin.md b/versioned_docs/version-0.46.1/reference/sql-mapper/fastify-plugin.md similarity index 78% rename from versioned_docs/version-0.43.0/reference/sql-mapper/fastify-plugin.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/fastify-plugin.md index 5761ba88bf..e9a1064a0b 100644 --- a/versioned_docs/version-0.43.0/reference/sql-mapper/fastify-plugin.md +++ b/versioned_docs/version-0.46.1/reference/sql-mapper/fastify-plugin.md @@ -52,3 +52,28 @@ async function main() { main() ``` + +#### TypeScript support + +In order for this module to work on a TypeScript setup (outside of a Platformatic application), +you have to add the following to your types: + +```ts +import { Entities, Entity } from '@platformatic/sql-mapper' + +type Movie { + id: number, + title: string +} + +interface AppEntities extends Entities { + movie: Entity<Movie> +} + +declare module 'fastify' { + interface FastifyInstance { + platformatic: SQLMapperPluginInterface<AppEntities> + } +} +``` + diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/images/plt-db-hooks.svg b/versioned_docs/version-0.46.1/reference/sql-mapper/images/plt-db-hooks.svg similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/images/plt-db-hooks.svg rename to versioned_docs/version-0.46.1/reference/sql-mapper/images/plt-db-hooks.svg diff --git a/versioned_docs/version-0.43.0/reference/sql-mapper/introduction.md b/versioned_docs/version-0.46.1/reference/sql-mapper/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-mapper/introduction.md rename to versioned_docs/version-0.46.1/reference/sql-mapper/introduction.md diff --git a/versioned_docs/version-0.43.0/reference/sql-openapi/api.md b/versioned_docs/version-0.46.1/reference/sql-openapi/api.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-openapi/api.md rename to versioned_docs/version-0.46.1/reference/sql-openapi/api.md diff --git a/versioned_docs/version-0.43.0/reference/sql-openapi/ignore.md b/versioned_docs/version-0.46.1/reference/sql-openapi/ignore.md similarity index 90% rename from versioned_docs/version-0.43.0/reference/sql-openapi/ignore.md rename to versioned_docs/version-0.46.1/reference/sql-openapi/ignore.md index 9f17db2694..9f32e0344c 100644 --- a/versioned_docs/version-0.43.0/reference/sql-openapi/ignore.md +++ b/versioned_docs/version-0.46.1/reference/sql-openapi/ignore.md @@ -7,7 +7,7 @@ To ignore entites: ```javascript app.register(require('@platformatic/sql-openapi'), { ignore: { - categories: true + category: true } }) ``` @@ -17,7 +17,7 @@ To ignore individual fields: ```javascript app.register(require('@platformatic/sql-openapi'), { ignore: { - categories: { + category: { name: true } } diff --git a/versioned_docs/version-0.43.0/reference/sql-openapi/introduction.md b/versioned_docs/version-0.46.1/reference/sql-openapi/introduction.md similarity index 100% rename from versioned_docs/version-0.43.0/reference/sql-openapi/introduction.md rename to versioned_docs/version-0.46.1/reference/sql-openapi/introduction.md diff --git a/versioned_sidebars/version-0.43.0-sidebars.json b/versioned_sidebars/version-0.46.1-sidebars.json similarity index 100% rename from versioned_sidebars/version-0.43.0-sidebars.json rename to versioned_sidebars/version-0.46.1-sidebars.json diff --git a/versions.json b/versions.json index 6daf18f727..dabee6f486 100644 --- a/versions.json +++ b/versions.json @@ -1,7 +1,7 @@ [ + "0.46.1", "0.45.1", "0.45.0", "0.44.0", - "0.43.1", - "0.43.0" + "0.43.1" ] \ No newline at end of file