@tailor-platform/sdk 1.7.0 → 1.8.0

package/docs/cli/workspace.md

@@ -2,123 +2,204 @@
 
 Commands for managing workspaces and profiles.
 
+<!-- politty:command:workspace:start -->
+
 ## workspace
 
 Manage Tailor Platform workspaces.
 
-```bash
-tailor-sdk workspace <subcommand> [options]
+**Usage**
+
 ```
+tailor-sdk workspace [command]
+```
+
+**Commands**
+
+| Command                                 | Description                             |
+| --------------------------------------- | --------------------------------------- |
+| [`workspace create`](#workspace-create) | Create a new Tailor Platform workspace. |
+| [`workspace delete`](#workspace-delete) | Delete a Tailor Platform workspace.     |
+| [`workspace list`](#workspace-list)     | List all Tailor Platform workspaces.    |
+
+<!-- politty:command:workspace:end -->
+<!-- politty:command:workspace create:start -->
 
 ### workspace create
 
 Create a new Tailor Platform workspace.
 
-```bash
+**Usage**
+
+```
 tailor-sdk workspace create [options]
 ```
 
-**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
-- `-p, --profile-name` - Profile name to create (optional)
-- `--profile-user` - User email for the profile (defaults to current user)
-- `-j, --json` - Output as JSON
+| Option                                | Alias | Description                                           | Default |
+| ------------------------------------- | ----- | ----------------------------------------------------- | ------- |
+| `--json`                              | `-j`  | Output as JSON                                        | `false` |
+| `--name <NAME>`                       | `-n`  | Workspace name                                        | -       |
+| `--region <REGION>`                   | `-r`  | Workspace region (us-west, asia-northeast)            | -       |
+| `--delete-protection`                 | `-d`  | Enable delete protection                              | `false` |
+| `--organization-id <ORGANIZATION_ID>` | `-o`  | Organization ID to workspace associate with           | -       |
+| `--folder-id <FOLDER_ID>`             | `-f`  | Folder ID to workspace associate with                 | -       |
+| `--profile-name <PROFILE_NAME>`       | `-p`  | Profile name to create                                | -       |
+| `--profile-user <PROFILE_USER>`       | -     | User email for the profile (defaults to current user) | -       |
+
+<!-- politty:command:workspace create:end -->
+<!-- politty:command:workspace list:start -->
 
 ### workspace list
 
 List all Tailor Platform workspaces.
 
-```bash
+**Usage**
+
+```
 tailor-sdk workspace list [options]
 ```
 
-**Options:**
+**Options**
+
+| Option            | Alias | Description                          | Default |
+| ----------------- | ----- | ------------------------------------ | ------- |
+| `--json`          | `-j`  | Output as JSON                       | `false` |
+| `--limit <LIMIT>` | `-l`  | Maximum number of workspaces to list | -       |
 
-- `-j, --json` - Output as JSON
-- `-l, --limit <number>` - Maximum number of workspaces to list (positive integer)
+<!-- politty:command:workspace list:end -->
+<!-- politty:command:workspace delete:start -->
 
 ### workspace delete
 
 Delete a Tailor Platform workspace.
 
-```bash
+**Usage**
+
+```
 tailor-sdk workspace delete [options]
 ```
 
-**Options:**
+**Options**
 
-- `-w, --workspace-id` - ID of the workspace to delete (required)
-- `-y, --yes` - Skip confirmation prompt
+| Option                          | Alias | Description               | Default |
+| ------------------------------- | ----- | ------------------------- | ------- |
+| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID              | -       |
+| `--yes`                         | `-y`  | Skip confirmation prompts | `false` |
+
+<!-- politty:command:workspace delete:end -->
+<!-- politty:command:profile:start -->
 
 ## profile
 
 Manage workspace profiles (user + workspace combinations).
 
-```bash
-tailor-sdk profile <subcommand> [options]
+**Usage**
+
 ```
+tailor-sdk profile [command]
+```
+
+**Commands**
+
+| Command                             | Description                |
+| ----------------------------------- | -------------------------- |
+| [`profile create`](#profile-create) | Create a new profile.      |
+| [`profile delete`](#profile-delete) | Delete a profile.          |
+| [`profile list`](#profile-list)     | List all profiles.         |
+| [`profile update`](#profile-update) | Update profile properties. |
+
+<!-- politty:command:profile:end -->
+<!-- politty:command:profile create:start -->
 
 ### profile create
 
 Create a new profile.
 
-```bash
-tailor-sdk profile create <name> [options]
+**Usage**
+
+```
+tailor-sdk profile create [options] <name>
 ```
 
-**Arguments:**
+**Arguments**
 
-- `name` - Profile name (required)
+| Argument | Description  | Required |
+| -------- | ------------ | -------- |
+| `name`   | Profile name | Yes      |
 
-**Options:**
+**Options**
 
-- `-u, --user` - User email (required)
-- `-w, --workspace-id` - Workspace ID (required)
-- `-j, --json` - Output as JSON
+| Option                          | Alias | Description    | Default |
+| ------------------------------- | ----- | -------------- | ------- |
+| `--json`                        | `-j`  | Output as JSON | `false` |
+| `--user <USER>`                 | `-u`  | User email     | -       |
+| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID   | -       |
+
+<!-- politty:command:profile create:end -->
+<!-- politty:command:profile list:start -->
 
 ### profile list
 
 List all profiles.
 
-```bash
+**Usage**
+
+```
 tailor-sdk profile list [options]
 ```
 
-**Options:**
+**Options**
+
+| Option   | Alias | Description    | Default |
+| -------- | ----- | -------------- | ------- |
+| `--json` | `-j`  | Output as JSON | `false` |
 
-- `-j, --json` - Output as JSON
+<!-- politty:command:profile list:end -->
+<!-- politty:command:profile update:start -->
 
 ### profile update
 
 Update profile properties.
 
-```bash
-tailor-sdk profile update <name> [options]
+**Usage**
+
+```
+tailor-sdk profile update [options] <name>
 ```
 
-**Arguments:**
+**Arguments**
 
-- `name` - Profile name (required)
+| Argument | Description  | Required |
+| -------- | ------------ | -------- |
+| `name`   | Profile name | Yes      |
 
-**Options:**
+**Options**
 
-- `-u, --user` - New user email
-- `-w, --workspace-id` - New workspace ID
-- `-j, --json` - Output as JSON
+| Option                          | Alias | Description      | Default |
+| ------------------------------- | ----- | ---------------- | ------- |
+| `--json`                        | `-j`  | Output as JSON   | `false` |
+| `--user <USER>`                 | `-u`  | New user email   | -       |
+| `--workspace-id <WORKSPACE_ID>` | `-w`  | New workspace ID | -       |
+
+<!-- politty:command:profile update:end -->
+<!-- politty:command:profile delete:start -->
 
 ### profile delete
 
 Delete a profile.
 
-```bash
-tailor-sdk profile delete <name>
+**Usage**
+
 ```
+tailor-sdk profile delete [options] <name>
+```
+
+**Arguments**
 
-**Arguments:**
+| Argument | Description  | Required |
+| -------- | ------------ | -------- |
+| `name`   | Profile name | Yes      |
 
-- `name` - Profile name (required)
+<!-- politty:command:profile delete:end -->

package/docs/generator/custom.md

@@ -13,7 +13,7 @@ interface CodeGenerator<T, R, E, Ts, Rs> {
 
   // Process individual items
   processType(args: {
-    type: ParsedTailorDBType;
+    type: TailorDBType;
     namespace: string;
     source: { filePath: string; exportName: string };
   }): T | Promise<T>;
@@ -110,7 +110,7 @@ export const generators = defineGenerators(
 
 ## Available Input Data
 
-### ParsedTailorDBType
+### TailorDBType
 
 Contains full type information including:
 

package/docs/services/auth.md

@@ -86,7 +86,53 @@ export const user = db.type("User", {
 
 **usernameField**: The field in the TailorDB type used as the username. This field must have a unique constraint (`.unique()`) since it is used to uniquely identify users.
 
-**attributes**: Specifies which fields from the TailorDB type are used as user attributes. Set to `true` to enable a field. Enabled attributes must be assigned values in all machine user definitions.
+**attributes**: Specifies which fields from the TailorDB type are used as user attributes. Set to `true` to enable a field. Enabled attributes must be assigned values in all machine user definitions. Only fields with ValueOperand types (string, boolean, string[], boolean[]) can be used as attributes. The `id` field and datetime/date/time types are excluded.
+
+## Attribute List
+
+In addition to `attributes` (key-value map), you can configure `attributeList` to expose UUID-type fields as an ordered list. This is useful for referencing related records by their IDs.
+
+```typescript
+userProfile: {
+  type: user,
+  usernameField: "email",
+  attributes: { role: true },
+  attributeList: ["organizationId", "teamId"],
+},
+```
+
+**attributeList**: An array of field names from the TailorDB type. These fields will be exposed as an ordered list of UUIDs. Only UUID-type fields (non-array) can be included in the attribute list.
+
+Example TailorDB type with UUID fields for attribute list:
+
+```typescript
+// tailordb/user.ts
+import { db } from "@tailor-platform/sdk";
+
+export const user = db.type("User", {
+  email: db.string().unique(),
+  role: db.enum(["admin", "user"]),
+  organizationId: db.uuid(), // Can be used in attributeList
+  teamId: db.uuid(), // Can be used in attributeList
+  ...db.fields.timestamps(),
+});
+```
+
+The `attributeList` values are accessible via `user.attributeList` as a tuple:
+
+```typescript
+// In a resolver
+body: (context) => {
+  const [organizationId, teamId] = context.user.attributeList;
+},
+
+// In TailorDB hooks
+.hooks({
+  field: {
+    create: ({ user }) => user.attributeList[0], // First UUID from list
+  },
+})
+```
 
 ## Machine User Attributes (without userProfile)
 
@@ -140,6 +186,36 @@ machineUsers: {
 body: (context) => {
   const role = context.user.attributes?.role;
 },
+```
+
+**attributeList**: Values for fields enabled in `userProfile.attributeList`. Must be an array of valid UUIDs in the same order as declared in userProfile:
+
+```typescript
+// userProfile with attributeList
+userProfile: {
+  type: user,
+  usernameField: "email",
+  attributes: { role: true },
+  attributeList: ["organizationId", "teamId"],
+},
+machineUsers: {
+  "admin-machine-user": {
+    attributes: { role: "ADMIN" },
+    attributeList: [
+      "550e8400-e29b-41d4-a716-446655440000",
+      "7c9e6679-7425-40de-944b-e07fc1f90ae7",
+    ],
+  },
+},
+```
+
+These values are accessible via `user.attributeList`:
+
+```typescript
+// In a resolver
+body: (context) => {
+  const [organizationId, teamId] = context.user.attributeList;
+},
 
 // In TailorDB hooks
 .hooks({
@@ -284,3 +360,14 @@ tailor-sdk oauth2client get <name>
 ```
 
 See [Auth Resource Commands](../cli/auth.md) for full documentation.
+
+## SDK vs Platform Naming
+
+> **Note for Platform developers**: The SDK uses different names than the underlying Platform API for user attributes:
+>
+> | SDK             | Platform API    | Description                      |
+> | --------------- | --------------- | -------------------------------- |
+> | `attributes`    | `attribute_map` | Key-value map of user attributes |
+> | `attributeList` | `attributes`    | Ordered list of UUID values      |
+>
+> This mapping is handled automatically by the SDK. If you're reading Platform documentation or API responses, be aware of this naming difference.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/sdk",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Tailor Platform SDK - The SDK to work with Tailor Platform",
   "license": "MIT",
   "repository": {
@@ -121,6 +121,8 @@
     "test:unit": "vitest --project=unit",
     "test:e2e": "vitest --project=e2e",
     "test:coverage": "vitest --coverage",
+    "docs:check": "vitest run --project=unit src/cli/docs.test.ts",
+    "docs:update": "POLITTY_DOCS_UPDATE=true vitest run --project=unit src/cli/docs.test.ts",
     "build": "tsdown && cross-env FORCE_CREATE=1 node postinstall.mjs",
     "lint": "oxlint --type-aware . && eslint --cache .",
     "lint:fix": "oxlint --type-aware . --fix && eslint --cache . --fix",