diff --git a/docs/getting-started/graphql.md b/docs/getting-started/graphql.md index 25dfbaf..3ea84ad 100644 --- a/docs/getting-started/graphql.md +++ b/docs/getting-started/graphql.md @@ -275,7 +275,7 @@ In this query, we apply both a filter and a sorting option to the products query By combining filters and sorting options in your GraphQL queries, you can retrieve data that is both relevant to your application and organized in a way that meets your specific needs. This flexibility allows you to tailor your queries to your requirements and optimize data retrieval and processing. -You can also use AND, OR, NOT and nested queries. Find more about operators and nested filtering condition in [Tailor DB](/guides/tailordb/overview). +You can also use AND, OR, NOT and nested queries. Find more about operators and nested filtering condition in [TailorDB](/guides/tailordb/overview). ## Pagination diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 6eba768..624c7b0 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -13,13 +13,13 @@ Here is a quick look at the console. ![Tailor Console](./assets/console-application-overview.png) -## Tailor SDK +## Tailor Platform SDK The `tailor-sdk` is the command-line interface for building, deploying, and managing applications on the Tailor Platform. It provides a comprehensive set of tools for working with TailorDB, Functions, Workflows and Auth. ### Installation -The Tailor SDK requires Node.js 22 or later. You can use it in three ways: +The Tailor Platform SDK requires Node.js 22 or later. You can use it in three ways: **1. With npx (recommended for quick start):** diff --git a/docs/guides/auth/overview.md b/docs/guides/auth/overview.md index 6be1569..75a8323 100644 --- a/docs/guides/auth/overview.md +++ b/docs/guides/auth/overview.md @@ -320,7 +320,7 @@ const auth = defineAuth("my-auth", { ## Machine user A Machine user can manage users and application data, including creating, modifying, and deleting them. -To add a Machine user to the application, you must first define the user roles in the Tailor DB, and then assign a specific role in the Auth service. +To add a Machine user to the application, you must first define the user roles in the TailorDB, and then assign a specific role in the Auth service. Here is an example of a Machine user configuration with the SDK: diff --git a/docs/guides/auth/scim.md b/docs/guides/auth/scim.md index f3b09e5..5550485 100644 --- a/docs/guides/auth/scim.md +++ b/docs/guides/auth/scim.md @@ -203,7 +203,7 @@ attributeMapping: [ ## Complete Example -Here is a complete example showing SCIM configuration with the Tailor SDK: +Here is a complete example showing SCIM configuration with the Tailor Platform SDK: ```typescript import { defineAuth } from "@tailor-platform/sdk"; diff --git a/docs/guides/events.md b/docs/guides/events.md index 0f56271..4f12115 100644 --- a/docs/guides/events.md +++ b/docs/guides/events.md @@ -8,7 +8,7 @@ The Tailor Platform offers a wide range of events that allow you to trigger spec Below is a list of supported events and their payloads. -## Tailor DB +## TailorDB ### Record Created @@ -40,7 +40,7 @@ Below is a list of supported events and their payloads. `newRecord` - `Object`: The new record added to Tailor DB. + `Object`: The new record added to TailorDB. @@ -75,12 +75,12 @@ Below is a list of supported events and their payloads. `oldRecord` - `Object`: The old record in Tailor DB. + `Object`: The old record in TailorDB. `newRecord` - `Object`: The updated record in Tailor DB. + `Object`: The updated record in TailorDB. diff --git a/docs/guides/executor/event-based-trigger.md b/docs/guides/executor/event-based-trigger.md index e99dc69..69ade51 100644 --- a/docs/guides/executor/event-based-trigger.md +++ b/docs/guides/executor/event-based-trigger.md @@ -4,7 +4,7 @@ doc_type: guide # Event-based Trigger -In this trigger, you can specify the type of event that initiates it (e.g., Tailor DB data update and StateFlow creation) and outline the specific conditions or criteria for its execution. +In this trigger, you can specify the type of event that initiates it (e.g., TailorDB data update and StateFlow creation) and outline the specific conditions or criteria for its execution. Refer [Supported Events](/guides/events) to learn about the different types of events supported in the Tailor Platform. Follow the [tutorial](/tutorials/setup-executor/event-based-trigger) for setup instructions. diff --git a/docs/guides/executor/overview.md b/docs/guides/executor/overview.md index 57036fa..05968f9 100644 --- a/docs/guides/executor/overview.md +++ b/docs/guides/executor/overview.md @@ -92,12 +92,12 @@ You can configure the following three types of triggers to execute the user defi ## Operation -The `operation` property defines the action to be executed when the Trigger condition is met. You can describe the specific task or operation to be performed, such as querying Tailor DB, sending notifications, or triggering workflows. +The `operation` property defines the action to be executed when the Trigger condition is met. You can describe the specific task or operation to be performed, such as querying TailorDB, sending notifications, or triggering workflows. There are five types of targets: 1. [TailorGraphql](tailor-graphql-operation) -This involves interaction with the Tailor DB and performs operations such as querying data or making changes (mutations). +This involves interaction with the TailorDB and performs operations such as querying data or making changes (mutations). 2. [Webhook](webhook-operation) diff --git a/docs/guides/function/accessing-tailordb.md b/docs/guides/function/accessing-tailordb.md index da76e1f..5acf43b 100644 --- a/docs/guides/function/accessing-tailordb.md +++ b/docs/guides/function/accessing-tailordb.md @@ -2,11 +2,11 @@ doc_type: guide --- -# Accessing Tailor DB +# Accessing TailorDB -In order to access Tailor DB from Function service, you need to instantiate the `Client` object from the `tailordb` package. +In order to access TailorDB from Function service, you need to instantiate the `Client` object from the `tailordb` package. `tailordb` exists in the Function service environment by default, so you can use it without any additional installation. -Please specify the `namespace` of the Tailor DB you want to connect to when creating the `Client` object. +Please specify the `namespace` of the TailorDB you want to connect to when creating the `Client` object. Here is the `Client` interface: @@ -29,9 +29,9 @@ type Transaction = { Please refer to the [Supported SQL queries](#supported-sql-queries) for more information on the SQL syntax supported in `Client.queryObject`. -## Sample codes to access Tailor DB in JavaScript +## Sample codes to access TailorDB in JavaScript -### Getting data from Tailor DB +### Getting data from TailorDB ```js {{ title: 'get_data_function.js' }} globalThis.main = async function () { @@ -49,7 +49,7 @@ globalThis.main = async function () { }; ``` -### Inserting data to Tailor DB +### Inserting data to TailorDB ```js {{ title: 'insert_data_function.js' }} globalThis.main = async function (args) { @@ -194,7 +194,7 @@ npx tailor deploy ## Supported SQL queries -Strictly speaking, the SQL statements here are executed via a proxy to Tailor DB. +Strictly speaking, the SQL statements here are executed via a proxy to TailorDB. The SQL that can be issued is a subset of PostgreSQL, so the fundamental syntax follows PostgreSQL conventions. ### SELECT diff --git a/docs/guides/function/overview.md b/docs/guides/function/overview.md index f6e9327..a9eeafd 100644 --- a/docs/guides/function/overview.md +++ b/docs/guides/function/overview.md @@ -13,7 +13,7 @@ This provides a flexible way to extend your application's functionality with cus With Function service, you can: - Send HTTP requests to 3rd party applications -- Access and execute SQL queries to Tailor DB +- Access and execute SQL queries to TailorDB - Manage IdP users, secrets, files, and workflows via [built-in interfaces](/guides/function/builtin-interfaces) - Process data transformations - Implement custom business logic with npm packages @@ -23,7 +23,7 @@ For more advanced use cases, you can refer to these sections: - [Built-in interfaces](/guides/function/builtin-interfaces) — all platform APIs available as global variables - [Sending HTTP request](/guides/function/sending-request) -- [Accessing Tailor DB](/guides/function/accessing-tailordb) +- [Accessing TailorDB](/guides/function/accessing-tailordb) ## How to write and deploy your code in Function service @@ -196,6 +196,6 @@ For more advanced use cases, you can refer to these sections: - [Built-in interfaces](/guides/function/builtin-interfaces) — all platform APIs available as global variables (IdP, secrets, files, workflows, etc.) - [Sending HTTP request](/guides/function/sending-request) -- [Accessing Tailor DB](/guides/function/accessing-tailordb) +- [Accessing TailorDB](/guides/function/accessing-tailordb) For list of supported packages, please refer to [Appendix](/guides/function/appendix). diff --git a/docs/guides/integration/shopify.md b/docs/guides/integration/shopify.md index 631f1a5..e3c5332 100644 --- a/docs/guides/integration/shopify.md +++ b/docs/guides/integration/shopify.md @@ -12,8 +12,8 @@ You can integrate Shopify with Tailor Platform using triggers. Refer to [executo ## Automatically push new products to your Shopify store -When you create a new product in the Tailor DB, you may want to seamlessly sync that data with your Shopify store. -This integration guide will walk you through the steps to set up a connection between Tailor PF and Shopify, ensuring that every time a new product is added to the Tailor DB, it's automatically pushed to your Shopify storefront. +When you create a new product in the TailorDB, you may want to seamlessly sync that data with your Shopify store. +This integration guide will walk you through the steps to set up a connection between Tailor PF and Shopify, ensuring that every time a new product is added to the TailorDB, it's automatically pushed to your Shopify storefront. ### 1. Get the API key @@ -84,7 +84,7 @@ tailor-sdk secret create --vault-name shopify-vault --name shopify-key --value { 3. Add the trigger -Below is an example of the trigger that will push new product to Shopify store when a product is added to the Tailor DB. +Below is an example of the trigger that will push new product to Shopify store when a product is added to the TailorDB. ```typescript {{ title: 'executors/shopify-sync.ts' }} import { createExecutor, recordCreatedTrigger } from "@tailor-platform/sdk"; @@ -229,7 +229,7 @@ You have now successfully created the webhook to receive notifications in the Ta ### 3. Verify the trigger -You can open the GraphQL playground to verify the product created in Shopify is added to Tailor DB. +You can open the GraphQL playground to verify the product created in Shopify is added to TailorDB. ```bash # Open the GraphQL playground in the browser diff --git a/docs/guides/tailordb/advanced-settings/aggregation.md b/docs/guides/tailordb/advanced-settings/aggregation.md index e1c34a8..37d5870 100644 --- a/docs/guides/tailordb/advanced-settings/aggregation.md +++ b/docs/guides/tailordb/advanced-settings/aggregation.md @@ -29,7 +29,7 @@ export const payroll = db }); ``` -Tailor DB auto-generates `aggregatePayrolls`, allowing you to quickly retrieve summarized results for Payroll.\ +TailorDB auto-generates `aggregatePayrolls`, allowing you to quickly retrieve summarized results for Payroll.\ Based on the `payroll` type, here's the sample query to aggregate the payroll data: ```graphql {{ title: 'query' }} diff --git a/docs/guides/tailordb/advanced-settings/bulk-upsert.md b/docs/guides/tailordb/advanced-settings/bulk-upsert.md index ad753f1..8ae226e 100644 --- a/docs/guides/tailordb/advanced-settings/bulk-upsert.md +++ b/docs/guides/tailordb/advanced-settings/bulk-upsert.md @@ -19,7 +19,7 @@ export const document = db }); ``` -Tailor DB auto-generates `bulkUpsertDocuments`, allowing you to quickly bulk upsert data for Document. +TailorDB auto-generates `bulkUpsertDocuments`, allowing you to quickly bulk upsert data for Document. Use the following query to upsert existing document resources: ```graphql {{ title: 'query' }} @@ -35,7 +35,7 @@ mutation { If the input contains existing IDs, the data properties will be updated for those inputs. New data records will be created if the ID does not exist, is null, or is not passed as an input property. -Here are examples of queries for creating new records in Tailor DB when using bulk upsert. +Here are examples of queries for creating new records in TailorDB when using bulk upsert. ```graphql {{ title: 'query' }} mutation { @@ -60,7 +60,7 @@ The maximum number of items that can be included in a single bulk upsert operati ## BulkUpsert with PluralForm settings -When `PluralForm` is configured in the settings, as mentioned in the example below, Tailor DB auto-generates `bulkUpsertUserDataList` instead of `bulkUpsertUserData` for bulk upserting data of the `UserData` type. Refer [PluralForm](/guides/tailordb/advanced-settings/uncountable-nouns) to learn about its setting. +When `PluralForm` is configured in the settings, as mentioned in the example below, TailorDB auto-generates `bulkUpsertUserDataList` instead of `bulkUpsertUserData` for bulk upserting data of the `UserData` type. Refer [PluralForm](/guides/tailordb/advanced-settings/uncountable-nouns) to learn about its setting. ```typescript import { db } from "@tailor-platform/sdk"; diff --git a/docs/guides/tailordb/advanced-settings/overview.md b/docs/guides/tailordb/advanced-settings/overview.md index a21d461..f596d82 100644 --- a/docs/guides/tailordb/advanced-settings/overview.md +++ b/docs/guides/tailordb/advanced-settings/overview.md @@ -10,7 +10,7 @@ These features include: - [Aggregating values](aggregation) - [Bulk upsert](bulk-upsert) - [Plural form for uncountable nouns](uncountable-nouns) -- [Tailor DB Change Data Capture(CDC)](tailordb-cdc) - Publish record events for database triggers +- [TailorDB Change Data Capture(CDC)](tailordb-cdc) - Publish record events for database triggers Below is a table listing all the available `settings`, with each field and its corresponding type. @@ -106,7 +106,7 @@ See [GraphQL Directives](https://graphql.org/learn/queries/#directives) for more ## Extends The `Extends` option enables the extension of the types defined in other sub-graphs, like StateFlow. -With this option enabled, CRUD GraphQL queries become available in Tailor DB. +With this option enabled, CRUD GraphQL queries become available in TailorDB. To make this work, the directive of `@key(fields: "id")` must be defined. For example, if we want to extend State resource in StateFlow, we can define the `extend` and directives in the schema as follows: diff --git a/docs/guides/tailordb/advanced-settings/tailordb-cdc.md b/docs/guides/tailordb/advanced-settings/tailordb-cdc.md index 674967e..e49c9fc 100644 --- a/docs/guides/tailordb/advanced-settings/tailordb-cdc.md +++ b/docs/guides/tailordb/advanced-settings/tailordb-cdc.md @@ -2,11 +2,11 @@ doc_type: guide --- -# Tailor DB CDC +# TailorDB CDC ## Publish record events for database triggers -Change data capture (CDC) enables you to track and capture all changes in your data within Tailor DB, including new record insertions, updates to existing records, and deletions. To use this feature, enable `PublishRecordEvents` in the settings for your desired data type in Tailor DB. Once enabled, any changes to records of this type will trigger the publication of record events. These events are then processed by the corresponding `Executor` service, which initiates the jobs defined based on these changes. +Change data capture (CDC) enables you to track and capture all changes in your data within TailorDB, including new record insertions, updates to existing records, and deletions. To use this feature, enable `PublishRecordEvents` in the settings for your desired data type in TailorDB. Once enabled, any changes to records of this type will trigger the publication of record events. These events are then processed by the corresponding `Executor` service, which initiates the jobs defined based on these changes. For example, to call a trigger for every PurchaseOrder type record created, you'll need to enable `PublishRecordEvents` in the settings. Refer [Event based trigger](/tutorials/setup-executor/event-based-trigger#4enablepublishrecordeventssettings) to learn more. diff --git a/docs/guides/tailordb/advanced-settings/uncountable-nouns.md b/docs/guides/tailordb/advanced-settings/uncountable-nouns.md index 179df98..2620cd1 100644 --- a/docs/guides/tailordb/advanced-settings/uncountable-nouns.md +++ b/docs/guides/tailordb/advanced-settings/uncountable-nouns.md @@ -4,10 +4,10 @@ doc_type: guide # Plural form for uncountable nouns -The `PluralForm` field accepts the plural form for an uncountable noun type in your Tailor DB. +The `PluralForm` field accepts the plural form for an uncountable noun type in your TailorDB. This setting is necessary to access individual records when the type name is an uncountable noun. -For example, to create type `userData` in the Tailor DB, configure the `PluralForm` in the settings as the following: +For example, to create type `userData` in the TailorDB, configure the `PluralForm` in the settings as the following: ```typescript import { db } from "@tailor-platform/sdk"; diff --git a/docs/guides/tailordb/fields.md b/docs/guides/tailordb/fields.md index 4680f13..9b0be6e 100644 --- a/docs/guides/tailordb/fields.md +++ b/docs/guides/tailordb/fields.md @@ -93,8 +93,8 @@ The SDK provides the following field type methods: Visit [tailordb types](https://registry.terraform.io/providers/tailor-platform/tailor/latest/docs/resources/tailordb_type) to learn more about the types. -Here are the available list of data types in Tailor DB. -For details about the filter, refer to [Tailor DB Filter](/guides/tailordb/filters) specification. +Here are the available list of data types in TailorDB. +For details about the filter, refer to [TailorDB Filter](/guides/tailordb/filters) specification. | Predefined Data Type | Type Description | Available Filters | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | @@ -115,8 +115,8 @@ As for the `Type` field, set one of the following data types as `tailordb.# - Build with TypeScript using the modern Tailor SDK. Type-safe development with streamlined workflows. + Build with TypeScript using the modern Tailor Platform SDK. Type-safe development with streamlined workflows. diff --git a/docs/tutorials/develop-from-scratch/overview.md b/docs/tutorials/develop-from-scratch/overview.md index d469b49..164ad03 100644 --- a/docs/tutorials/develop-from-scratch/overview.md +++ b/docs/tutorials/develop-from-scratch/overview.md @@ -1,4 +1,4 @@ -# Develop from Scratch with Tailor SDK +# Develop from Scratch with Tailor Platform SDK Build a project management app with database types, auth, resolvers, and executors using TypeScript. @@ -40,7 +40,7 @@ project-management/ ## Additional Resources -- [Tailor SDK Documentation](../../sdk/quickstart) +- [Tailor Platform SDK Documentation](../../sdk/quickstart) - [TailorDB Service](../../sdk/services/tailordb) - [Resolver Service](../../sdk/services/resolver) - [Executor Service](../../sdk/services/executor) diff --git a/docs/tutorials/develop-from-scratch/step-01.md b/docs/tutorials/develop-from-scratch/step-01.md index 75d5c4f..e949a56 100644 --- a/docs/tutorials/develop-from-scratch/step-01.md +++ b/docs/tutorials/develop-from-scratch/step-01.md @@ -1,6 +1,6 @@ # Step 1: Create Database Schema -This step establishes the foundational database schema for your project management application using the Tailor SDK. You'll define three core types (User, Project, Task) with relationships and automatic timestamp management, all using type-safe TypeScript. +This step establishes the foundational database schema for your project management application using the Tailor Platform SDK. You'll define three core types (User, Project, Task) with relationships and automatic timestamp management, all using type-safe TypeScript. [Source code on GitHub](https://github.com/tailor-platform/templates/tree/main/docs/build-from-scratch/sdk/step-01) diff --git a/docs/tutorials/manage-data-schema/import-csv-file.md b/docs/tutorials/manage-data-schema/import-csv-file.md index 93c7b66..f9be666 100644 --- a/docs/tutorials/manage-data-schema/import-csv-file.md +++ b/docs/tutorials/manage-data-schema/import-csv-file.md @@ -2,7 +2,7 @@ CSV files are plain text files that contain tabular data, with each field separated by a comma. -To import data from a CSV file to the Tailor DB, you can use the [Console](https://console.tailor.tech). +To import data from a CSV file to the TailorDB, you can use the [Console](https://console.tailor.tech). ## 1. Select workspace @@ -24,7 +24,7 @@ Here you can download the template by clicking on the button `Download Template` id,name,description,status,startDate,endDate,budget,priority,createdAt,updatedAt ``` -Add the following data to the example.csv to create a new product in Tailor DB. +Add the following data to the example.csv to create a new product in TailorDB. ``` Website Redesign,Complete overhaul of company website with modern UI/UX,IN_PROGRESS,2024-01-15,2024-06-30,2024-01-10T10:00:00Z,2024-02-09T15:30:00Z diff --git a/docs/tutorials/manage-data-schema/overview.md b/docs/tutorials/manage-data-schema/overview.md index a16a964..c142abd 100644 --- a/docs/tutorials/manage-data-schema/overview.md +++ b/docs/tutorials/manage-data-schema/overview.md @@ -2,9 +2,9 @@ Tailor Platform offers a powerful feature that allows you to generate GraphQL APIs from schema files. This makes it easy for your company to create a custom data schema that aligns perfectly with your business requirements. -The main database in Tailor Platform, where you store and retrieve your data, is called Tailor DB. With Tailor DB, you can effortlessly modify existing data schemas (data models) in our templates or add new Types (equivalent to Tables in a Relational Database). The GraphQL endpoint will be automatically generated, eliminating the need for additional coding. +The main database in Tailor Platform, where you store and retrieve your data, is called TailorDB. With TailorDB, you can effortlessly modify existing data schemas (data models) in our templates or add new Types (equivalent to Tables in a Relational Database). The GraphQL endpoint will be automatically generated, eliminating the need for additional coding. -This tutorial introduces you to Tailor DB. In the subsequent tutorials, you'll learn how to add fields to existing types, how to create new types and how to validate fields for your application. +This tutorial introduces you to TailorDB. In the subsequent tutorials, you'll learn how to add fields to existing types, how to create new types and how to validate fields for your application. ## What you'll learn diff --git a/docs/tutorials/setup-auth/login/create-oauth2-client.md b/docs/tutorials/setup-auth/login/create-oauth2-client.md index c3f165e..5ed3ae6 100644 --- a/docs/tutorials/setup-auth/login/create-oauth2-client.md +++ b/docs/tutorials/setup-auth/login/create-oauth2-client.md @@ -1,6 +1,6 @@ # Using OAuth2 to log in to the Tailor PF app -In this tutorial, you'll learn how to set up secure user access to your Tailor PF app using OAuth2 authentication with the Tailor SDK. +In this tutorial, you'll learn how to set up secure user access to your Tailor PF app using OAuth2 authentication with the Tailor Platform SDK. ## Prerequisites diff --git a/docs/tutorials/setup-auth/login/create-user.md b/docs/tutorials/setup-auth/login/create-user.md index 846f47d..8d9abf0 100644 --- a/docs/tutorials/setup-auth/login/create-user.md +++ b/docs/tutorials/setup-auth/login/create-user.md @@ -37,7 +37,7 @@ Click `Create User` to create a new user. ![Tutorials – Set up identity provider](../../assets/auth0-create-user.png) -### 2. Use a GraphQL query to create a user in the Tailor DB +### 2. Use a GraphQL query to create a user in the TailorDB Get an access token to use it in the GraphQL playground to run queries. diff --git a/docs/tutorials/setup-auth/register-identity-provider.md b/docs/tutorials/setup-auth/register-identity-provider.md index 293334e..6c6b994 100644 --- a/docs/tutorials/setup-auth/register-identity-provider.md +++ b/docs/tutorials/setup-auth/register-identity-provider.md @@ -1,6 +1,6 @@ # Register Identity provider with Auth service -To enable authentication through an identity provider, you need to register it with the Auth service. In this tutorial, you'll learn how to register IdPs for different authentication protocols using the Tailor SDK. +To enable authentication through an identity provider, you need to register it with the Auth service. In this tutorial, you'll learn how to register IdPs for different authentication protocols using the Tailor Platform SDK. ## Prerequisites