[automated commit] Bump docs to version 0.45.1

versioned_docs/version-0.45.1/reference/errors.md

@@ -0,0 +1,145 @@
+# Platformatic Errors 
+
+## @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 

versioned_docs/version-0.42.3/reference/service/introduction.md → versioned_docs/version-0.45.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`.

versioned_docs/version-0.42.3/reference/service/programmatic.md → versioned_docs/version-0.45.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.

versioned_docs/version-0.42.3/reference/sql-mapper/fastify-plugin.md → versioned_docs/version-0.45.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>
+  }
+}
+```
+

versions.json

@@ -1,7 +1,7 @@
 [
+  "0.45.1",
   "0.45.0",
   "0.44.0",
   "0.43.1",
-  "0.43.0",
-  "0.42.3"
+  "0.43.0"
 ]