@tailor-platform/sdk 1.17.0 → 1.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/dist/application-Csj7Ow5Q.mjs +8 -0
  3. package/dist/{application-DYfVZVPT.mjs → application-gWUyKuzv.mjs} +211 -1653
  4. package/dist/{application-DYfVZVPT.mjs.map → application-gWUyKuzv.mjs.map} +1 -1
  5. package/dist/brand-BZJCv6UY.mjs +28 -0
  6. package/dist/brand-BZJCv6UY.mjs.map +1 -0
  7. package/dist/cli/index.mjs +38 -20
  8. package/dist/cli/index.mjs.map +1 -1
  9. package/dist/cli/lib.d.mts +20 -33
  10. package/dist/cli/lib.mjs +10 -5
  11. package/dist/cli/lib.mjs.map +1 -1
  12. package/dist/configure/index.d.mts +4 -4
  13. package/dist/configure/index.mjs +10 -19
  14. package/dist/configure/index.mjs.map +1 -1
  15. package/dist/enum-constants-Cwd4qdpa.mjs +115 -0
  16. package/dist/enum-constants-Cwd4qdpa.mjs.map +1 -0
  17. package/dist/file-utils-cqcpFk87.mjs +139 -0
  18. package/dist/file-utils-cqcpFk87.mjs.map +1 -0
  19. package/dist/index-BKXch-td.d.mts +18 -0
  20. package/dist/index-C3Ib7pFc.d.mts +18 -0
  21. package/dist/{index-qQXpN674.d.mts → index-DP8EB9FK.d.mts} +13 -5
  22. package/dist/index-SqWgrTnF.d.mts +20 -0
  23. package/dist/index-sSDpuVQY.d.mts +18 -0
  24. package/dist/{jiti-BrELlEYT.mjs → jiti-DHlauMCo.mjs} +2 -2
  25. package/dist/{jiti-BrELlEYT.mjs.map → jiti-DHlauMCo.mjs.map} +1 -1
  26. package/dist/{job-CULA2Pvf.mjs → job-2Q82qQ6N.mjs} +27 -5
  27. package/dist/job-2Q82qQ6N.mjs.map +1 -0
  28. package/dist/kysely-type-DtUUoAi3.mjs +259 -0
  29. package/dist/kysely-type-DtUUoAi3.mjs.map +1 -0
  30. package/dist/plugin/builtin/enum-constants/index.d.mts +4 -0
  31. package/dist/plugin/builtin/enum-constants/index.mjs +3 -0
  32. package/dist/plugin/builtin/file-utils/index.d.mts +4 -0
  33. package/dist/plugin/builtin/file-utils/index.mjs +3 -0
  34. package/dist/plugin/builtin/kysely-type/index.d.mts +4 -0
  35. package/dist/plugin/builtin/kysely-type/index.mjs +3 -0
  36. package/dist/plugin/builtin/seed/index.d.mts +4 -0
  37. package/dist/plugin/builtin/seed/index.mjs +3 -0
  38. package/dist/plugin/index.d.mts +3 -3
  39. package/dist/plugin/index.mjs +11 -11
  40. package/dist/plugin/index.mjs.map +1 -1
  41. package/dist/{schema-R5TxC5Pn.mjs → schema-WDvc7Zel.mjs} +4 -3
  42. package/dist/schema-WDvc7Zel.mjs.map +1 -0
  43. package/dist/seed-Dm7lrGZ3.mjs +1050 -0
  44. package/dist/seed-Dm7lrGZ3.mjs.map +1 -0
  45. package/dist/{src-DMROgdcL.mjs → src-i4uqS1G4.mjs} +2 -2
  46. package/dist/{src-DMROgdcL.mjs.map → src-i4uqS1G4.mjs.map} +1 -1
  47. package/dist/types-Bhl_wAM2.d.mts +151 -0
  48. package/dist/{types-b-ig8nW_.mjs → types-ClK_HJ0G.mjs} +1 -1
  49. package/dist/{types-b-ig8nW_.mjs.map → types-ClK_HJ0G.mjs.map} +1 -1
  50. package/dist/{types-DzvazVmg.d.mts → types-DdvTxFiD.d.mts} +1380 -1044
  51. package/dist/{update-DQKCUNmr.mjs → update-BoNKMti-.mjs} +285 -112
  52. package/dist/update-BoNKMti-.mjs.map +1 -0
  53. package/dist/utils/test/index.d.mts +4 -4
  54. package/dist/utils/test/index.mjs +3 -2
  55. package/dist/utils/test/index.mjs.map +1 -1
  56. package/docs/cli/application.md +106 -14
  57. package/docs/cli/auth.md +92 -12
  58. package/docs/cli/completion.md +18 -2
  59. package/docs/cli/executor.md +122 -14
  60. package/docs/cli/function.md +32 -4
  61. package/docs/cli/secret.md +134 -18
  62. package/docs/cli/staticwebsite.md +60 -8
  63. package/docs/cli/tailordb.md +148 -20
  64. package/docs/cli/user.md +154 -22
  65. package/docs/cli/workflow.md +100 -12
  66. package/docs/cli/workspace.md +274 -38
  67. package/docs/generator/custom.md +2 -2
  68. package/docs/plugin/custom.md +270 -163
  69. package/docs/plugin/index.md +48 -2
  70. package/package.json +22 -2
  71. package/dist/application-D5ZEr4zk.mjs +0 -4
  72. package/dist/job-CULA2Pvf.mjs.map +0 -1
  73. package/dist/schema-R5TxC5Pn.mjs.map +0 -1
  74. package/dist/types-BeNtD-fA.d.mts +0 -369
  75. package/dist/update-DQKCUNmr.mjs.map +0 -1
  76. /package/dist/{chunk-GMkBE123.mjs → chunk-CqAI0b6X.mjs} +0 -0
@@ -1,7 +1,7 @@
1
1
  /// <reference path="./../../user-defined.d.ts" />
2
- import { M as TailorDBType, st as TailorField } from "../../types-DzvazVmg.mjs";
3
- import "../../types-BeNtD-fA.mjs";
4
- import { G as WORKFLOW_TEST_ENV_KEY, n as output } from "../../index-qQXpN674.mjs";
2
+ import { Ot as TailorField, s as TailorDBType } from "../../types-DdvTxFiD.mjs";
3
+ import "../../types-Bhl_wAM2.mjs";
4
+ import { G as WORKFLOW_TEST_ENV_KEY, K as WORKFLOW_TEST_USER_KEY, n as output } from "../../index-DP8EB9FK.mjs";
5
5
  import { StandardSchemaV1 } from "@standard-schema/spec";
6
6
 
7
7
  //#region src/utils/test/index.d.ts
@@ -41,5 +41,5 @@ declare function createStandardSchema<T = Record<string, unknown>>(schemaType: T
41
41
  };
42
42
  };
43
43
  //#endregion
44
- export { WORKFLOW_TEST_ENV_KEY, createStandardSchema, createTailorDBHook, unauthenticatedTailorUser };
44
+ export { WORKFLOW_TEST_ENV_KEY, WORKFLOW_TEST_USER_KEY, createStandardSchema, createTailorDBHook, unauthenticatedTailorUser };
45
45
  //# sourceMappingURL=index.d.mts.map
@@ -1,4 +1,5 @@
1
- import { t as WORKFLOW_TEST_ENV_KEY } from "../../job-CULA2Pvf.mjs";
1
+ import { n as WORKFLOW_TEST_USER_KEY, t as WORKFLOW_TEST_ENV_KEY } from "../../job-2Q82qQ6N.mjs";
2
+ import "../../brand-BZJCv6UY.mjs";
2
3
 
3
4
  //#region src/utils/test/index.ts
4
5
  /** Represents an unauthenticated user in the Tailor platform. */
@@ -62,5 +63,5 @@ function createStandardSchema(schemaType, hook) {
62
63
  }
63
64
 
64
65
  //#endregion
65
- export { WORKFLOW_TEST_ENV_KEY, createStandardSchema, createTailorDBHook, unauthenticatedTailorUser };
66
+ export { WORKFLOW_TEST_ENV_KEY, WORKFLOW_TEST_USER_KEY, createStandardSchema, createTailorDBHook, unauthenticatedTailorUser };
66
67
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","names":[],"sources":["../../../src/utils/test/index.ts"],"sourcesContent":["import type { output, TailorUser } from \"@/configure\";\nimport type { TailorDBType } from \"@/configure/services/tailordb/schema\";\nimport type { TailorField } from \"@/configure/types/type\";\nimport type { StandardSchemaV1 } from \"@standard-schema/spec\";\n\nexport { WORKFLOW_TEST_ENV_KEY } from \"@/configure/services/workflow/job\";\n\n/** Represents an unauthenticated user in the Tailor platform. */\nexport const unauthenticatedTailorUser = {\n id: \"00000000-0000-0000-0000-000000000000\",\n type: \"\",\n workspaceId: \"00000000-0000-0000-0000-000000000000\",\n attributes: null,\n attributeList: [],\n} as const satisfies TailorUser;\n\n/**\n * Creates a hook function that processes TailorDB type fields\n * - Uses existing id from data if provided, otherwise generates UUID for id fields\n * - Recursively processes nested types\n * - Executes hooks.create for fields with create hooks\n * @template T - The output type of the hook function\n * @param type - TailorDB type definition\n * @returns A function that transforms input data according to field hooks\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport function createTailorDBHook<T extends TailorDBType<any, any>>(type: T) {\n return (data: unknown) => {\n return Object.entries(type.fields).reduce(\n (hooked, [key, value]) => {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const field = value as TailorField<any, any, any>;\n if (key === \"id\") {\n // Use existing id from data if provided, otherwise generate new UUID\n const existingId =\n data && typeof data === \"object\" ? (data as Record<string, unknown>)[key] : undefined;\n hooked[key] = existingId ?? crypto.randomUUID();\n } else if (field.type === \"nested\") {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n hooked[key] = createTailorDBHook({ fields: field.fields } as any)(\n (data as Record<string, unknown>)[key],\n );\n } else if (field.metadata.hooks?.create) {\n hooked[key] = field.metadata.hooks.create({\n value: (data as Record<string, unknown>)[key],\n data: data,\n user: unauthenticatedTailorUser,\n });\n if (hooked[key] instanceof Date) {\n hooked[key] = hooked[key].toISOString();\n }\n } else if (data && typeof data === \"object\") {\n hooked[key] = (data as Record<string, unknown>)[key];\n }\n return hooked;\n },\n {} as Record<string, unknown>,\n ) as Partial<output<T>>;\n };\n}\n\n/**\n * Creates the standard schema definition for lines-db\n * This returns the first argument for defineSchema with the ~standard section\n * @template T - The output type after validation\n * @param schemaType - TailorDB field schema for validation\n * @param hook - Hook function to transform data before validation\n * @returns Schema object with ~standard section for defineSchema\n */\nexport function createStandardSchema<T = Record<string, unknown>>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n schemaType: TailorField<any, T>,\n hook: (data: unknown) => Partial<T>,\n) {\n return {\n \"~standard\": {\n version: 1,\n vendor: \"@tailor-platform/sdk\",\n validate: (value: unknown) => {\n const hooked = hook(value);\n const result = schemaType.parse({\n value: hooked,\n data: hooked,\n user: unauthenticatedTailorUser,\n });\n if (result.issues) {\n return result;\n }\n return { value: hooked as T };\n },\n },\n } as const satisfies StandardSchemaV1<T>;\n}\n"],"mappings":";;;;AAQA,MAAa,4BAA4B;CACvC,IAAI;CACJ,MAAM;CACN,aAAa;CACb,YAAY;CACZ,eAAe,EAAE;CAClB;;;;;;;;;;AAYD,SAAgB,mBAAqD,MAAS;AAC5E,SAAQ,SAAkB;AACxB,SAAO,OAAO,QAAQ,KAAK,OAAO,CAAC,QAChC,QAAQ,CAAC,KAAK,WAAW;GAExB,MAAM,QAAQ;AACd,OAAI,QAAQ,KAIV,QAAO,QADL,QAAQ,OAAO,SAAS,WAAY,KAAiC,OAAO,WAClD,OAAO,YAAY;YACtC,MAAM,SAAS,SAExB,QAAO,OAAO,mBAAmB,EAAE,QAAQ,MAAM,QAAQ,CAAQ,CAC9D,KAAiC,KACnC;YACQ,MAAM,SAAS,OAAO,QAAQ;AACvC,WAAO,OAAO,MAAM,SAAS,MAAM,OAAO;KACxC,OAAQ,KAAiC;KACnC;KACN,MAAM;KACP,CAAC;AACF,QAAI,OAAO,gBAAgB,KACzB,QAAO,OAAO,OAAO,KAAK,aAAa;cAEhC,QAAQ,OAAO,SAAS,SACjC,QAAO,OAAQ,KAAiC;AAElD,UAAO;KAET,EAAE,CACH;;;;;;;;;;;AAYL,SAAgB,qBAEd,YACA,MACA;AACA,QAAO,EACL,aAAa;EACX,SAAS;EACT,QAAQ;EACR,WAAW,UAAmB;GAC5B,MAAM,SAAS,KAAK,MAAM;GAC1B,MAAM,SAAS,WAAW,MAAM;IAC9B,OAAO;IACP,MAAM;IACN,MAAM;IACP,CAAC;AACF,OAAI,OAAO,OACT,QAAO;AAET,UAAO,EAAE,OAAO,QAAa;;EAEhC,EACF"}
1
+ {"version":3,"file":"index.mjs","names":[],"sources":["../../../src/utils/test/index.ts"],"sourcesContent":["import type { output, TailorUser } from \"@/configure\";\nimport type { TailorDBType } from \"@/configure/services/tailordb/schema\";\nimport type { TailorField } from \"@/configure/types/type\";\nimport type { StandardSchemaV1 } from \"@standard-schema/spec\";\n\nexport { WORKFLOW_TEST_ENV_KEY, WORKFLOW_TEST_USER_KEY } from \"@/configure/services/workflow/job\";\n\n/** Represents an unauthenticated user in the Tailor platform. */\nexport const unauthenticatedTailorUser = {\n id: \"00000000-0000-0000-0000-000000000000\",\n type: \"\",\n workspaceId: \"00000000-0000-0000-0000-000000000000\",\n attributes: null,\n attributeList: [],\n} as const satisfies TailorUser;\n\n/**\n * Creates a hook function that processes TailorDB type fields\n * - Uses existing id from data if provided, otherwise generates UUID for id fields\n * - Recursively processes nested types\n * - Executes hooks.create for fields with create hooks\n * @template T - The output type of the hook function\n * @param type - TailorDB type definition\n * @returns A function that transforms input data according to field hooks\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport function createTailorDBHook<T extends TailorDBType<any, any>>(type: T) {\n return (data: unknown) => {\n return Object.entries(type.fields).reduce(\n (hooked, [key, value]) => {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const field = value as TailorField<any, any, any>;\n if (key === \"id\") {\n // Use existing id from data if provided, otherwise generate new UUID\n const existingId =\n data && typeof data === \"object\" ? (data as Record<string, unknown>)[key] : undefined;\n hooked[key] = existingId ?? crypto.randomUUID();\n } else if (field.type === \"nested\") {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n hooked[key] = createTailorDBHook({ fields: field.fields } as any)(\n (data as Record<string, unknown>)[key],\n );\n } else if (field.metadata.hooks?.create) {\n hooked[key] = field.metadata.hooks.create({\n value: (data as Record<string, unknown>)[key],\n data: data,\n user: unauthenticatedTailorUser,\n });\n if (hooked[key] instanceof Date) {\n hooked[key] = hooked[key].toISOString();\n }\n } else if (data && typeof data === \"object\") {\n hooked[key] = (data as Record<string, unknown>)[key];\n }\n return hooked;\n },\n {} as Record<string, unknown>,\n ) as Partial<output<T>>;\n };\n}\n\n/**\n * Creates the standard schema definition for lines-db\n * This returns the first argument for defineSchema with the ~standard section\n * @template T - The output type after validation\n * @param schemaType - TailorDB field schema for validation\n * @param hook - Hook function to transform data before validation\n * @returns Schema object with ~standard section for defineSchema\n */\nexport function createStandardSchema<T = Record<string, unknown>>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n schemaType: TailorField<any, T>,\n hook: (data: unknown) => Partial<T>,\n) {\n return {\n \"~standard\": {\n version: 1,\n vendor: \"@tailor-platform/sdk\",\n validate: (value: unknown) => {\n const hooked = hook(value);\n const result = schemaType.parse({\n value: hooked,\n data: hooked,\n user: unauthenticatedTailorUser,\n });\n if (result.issues) {\n return result;\n }\n return { value: hooked as T };\n },\n },\n } as const satisfies StandardSchemaV1<T>;\n}\n"],"mappings":";;;;;AAQA,MAAa,4BAA4B;CACvC,IAAI;CACJ,MAAM;CACN,aAAa;CACb,YAAY;CACZ,eAAe,EAAE;CAClB;;;;;;;;;;AAYD,SAAgB,mBAAqD,MAAS;AAC5E,SAAQ,SAAkB;AACxB,SAAO,OAAO,QAAQ,KAAK,OAAO,CAAC,QAChC,QAAQ,CAAC,KAAK,WAAW;GAExB,MAAM,QAAQ;AACd,OAAI,QAAQ,KAIV,QAAO,QADL,QAAQ,OAAO,SAAS,WAAY,KAAiC,OAAO,WAClD,OAAO,YAAY;YACtC,MAAM,SAAS,SAExB,QAAO,OAAO,mBAAmB,EAAE,QAAQ,MAAM,QAAQ,CAAQ,CAC9D,KAAiC,KACnC;YACQ,MAAM,SAAS,OAAO,QAAQ;AACvC,WAAO,OAAO,MAAM,SAAS,MAAM,OAAO;KACxC,OAAQ,KAAiC;KACnC;KACN,MAAM;KACP,CAAC;AACF,QAAI,OAAO,gBAAgB,KACzB,QAAO,OAAO,OAAO,KAAK,aAAa;cAEhC,QAAQ,OAAO,SAAS,SACjC,QAAO,OAAQ,KAAiC;AAElD,UAAO;KAET,EAAE,CACH;;;;;;;;;;;AAYL,SAAgB,qBAEd,YACA,MACA;AACA,QAAO,EACL,aAAa;EACX,SAAS;EACT,QAAQ;EACR,WAAW,UAAmB;GAC5B,MAAM,SAAS,KAAK,MAAM;GAC1B,MAAM,SAAS,WAAW,MAAM;IAC9B,OAAO;IACP,MAAM;IACN,MAAM;IACP,CAAC;AACF,OAAI,OAAO,OACT,QAAO;AAET,UAAO,EAAE,OAAO,QAAa;;EAEhC,EACF"}
@@ -2,44 +2,72 @@
2
2
 
3
3
  Commands for managing Tailor Platform applications. These commands work with `tailor.config.ts`.
4
4
 
5
- <!-- politty:command:init:start -->
5
+ <!-- politty:command:init:heading:start -->
6
6
 
7
7
  ## init
8
8
 
9
+ <!-- politty:command:init:heading:end -->
10
+
11
+ <!-- politty:command:init:description:start -->
12
+
9
13
  Initialize a new project using create-sdk.
10
14
 
15
+ <!-- politty:command:init:description:end -->
16
+
17
+ <!-- politty:command:init:usage:start -->
18
+
11
19
  **Usage**
12
20
 
13
21
  ```
14
22
  tailor-sdk init [options] [name]
15
23
  ```
16
24
 
25
+ <!-- politty:command:init:usage:end -->
26
+
27
+ <!-- politty:command:init:arguments:start -->
28
+
17
29
  **Arguments**
18
30
 
19
31
  | Argument | Description | Required |
20
32
  | -------- | ------------ | -------- |
21
33
  | `name` | Project name | No |
22
34
 
35
+ <!-- politty:command:init:arguments:end -->
36
+
37
+ <!-- politty:command:init:options:start -->
38
+
23
39
  **Options**
24
40
 
25
41
  | Option | Alias | Description | Required | Default |
26
42
  | ----------------------- | ----- | ------------- | -------- | ------- |
27
43
  | `--template <TEMPLATE>` | `-t` | Template name | No | - |
28
44
 
29
- <!-- politty:command:init:end -->
45
+ <!-- politty:command:init:options:end -->
30
46
 
31
- <!-- politty:command:generate:start -->
47
+ <!-- politty:command:generate:heading:start -->
32
48
 
33
49
  ## generate
34
50
 
51
+ <!-- politty:command:generate:heading:end -->
52
+
53
+ <!-- politty:command:generate:description:start -->
54
+
35
55
  Generate files using Tailor configuration.
36
56
 
57
+ <!-- politty:command:generate:description:end -->
58
+
59
+ <!-- politty:command:generate:usage:start -->
60
+
37
61
  **Usage**
38
62
 
39
63
  ```
40
64
  tailor-sdk generate [options]
41
65
  ```
42
66
 
67
+ <!-- politty:command:generate:usage:end -->
68
+
69
+ <!-- politty:command:generate:options:start -->
70
+
43
71
  **Options**
44
72
 
45
73
  | Option | Alias | Description | Required | Default |
@@ -47,20 +75,32 @@ tailor-sdk generate [options]
47
75
  | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` |
48
76
  | `--watch` | `-W` | Watch for type/resolver changes and regenerate | No | `false` |
49
77
 
50
- <!-- politty:command:generate:end -->
78
+ <!-- politty:command:generate:options:end -->
51
79
 
52
- <!-- politty:command:apply:start -->
80
+ <!-- politty:command:apply:heading:start -->
53
81
 
54
82
  ## apply
55
83
 
84
+ <!-- politty:command:apply:heading:end -->
85
+
86
+ <!-- politty:command:apply:description:start -->
87
+
56
88
  Apply Tailor configuration to deploy your application.
57
89
 
90
+ <!-- politty:command:apply:description:end -->
91
+
92
+ <!-- politty:command:apply:usage:start -->
93
+
58
94
  **Usage**
59
95
 
60
96
  ```
61
97
  tailor-sdk apply [options]
62
98
  ```
63
99
 
100
+ <!-- politty:command:apply:usage:end -->
101
+
102
+ <!-- politty:command:apply:options:start -->
103
+
64
104
  **Options**
65
105
 
66
106
  | Option | Alias | Description | Required | Default |
@@ -72,7 +112,7 @@ tailor-sdk apply [options]
72
112
  | `--dry-run` | `-d` | Run the command without making any changes | No | - |
73
113
  | `--no-schema-check` | - | Skip schema diff check against migration snapshots | No | - |
74
114
 
75
- <!-- politty:command:apply:end -->
115
+ <!-- politty:command:apply:options:end -->
76
116
 
77
117
  **Migration Handling:**
78
118
 
@@ -96,18 +136,30 @@ If remote schema drift is detected, the apply will fail with an error showing th
96
136
 
97
137
  Use `--no-schema-check` to skip both verifications (not recommended for production).
98
138
 
99
- <!-- politty:command:remove:start -->
139
+ <!-- politty:command:remove:heading:start -->
100
140
 
101
141
  ## remove
102
142
 
143
+ <!-- politty:command:remove:heading:end -->
144
+
145
+ <!-- politty:command:remove:description:start -->
146
+
103
147
  Remove all resources managed by the application from the workspace.
104
148
 
149
+ <!-- politty:command:remove:description:end -->
150
+
151
+ <!-- politty:command:remove:usage:start -->
152
+
105
153
  **Usage**
106
154
 
107
155
  ```
108
156
  tailor-sdk remove [options]
109
157
  ```
110
158
 
159
+ <!-- politty:command:remove:usage:end -->
160
+
161
+ <!-- politty:command:remove:options:start -->
162
+
111
163
  **Options**
112
164
 
113
165
  | Option | Alias | Description | Required | Default |
@@ -117,20 +169,32 @@ tailor-sdk remove [options]
117
169
  | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` |
118
170
  | `--yes` | `-y` | Skip confirmation prompts | No | `false` |
119
171
 
120
- <!-- politty:command:remove:end -->
172
+ <!-- politty:command:remove:options:end -->
121
173
 
122
- <!-- politty:command:show:start -->
174
+ <!-- politty:command:show:heading:start -->
123
175
 
124
176
  ## show
125
177
 
178
+ <!-- politty:command:show:heading:end -->
179
+
180
+ <!-- politty:command:show:description:start -->
181
+
126
182
  Show information about the deployed application.
127
183
 
184
+ <!-- politty:command:show:description:end -->
185
+
186
+ <!-- politty:command:show:usage:start -->
187
+
128
188
  **Usage**
129
189
 
130
190
  ```
131
191
  tailor-sdk show [options]
132
192
  ```
133
193
 
194
+ <!-- politty:command:show:usage:end -->
195
+
196
+ <!-- politty:command:show:options:start -->
197
+
134
198
  **Options**
135
199
 
136
200
  | Option | Alias | Description | Required | Default |
@@ -140,20 +204,32 @@ tailor-sdk show [options]
140
204
  | `--profile <PROFILE>` | `-p` | Workspace profile | No | - |
141
205
  | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` |
142
206
 
143
- <!-- politty:command:show:end -->
207
+ <!-- politty:command:show:options:end -->
144
208
 
145
- <!-- politty:command:open:start -->
209
+ <!-- politty:command:open:heading:start -->
146
210
 
147
211
  ## open
148
212
 
213
+ <!-- politty:command:open:heading:end -->
214
+
215
+ <!-- politty:command:open:description:start -->
216
+
149
217
  Open Tailor Platform Console.
150
218
 
219
+ <!-- politty:command:open:description:end -->
220
+
221
+ <!-- politty:command:open:usage:start -->
222
+
151
223
  **Usage**
152
224
 
153
225
  ```
154
226
  tailor-sdk open [options]
155
227
  ```
156
228
 
229
+ <!-- politty:command:open:usage:end -->
230
+
231
+ <!-- politty:command:open:options:start -->
232
+
157
233
  **Options**
158
234
 
159
235
  | Option | Alias | Description | Required | Default |
@@ -162,26 +238,42 @@ tailor-sdk open [options]
162
238
  | `--profile <PROFILE>` | `-p` | Workspace profile | No | - |
163
239
  | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` |
164
240
 
165
- <!-- politty:command:open:end -->
241
+ <!-- politty:command:open:options:end -->
166
242
 
167
- <!-- politty:command:api:start -->
243
+ <!-- politty:command:api:heading:start -->
168
244
 
169
245
  ## api
170
246
 
247
+ <!-- politty:command:api:heading:end -->
248
+
249
+ <!-- politty:command:api:description:start -->
250
+
171
251
  Call Tailor Platform API endpoints directly.
172
252
 
253
+ <!-- politty:command:api:description:end -->
254
+
255
+ <!-- politty:command:api:usage:start -->
256
+
173
257
  **Usage**
174
258
 
175
259
  ```
176
260
  tailor-sdk api [options] <endpoint>
177
261
  ```
178
262
 
263
+ <!-- politty:command:api:usage:end -->
264
+
265
+ <!-- politty:command:api:arguments:start -->
266
+
179
267
  **Arguments**
180
268
 
181
269
  | Argument | Description | Required |
182
270
  | ---------- | ------------------------------------------------------------------------------------------- | -------- |
183
271
  | `endpoint` | API endpoint to call (e.g., 'GetApplication' or 'tailor.v1.OperatorService/GetApplication') | Yes |
184
272
 
273
+ <!-- politty:command:api:arguments:end -->
274
+
275
+ <!-- politty:command:api:options:start -->
276
+
185
277
  **Options**
186
278
 
187
279
  | Option | Alias | Description | Required | Default |
@@ -191,4 +283,4 @@ tailor-sdk api [options] <endpoint>
191
283
  | `--profile <PROFILE>` | `-p` | Workspace profile | No | - |
192
284
  | `--body <BODY>` | `-b` | Request body as JSON | No | `"{}"` |
193
285
 
194
- <!-- politty:command:api:end -->
286
+ <!-- politty:command:api:options:end -->
package/docs/cli/auth.md CHANGED
@@ -2,18 +2,30 @@
2
2
 
3
3
  Commands for managing Auth service resources (machine users and OAuth2 clients).
4
4
 
5
- <!-- politty:command:machineuser:start -->
5
+ <!-- politty:command:machineuser:heading:start -->
6
6
 
7
7
  ## machineuser
8
8
 
9
+ <!-- politty:command:machineuser:heading:end -->
10
+
11
+ <!-- politty:command:machineuser:description:start -->
12
+
9
13
  Manage machine users in your Tailor Platform application.
10
14
 
15
+ <!-- politty:command:machineuser:description:end -->
16
+
17
+ <!-- politty:command:machineuser:usage:start -->
18
+
11
19
  **Usage**
12
20
 
13
21
  ```
14
22
  tailor-sdk machineuser [command]
15
23
  ```
16
24
 
25
+ <!-- politty:command:machineuser:usage:end -->
26
+
27
+ <!-- politty:command:machineuser:subcommands:start -->
28
+
17
29
  **Commands**
18
30
 
19
31
  | Command | Description |
@@ -21,19 +33,31 @@ tailor-sdk machineuser [command]
21
33
  | [`machineuser list`](#machineuser-list) | List all machine users in the application. |
22
34
  | [`machineuser token`](#machineuser-token) | Get an access token for a machine user. |
23
35
 
24
- <!-- politty:command:machineuser:end -->
25
- <!-- politty:command:machineuser list:start -->
36
+ <!-- politty:command:machineuser:subcommands:end -->
37
+ <!-- politty:command:machineuser list:heading:start -->
26
38
 
27
39
  ### machineuser list
28
40
 
41
+ <!-- politty:command:machineuser list:heading:end -->
42
+
43
+ <!-- politty:command:machineuser list:description:start -->
44
+
29
45
  List all machine users in the application.
30
46
 
47
+ <!-- politty:command:machineuser list:description:end -->
48
+
49
+ <!-- politty:command:machineuser list:usage:start -->
50
+
31
51
  **Usage**
32
52
 
33
53
  ```
34
54
  tailor-sdk machineuser list [options]
35
55
  ```
36
56
 
57
+ <!-- politty:command:machineuser list:usage:end -->
58
+
59
+ <!-- politty:command:machineuser list:options:start -->
60
+
37
61
  **Options**
38
62
 
39
63
  | Option | Alias | Description | Required | Default |
@@ -43,25 +67,41 @@ tailor-sdk machineuser list [options]
43
67
  | `--profile <PROFILE>` | `-p` | Workspace profile | No | - |
44
68
  | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` |
45
69
 
46
- <!-- politty:command:machineuser list:end -->
47
- <!-- politty:command:machineuser token:start -->
70
+ <!-- politty:command:machineuser list:options:end -->
71
+ <!-- politty:command:machineuser token:heading:start -->
48
72
 
49
73
  ### machineuser token
50
74
 
75
+ <!-- politty:command:machineuser token:heading:end -->
76
+
77
+ <!-- politty:command:machineuser token:description:start -->
78
+
51
79
  Get an access token for a machine user.
52
80
 
81
+ <!-- politty:command:machineuser token:description:end -->
82
+
83
+ <!-- politty:command:machineuser token:usage:start -->
84
+
53
85
  **Usage**
54
86
 
55
87
  ```
56
88
  tailor-sdk machineuser token [options] <name>
57
89
  ```
58
90
 
91
+ <!-- politty:command:machineuser token:usage:end -->
92
+
93
+ <!-- politty:command:machineuser token:arguments:start -->
94
+
59
95
  **Arguments**
60
96
 
61
97
  | Argument | Description | Required |
62
98
  | -------- | ----------------- | -------- |
63
99
  | `name` | Machine user name | Yes |
64
100
 
101
+ <!-- politty:command:machineuser token:arguments:end -->
102
+
103
+ <!-- politty:command:machineuser token:options:start -->
104
+
65
105
  **Options**
66
106
 
67
107
  | Option | Alias | Description | Required | Default |
@@ -71,19 +111,31 @@ tailor-sdk machineuser token [options] <name>
71
111
  | `--profile <PROFILE>` | `-p` | Workspace profile | No | - |
72
112
  | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` |
73
113
 
74
- <!-- politty:command:machineuser token:end -->
75
- <!-- politty:command:oauth2client:start -->
114
+ <!-- politty:command:machineuser token:options:end -->
115
+ <!-- politty:command:oauth2client:heading:start -->
76
116
 
77
117
  ## oauth2client
78
118
 
119
+ <!-- politty:command:oauth2client:heading:end -->
120
+
121
+ <!-- politty:command:oauth2client:description:start -->
122
+
79
123
  Manage OAuth2 clients in your Tailor Platform application.
80
124
 
125
+ <!-- politty:command:oauth2client:description:end -->
126
+
127
+ <!-- politty:command:oauth2client:usage:start -->
128
+
81
129
  **Usage**
82
130
 
83
131
  ```
84
132
  tailor-sdk oauth2client [command]
85
133
  ```
86
134
 
135
+ <!-- politty:command:oauth2client:usage:end -->
136
+
137
+ <!-- politty:command:oauth2client:subcommands:start -->
138
+
87
139
  **Commands**
88
140
 
89
141
  | Command | Description |
@@ -91,19 +143,31 @@ tailor-sdk oauth2client [command]
91
143
  | [`oauth2client get`](#oauth2client-get) | Get OAuth2 client credentials (including client secret). |
92
144
  | [`oauth2client list`](#oauth2client-list) | List all OAuth2 clients in the application. |
93
145
 
94
- <!-- politty:command:oauth2client:end -->
95
- <!-- politty:command:oauth2client list:start -->
146
+ <!-- politty:command:oauth2client:subcommands:end -->
147
+ <!-- politty:command:oauth2client list:heading:start -->
96
148
 
97
149
  ### oauth2client list
98
150
 
151
+ <!-- politty:command:oauth2client list:heading:end -->
152
+
153
+ <!-- politty:command:oauth2client list:description:start -->
154
+
99
155
  List all OAuth2 clients in the application.
100
156
 
157
+ <!-- politty:command:oauth2client list:description:end -->
158
+
159
+ <!-- politty:command:oauth2client list:usage:start -->
160
+
101
161
  **Usage**
102
162
 
103
163
  ```
104
164
  tailor-sdk oauth2client list [options]
105
165
  ```
106
166
 
167
+ <!-- politty:command:oauth2client list:usage:end -->
168
+
169
+ <!-- politty:command:oauth2client list:options:start -->
170
+
107
171
  **Options**
108
172
 
109
173
  | Option | Alias | Description | Required | Default |
@@ -113,25 +177,41 @@ tailor-sdk oauth2client list [options]
113
177
  | `--profile <PROFILE>` | `-p` | Workspace profile | No | - |
114
178
  | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` |
115
179
 
116
- <!-- politty:command:oauth2client list:end -->
117
- <!-- politty:command:oauth2client get:start -->
180
+ <!-- politty:command:oauth2client list:options:end -->
181
+ <!-- politty:command:oauth2client get:heading:start -->
118
182
 
119
183
  ### oauth2client get
120
184
 
185
+ <!-- politty:command:oauth2client get:heading:end -->
186
+
187
+ <!-- politty:command:oauth2client get:description:start -->
188
+
121
189
  Get OAuth2 client credentials (including client secret).
122
190
 
191
+ <!-- politty:command:oauth2client get:description:end -->
192
+
193
+ <!-- politty:command:oauth2client get:usage:start -->
194
+
123
195
  **Usage**
124
196
 
125
197
  ```
126
198
  tailor-sdk oauth2client get [options] <name>
127
199
  ```
128
200
 
201
+ <!-- politty:command:oauth2client get:usage:end -->
202
+
203
+ <!-- politty:command:oauth2client get:arguments:start -->
204
+
129
205
  **Arguments**
130
206
 
131
207
  | Argument | Description | Required |
132
208
  | -------- | ------------------ | -------- |
133
209
  | `name` | OAuth2 client name | Yes |
134
210
 
211
+ <!-- politty:command:oauth2client get:arguments:end -->
212
+
213
+ <!-- politty:command:oauth2client get:options:start -->
214
+
135
215
  **Options**
136
216
 
137
217
  | Option | Alias | Description | Required | Default |
@@ -141,7 +221,7 @@ tailor-sdk oauth2client get [options] <name>
141
221
  | `--profile <PROFILE>` | `-p` | Workspace profile | No | - |
142
222
  | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` |
143
223
 
144
- <!-- politty:command:oauth2client get:end -->
224
+ <!-- politty:command:oauth2client get:options:end -->
145
225
 
146
226
  **Output:**
147
227
 
@@ -1,27 +1,43 @@
1
1
  # Completion
2
2
 
3
- <!-- politty:command:completion:start -->
3
+ <!-- politty:command:completion:heading:start -->
4
4
 
5
5
  ## completion
6
6
 
7
+ <!-- politty:command:completion:heading:end -->
8
+
9
+ <!-- politty:command:completion:description:start -->
10
+
7
11
  Generate shell completion script
8
12
 
13
+ <!-- politty:command:completion:description:end -->
14
+
15
+ <!-- politty:command:completion:usage:start -->
16
+
9
17
  **Usage**
10
18
 
11
19
  ```
12
20
  tailor-sdk completion [options] [shell]
13
21
  ```
14
22
 
23
+ <!-- politty:command:completion:usage:end -->
24
+
25
+ <!-- politty:command:completion:arguments:start -->
26
+
15
27
  **Arguments**
16
28
 
17
29
  | Argument | Description | Required |
18
30
  | -------- | ------------------------------- | -------- |
19
31
  | `shell` | Shell type (bash, zsh, or fish) | No |
20
32
 
33
+ <!-- politty:command:completion:arguments:end -->
34
+
35
+ <!-- politty:command:completion:options:start -->
36
+
21
37
  **Options**
22
38
 
23
39
  | Option | Alias | Description | Required | Default |
24
40
  | ---------------- | ----- | ------------------------------ | -------- | ------- |
25
41
  | `--instructions` | `-i` | Show installation instructions | No | `false` |
26
42
 
27
- <!-- politty:command:completion:end -->
43
+ <!-- politty:command:completion:options:end -->