@tailor-platform/sdk 0.0.1 → 0.8.0

package/dist/utils/test/index.d.mts

@@ -0,0 +1,40 @@
+/// <reference path="./../../plugin-generated.d.ts" />
+
+import { TailorDBType, TailorField, TailorUser } from "../../types-DSAthMLp.mjs";
+import { output } from "../../index-D-0knE68.mjs";
+import { StandardSchemaV1 } from "@standard-schema/spec";
+
+//#region src/utils/test/index.d.ts
+/** Represents an unauthenticated user in the Tailor platform. */
+declare const unauthenticatedTailorUser: TailorUser;
+/**
+ * Creates a hook function that processes TailorDB type fields
+ * - Uses existing id from data if provided, otherwise generates UUID for id fields
+ * - Recursively processes nested types
+ * - Executes hooks.create for fields with create hooks
+ *
+ * @template T - The output type of the hook function
+ * @param type - TailorDB type definition
+ * @returns A function that transforms input data according to field hooks
+ */
+declare function createTailorDBHook<T extends TailorDBType<any, any>>(type: T): (data: unknown) => Partial<output<T>>;
+/**
+ * Creates the standard schema definition for lines-db
+ * This returns the first argument for defineSchema with the ~standard section
+ *
+ * @template T - The output type after validation
+ * @param schemaType - TailorDB field schema for validation
+ * @param hook - Hook function to transform data before validation
+ * @returns Schema object with ~standard section for defineSchema
+ */
+declare function createStandardSchema<T = Record<string, unknown>>(schemaType: TailorField<any, T>, hook: (data: unknown) => Partial<T>): {
+  readonly "~standard": {
+    readonly version: 1;
+    readonly vendor: "@tailor-platform/sdk";
+    readonly validate: (value: unknown) => StandardSchemaV1.FailureResult | {
+      value: T;
+    };
+  };
+};
+//#endregion
+export { createStandardSchema, createTailorDBHook, unauthenticatedTailorUser };

package/dist/utils/test/index.mjs

@@ -0,0 +1,63 @@
+//#region src/utils/test/index.ts
+/** Represents an unauthenticated user in the Tailor platform. */
+const unauthenticatedTailorUser = {
+	id: "00000000-0000-0000-0000-000000000000",
+	type: "",
+	workspaceId: "00000000-0000-0000-0000-000000000000",
+	attributes: null,
+	attributeList: []
+};
+/**
+* Creates a hook function that processes TailorDB type fields
+* - Uses existing id from data if provided, otherwise generates UUID for id fields
+* - Recursively processes nested types
+* - Executes hooks.create for fields with create hooks
+*
+* @template T - The output type of the hook function
+* @param type - TailorDB type definition
+* @returns A function that transforms input data according to field hooks
+*/
+function createTailorDBHook(type) {
+	return (data) => {
+		return Object.entries(type.fields).reduce((hooked, [key, value]) => {
+			const field = value;
+			if (key === "id") hooked[key] = (data && typeof data === "object" ? data[key] : void 0) ?? crypto.randomUUID();
+			else if (field.type === "nested") hooked[key] = createTailorDBHook({ fields: field.fields })(data[key]);
+			else if (field.metadata.hooks?.create) hooked[key] = field.metadata.hooks.create({
+				value: data[key],
+				data,
+				user: unauthenticatedTailorUser
+			});
+			else if (data && typeof data === "object") hooked[key] = data[key];
+			return hooked;
+		}, {});
+	};
+}
+/**
+* Creates the standard schema definition for lines-db
+* This returns the first argument for defineSchema with the ~standard section
+*
+* @template T - The output type after validation
+* @param schemaType - TailorDB field schema for validation
+* @param hook - Hook function to transform data before validation
+* @returns Schema object with ~standard section for defineSchema
+*/
+function createStandardSchema(schemaType, hook) {
+	return { "~standard": {
+		version: 1,
+		vendor: "@tailor-platform/sdk",
+		validate: (value) => {
+			const hooked = hook(value);
+			const result = schemaType.parse({
+				value: hooked,
+				data: hooked,
+				user: unauthenticatedTailorUser
+			});
+			if (result.issues) return result;
+			return { value: hooked };
+		}
+	} };
+}
+
+//#endregion
+export { createStandardSchema, createTailorDBHook, unauthenticatedTailorUser };

package/docs/cli-reference.md

@@ -0,0 +1,484 @@
+# CLI Reference
+
+The Tailor Platform SDK provides a command-line interface for managing projects and workspaces.
+
+## Usage
+
+```bash
+tailor-sdk <command> [options]
+```
+
+## Common Options
+
+The following options are available for most commands:
+
+- `-e, --env-file` - Specify a custom environment file path
+- `-v, --verbose` - Enable detailed logging output
+
+## Environment Variables
+
+You can use environment variables to configure workspace and authentication:
+
+- `TAILOR_PLATFORM_WORKSPACE_ID` - Specify workspace ID for the `apply` command
+- `TAILOR_PLATFORM_TOKEN` - Specify authentication token (alternative to using `login`)
+- `TAILOR_PLATFORM_PROFILE` - Specify workspace profile name to use (combines user and workspace configuration)
+- `TAILOR_PLATFORM_SDK_CONFIG_PATH` - Specify path to the SDK config file (alternative to using `--config` option)
+
+## Commands
+
+### init
+
+Initialize a new project using create-sdk.
+
+```bash
+tailor-sdk init [name] [options]
+```
+
+**Arguments:**
+
+- `name` - Project name
+
+**Options:**
+
+- `-t, --template` - Template name
+
+### generate
+
+Generate files using Tailor configuration.
+
+```bash
+tailor-sdk generate [options]
+```
+
+**Options:**
+
+- `-c, --config` - Path to the SDK config file (default: `tailor.config.ts`)
+- `-w, --watch` - Watch for type/resolver changes and regenerate
+
+### apply
+
+Apply Tailor configuration to deploy your application.
+
+```bash
+tailor-sdk apply [options]
+```
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace to apply the configuration to
+- `-p, --profile` - Workspace profile to use
+- `-c, --config` - Path to the SDK config file (default: `tailor.config.ts`)
+- `-d, --dryRun` - Run the command without making any changes
+
+### show
+
+Show information about the deployed application.
+
+```bash
+tailor-sdk show [options]
+```
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace to show the application from
+- `-p, --profile` - Workspace profile to use
+- `-c, --config` - Path to the SDK config file (default: `tailor.config.ts`)
+- `-f, --format` - Output format: `table` or `json` (default: `table`)
+
+### login
+
+Login to Tailor Platform.
+
+```bash
+tailor-sdk login
+```
+
+### logout
+
+Logout from Tailor Platform.
+
+```bash
+tailor-sdk logout
+```
+
+### workspace
+
+Manage Tailor Platform workspaces.
+
+```bash
+tailor-sdk workspace <subcommand> [options]
+```
+
+#### workspace create
+
+Create a new Tailor Platform workspace.
+
+```bash
+tailor-sdk workspace create [options]
+```
+
+**Options:**
+
+- `-n, --name` - Name of the workspace (required)
+- `-r, --region` - Region of the workspace: `us-west` or `asia-northeast` (required)
+- `-d, --delete-protection` - Enable delete protection for the workspace
+- `-o, --organization-id` - Organization ID to associate the workspace with
+- `-f, --folder-id` - Folder ID to associate the workspace with
+- `-f, --format` - Output format: `table` or `json` (default: `table`)
+
+#### workspace list
+
+List all Tailor Platform workspaces.
+
+```bash
+tailor-sdk workspace list [options]
+```
+
+**Options:**
+
+- `-f, --format` - Output format: `table` or `json` (default: `table`)
+
+#### workspace delete
+
+Delete a Tailor Platform workspace.
+
+```bash
+tailor-sdk workspace delete [options]
+```
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace to delete (required)
+- `-y, --yes` - Skip confirmation prompt
+
+### profile
+
+Manage workspace profiles (user + workspace combinations).
+
+```bash
+tailor-sdk profile <subcommand> [options]
+```
+
+#### profile create
+
+Create a new profile.
+
+```bash
+tailor-sdk profile create <name> [options]
+```
+
+**Arguments:**
+
+- `name` - Profile name (required)
+
+**Options:**
+
+- `-u, --user` - User email (required)
+- `-w, --workspace-id` - Workspace ID (required)
+- `-f, --format` - Output format: `table` or `json` (default: `table`)
+
+#### profile list
+
+List all profiles.
+
+```bash
+tailor-sdk profile list [options]
+```
+
+**Options:**
+
+- `-f, --format` - Output format: `table` or `json` (default: `table`)
+
+#### profile update
+
+Update profile properties.
+
+```bash
+tailor-sdk profile update <name> [options]
+```
+
+**Arguments:**
+
+- `name` - Profile name (required)
+
+**Options:**
+
+- `-u, --user` - New user email
+- `-w, --workspace-id` - New workspace ID
+- `-f, --format` - Output format: `table` or `json` (default: `table`)
+
+#### profile delete
+
+Delete a profile.
+
+```bash
+tailor-sdk profile delete <name>
+```
+
+**Arguments:**
+
+- `name` - Profile name (required)
+
+### user
+
+Manage Tailor Platform users.
+
+```bash
+tailor-sdk user <subcommand> [options]
+```
+
+#### user current
+
+Show current user.
+
+```bash
+tailor-sdk user current [options]
+```
+
+#### user list
+
+List all users.
+
+```bash
+tailor-sdk user list [options]
+```
+
+**Options:**
+
+- `-f, --format` - Output format: `table` or `json` (default: `table`)
+
+#### user use
+
+Set current user.
+
+```bash
+tailor-sdk user use <user>
+```
+
+**Arguments:**
+
+- `user` - User email (required)
+
+#### user pat
+
+Manage personal access tokens.
+
+```bash
+tailor-sdk user pat <subcommand> [options]
+```
+
+When no subcommand is provided, defaults to `list`.
+
+##### user pat list
+
+List all personal access tokens.
+
+```bash
+tailor-sdk user pat list [options]
+```
+
+**Options:**
+
+- `-f, --format` - Output format: `text` or `json` (default: `text`)
+
+**Output (default):**
+
+```
+ token-name-1: read/write
+ token-name-2: read
+```
+
+**Output (`--format json`):**
+
+```json
+[
+  { "name": "token-name-1", "scopes": ["read", "write"] },
+  { "name": "token-name-2", "scopes": ["read"] }
+]
+```
+
+##### user pat create
+
+Create a new personal access token.
+
+```bash
+tailor-sdk user pat create <name> [options]
+```
+
+**Arguments:**
+
+- `name` - Token name (required)
+
+**Options:**
+
+- `-w, --write` - Grant write permission (default: read-only)
+- `-f, --format` - Output format: `text` or `json` (default: `text`)
+
+**Output (default):**
+
+```
+Personal access token created successfully.
+
+  name: token-name
+scopes: read/write
+ token: tpp_xxxxxxxxxxxxx
+
+Please save this token in a secure location. You won't be able to see it again.
+```
+
+**Output (`--format json`):**
+
+```json
+{ "name": "token-name", "scopes": ["read", "write"], "token": "eyJhbGc..." }
+```
+
+##### user pat delete
+
+Delete a personal access token.
+
+```bash
+tailor-sdk user pat delete <name>
+```
+
+**Arguments:**
+
+- `name` - Token name (required)
+
+##### user pat update
+
+Update a personal access token (delete and recreate).
+
+```bash
+tailor-sdk user pat update <name> [options]
+```
+
+**Arguments:**
+
+- `name` - Token name (required)
+
+**Options:**
+
+- `-w, --write` - Grant write permission (if not specified, keeps read-only)
+- `-f, --format` - Output format: `text` or `json` (default: `text`)
+
+**Output (default):**
+
+```
+Personal access token updated successfully.
+
+  name: token-name
+scopes: read/write
+ token: tpp_xxxxxxxxxxxxx
+
+Please save this token in a secure location. You won't be able to see it again.
+```
+
+**Output (`--format json`):**
+
+```json
+{
+  "name": "token-name",
+  "scopes": ["read", "write"],
+  "token": "tpp_xxxxxxxxxxxxx"
+}
+```
+
+### tailordb
+
+Manage TailorDB tables and data.
+
+```bash
+tailor-sdk tailordb <subcommand> [options]
+```
+
+#### tailordb truncate
+
+Truncate (delete all records from) TailorDB tables.
+
+```bash
+tailor-sdk tailordb truncate [types...] [options]
+```
+
+**Arguments:**
+
+- `types...` - Space-separated list of type names to truncate (optional)
+
+**Options:**
+
+- `-a, --all` - Truncate all tables in all namespaces
+- `-n, --namespace` - Truncate all tables in the specified namespace
+- `-y, --yes` - Skip confirmation prompt
+- `-w, --workspace-id` - ID of the workspace
+- `-p, --profile` - Workspace profile to use
+- `-c, --config` - Path to the SDK config file (default: `tailor.config.ts`)
+
+**Usage Examples:**
+
+```bash
+# Truncate all tables in all namespaces (requires confirmation)
+tailor-sdk tailordb truncate --all
+
+# Truncate all tables in all namespaces (skip confirmation)
+tailor-sdk tailordb truncate --all --yes
+
+# Truncate all tables in a specific namespace
+tailor-sdk tailordb truncate --namespace myNamespace
+
+# Truncate specific types (namespace is auto-detected)
+tailor-sdk tailordb truncate User Post Comment
+
+# Truncate specific types with confirmation skipped
+tailor-sdk tailordb truncate User Post --yes
+```
+
+**Notes:**
+
+- You must specify exactly one of: `--all`, `--namespace`, or type names
+- When truncating specific types, the namespace is automatically detected from your config
+- Confirmation prompts vary based on the operation:
+  - `--all`: requires typing `truncate all`
+  - `--namespace`: requires typing `truncate <namespace-name>`
+  - Specific types: requires typing `yes`
+- Use `--yes` flag to skip confirmation prompts (useful for scripts and CI/CD)
+
+### machineuser
+
+Manage machine users in your Tailor Platform application.
+
+```bash
+tailor-sdk machineuser <subcommand> [options]
+```
+
+#### machineuser list
+
+List all machine users in the application.
+
+```bash
+tailor-sdk machineuser list [options]
+```
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace
+- `-p, --profile` - Workspace profile to use
+- `-c, --config` - Path to the SDK config file (default: `tailor.config.ts`)
+- `-f, --format` - Output format: `table` or `json` (default: `table`)
+
+#### machineuser token
+
+Get an access token for a machine user.
+
+```bash
+tailor-sdk machineuser token <name> [options]
+```
+
+**Arguments:**
+
+- `name` - Machine user name (required)
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace
+- `-p, --profile` - Workspace profile to use
+- `-c, --config` - Path to the SDK config file (default: `tailor.config.ts`)
+- `-f, --format` - Output format: `table` or `json` (default: `table`)

package/docs/configuration.md

@@ -0,0 +1,132 @@
+# Configuration
+
+The SDK uses TypeScript for configuration files. By default, it uses `tailor.config.ts` in the project root. You can specify a different path using the `--config` option.
+
+### Application Settings
+
+```typescript
+export default defineConfig({
+  name: "my-app",
+  cors: ["https://example.com", website.url],
+  allowedIPAddresses: ["192.168.1.0/24"],
+  disableIntrospection: false,
+});
+```
+
+**Name**: Set the application name.
+
+**CORS**: Specify CORS settings as an array.
+
+**Allowed IP Addresses**: Specify IP addresses allowed to access the application in CIDR format.
+
+**Disable Introspection**: Disable GraphQL introspection. Default is `false`.
+
+### Service Configuration
+
+Specify glob patterns to load service files:
+
+```typescript
+export default defineConfig({
+  db: {
+    "my-db": {
+      files: ["db/**/*.ts"],
+      ignores: ["db/**/*.draft.ts"],
+    },
+  },
+  resolver: {
+    "my-resolver": {
+      files: ["resolver/**/*.ts"],
+    },
+  },
+  executor: {
+    files: ["executors/**/*.ts"],
+  },
+});
+```
+
+**files**: Glob patterns to match files. Required.
+
+**ignores**: Glob patterns to exclude files. Optional. By default, `**/*.test.ts` and `**/*.spec.ts` are automatically ignored. If you explicitly specify `ignores`, the default patterns will not be applied. Use `ignores: []` to include all files including test files.
+
+### Built-in IdP
+
+Configure the Built-in IdP service using `defineIdp()`. The returned IdP object provides type-safe provider references via `idp.provider()` that can be used in Auth service configuration.
+
+```typescript
+import { defineIdp } from "@tailor-platform/sdk";
+
+const idp = defineIdp("my-idp", {
+  authorization: "loggedIn",
+  clients: ["my-client"],
+});
+
+export default defineConfig({
+  idp: [idp],
+});
+```
+
+**authorization**: User management permissions (`"insecure"`, `"loggedIn"`, or CEL expression).
+
+**clients**: OAuth client names for the IdP.
+
+### Auth Service
+
+Configure Auth service using `defineAuth()`:
+
+```typescript
+import { defineAuth } from "@tailor-platform/sdk";
+import { user } from "./tailordb/user";
+
+const auth = defineAuth("my-auth", {
+  userProfile: {
+    type: user,
+    usernameField: "email",
+    attributes: { role: true },
+  },
+  machineUsers: {
+    "admin-machine-user": {
+      attributes: { role: "ADMIN" },
+    },
+  },
+  oauth2Clients: {
+    "my-oauth2-client": {
+      redirectURIs: ["https://example.com/callback"],
+      grantTypes: ["authorization_code", "refresh_token"],
+    },
+  },
+  idProvider: idp.provider("my-provider", "my-client"),
+});
+
+export default defineConfig({
+  auth,
+});
+```
+
+**userProfile**: Maps identities to TailorDB type with username field and attributes.
+
+**machineUsers**: Service accounts with predefined attributes.
+
+**oauth2Clients**: OAuth 2.0 clients with redirect URIs and grant types.
+
+**idProvider**: External identity provider (OIDC, SAML, IDToken, or BuiltInIdP).
+
+### Static Websites
+
+Configure static website hosting using `defineStaticWebSite()`. The returned website object provides a type-safe `url` property that can be used in CORS settings and OAuth2 redirect URIs.
+
+```typescript
+import { defineStaticWebSite } from "@tailor-platform/sdk";
+
+const website = defineStaticWebSite("my-website", {
+  description: "My Static Website",
+  allowedIPAddresses: ["192.168.0.0/24"],
+});
+
+export default defineConfig({
+  staticWebsites: [website],
+});
+```
+
+**description**: Description of the site.
+
+**allowedIPAddresses**: List of IP addresses allowed to access the site in CIDR format.