@objectstack/spec 6.9.0 → 7.0.0

package/dist/data/index.mjs

@@ -1368,6 +1368,16 @@ var ActionType = z.enum(["script", "url", "modal", "flow", "api", "form"]);
 var TARGET_REQUIRED_TYPES = new Set(
   ActionType.options.filter((t) => t !== "script")
 );
+var ACTION_LOCATIONS = [
+  "list_toolbar",
+  "list_item",
+  "record_header",
+  "record_more",
+  "record_related",
+  "record_section",
+  "global_nav"
+];
+var ActionLocationSchema = z.enum(ACTION_LOCATIONS);
 var ActionSchema = lazySchema(() => z.object({
   /** Machine name of the action */
   name: SnakeCaseIdentifierSchema.describe("Machine name (lowercase snake_case)"),
@@ -1378,14 +1388,7 @@ var ActionSchema = lazySchema(() => z.object({
   /** Icon name (Lucide) */
   icon: z.string().optional().describe("Icon name"),
   /** Where does this action appear? */
-  locations: z.array(z.enum([
-    "list_toolbar",
-    "list_item",
-    "record_header",
-    "record_more",
-    "record_related",
-    "global_nav"
-  ])).optional().describe("Locations where this action is visible"),
+  locations: z.array(ActionLocationSchema).optional().describe("Locations where this action is visible"),
   /** 
    * Visual Component Type
    * Defaults to 'button' or 'menu_item' based on location,
@@ -1408,8 +1411,19 @@ var ActionSchema = lazySchema(() => z.object({
    * Required for url, flow, modal, and api types.
    * For `script` type: prefer `body` over `target`. `target` is kept only for
    * legacy bundle.functions[name] references.
-   */
-  target: z.string().optional().describe("URL, Script Name, Flow ID, or API Endpoint"),
+   *
+   * **Interpolation** (renderer responsibility, all action types):
+   * `target` MAY contain `${param.X}` and `${ctx.X}` tokens. Renderers
+   * resolve them just before invocation:
+   * - `${param.X}` — value collected from the action's params dialog.
+   * - `${ctx.X}` — values from the action context: `ctx.origin`
+   *   (window.origin), `ctx.recordId`, `ctx.user.id`, `ctx.org.id`, etc.
+   * Used by redirect-style actions like `link_social`, where the target is
+   * e.g. `/api/v1/auth/sign-in/social?provider=${param.provider}&callbackURL=${ctx.origin}/_account/linked-accounts`.
+   * Renderers MUST `encodeURIComponent` interpolated values before
+   * substituting them into URL query positions.
+   */
+  target: z.string().optional().describe("URL, Script Name, Flow ID, or API Endpoint. Supports ${param.X} and ${ctx.X} interpolation."),
   /**
    * Action Body (L1 expression or L2 sandboxed JS).
    *
@@ -1436,6 +1450,53 @@ var ActionSchema = lazySchema(() => z.object({
   confirmText: I18nLabelSchema.optional().describe("Confirmation message before execution"),
   successMessage: I18nLabelSchema.optional().describe("Success message to show after execution"),
   refreshAfter: z.boolean().default(false).describe("Refresh view after execution"),
+  /**
+   * Result Dialog — describe how to render the API response on success.
+   *
+   * When set and the action returns successfully, the renderer SHOULD open a
+   * dialog showing the selected fields from `result.data` instead of the
+   * `successMessage` toast. The dialog has an acknowledge button only — the
+   * user must explicitly close it. Used for **one-shot reveals** of values
+   * the user must copy now because they cannot be retrieved later:
+   *
+   * - TOTP enrollment URI + secret (`enable_two_factor`)
+   * - Backup recovery codes (`regenerate_backup_codes`)
+   * - Freshly minted OAuth `client_secret` (`rotate_client_secret`,
+   *   `create_oauth_application`)
+   *
+   * `fields` selects what to render and how. Each entry's `path` is a dot
+   * path into `result.data` (e.g. `'totpURI'`, `'backupCodes'`,
+   * `'client.client_secret'`). When `fields` is omitted, the renderer falls
+   * back to JSON-printing the whole response under a single block.
+   *
+   * `format` (dialog-level) is a default for fields that don't carry their
+   * own `format`; the per-field `format` always wins.
+   *
+   * Renderer contract (objectui):
+   * - `qrcode` — render the value as a QR code; also render the raw string
+   *   underneath with a copy button (so the user can paste into apps that
+   *   don't scan).
+   * - `code-list` — value must be an array of strings; render each in a
+   *   monospace row with per-row copy and a "Copy all" affordance.
+   * - `secret` — render a single string masked by default with a reveal
+   *   toggle and copy button.
+   * - `text` — plain text with copy.
+   * - `json` — pretty-printed JSON in a monospace block.
+   *
+   * The dialog SHOULD set `refreshAfter` to true on close (separate from
+   * the existing `refreshAfter` flag, which fires immediately on success).
+   */
+  resultDialog: z.object({
+    title: I18nLabelSchema.optional(),
+    description: I18nLabelSchema.optional(),
+    acknowledge: I18nLabelSchema.optional().describe('Acknowledge button label, e.g. "I have saved this"'),
+    format: z.enum(["qrcode", "code-list", "secret", "text", "json"]).optional().describe("Default format for fields without their own format. Defaults to json when omitted."),
+    fields: z.array(z.object({
+      path: z.string().describe('Dot path into result.data (e.g. "totpURI", "client.client_secret").'),
+      label: I18nLabelSchema.optional(),
+      format: z.enum(["qrcode", "code-list", "secret", "text", "json"]).optional().describe("Per-field format override.")
+    })).optional().describe("Which fields from result.data to render. Omit to dump full JSON.")
+  }).optional().describe("Render API response in a one-shot reveal dialog (suppresses successMessage when set)."),
   /** Access */
   visible: ExpressionInputSchema.optional().describe("Visibility predicate (CEL)."),
   disabled: z.union([z.boolean(), ExpressionInputSchema]).optional().describe("Boolean or predicate (CEL) \u2014 action is disabled when TRUE."),
@@ -2014,6 +2075,13 @@ var FormFieldSchema = lazySchema(() => z.object({
   visibleOn: ExpressionInputSchema.optional().describe("Visibility predicate (CEL).")
 }));
 var FormSectionSchema = lazySchema(() => z.object({
+  /**
+   * Stable identifier for translation lookup. snake_case convention.
+   * When provided, translation bundles can target this section's `label`
+   * and `description` via `metadataForms.<type>.sections.<name>`.
+   * Optional for backward-compat with sections that only have a `label`.
+   */
+  name: z.string().optional().describe("Stable section identifier for i18n lookup (snake_case)"),
   label: I18nLabelSchema.optional(),
   description: z.string().optional().describe("Optional description rendered under the section header."),
   collapsible: z.boolean().default(false),
@@ -4045,6 +4113,7 @@ var objectForm = defineForm({
   type: "simple",
   sections: [
     {
+      name: "basics",
       label: "Basics",
       description: "Identity, labels, and taxonomy.",
       columns: 2,
@@ -4061,6 +4130,7 @@ var objectForm = defineForm({
       ]
     },
     {
+      name: "fields",
       label: "Fields",
       description: "Define the data model \u2014 each row becomes a column in the database table.",
       fields: [
@@ -4081,6 +4151,7 @@ var objectForm = defineForm({
       ]
     },
     {
+      name: "capabilities",
       label: "Capabilities",
       description: "System features and API exposure.",
       collapsible: true,
@@ -4105,6 +4176,7 @@ var objectForm = defineForm({
       ]
     },
     {
+      name: "advanced",
       label: "Advanced",
       description: "State machines, actions, and storage.",
       collapsible: true,
@@ -4122,6 +4194,7 @@ var fieldForm = defineForm({
   type: "simple",
   sections: [
     {
+      name: "basics",
       label: "Basics",
       description: "Core field identity and constraints.",
       columns: 2,
@@ -4137,6 +4210,7 @@ var fieldForm = defineForm({
       ]
     },
     {
+      name: "configuration",
       label: "Configuration",
       description: "Field-type specific settings (visible blocks depend on the chosen type).",
       fields: [
@@ -4158,6 +4232,7 @@ var fieldForm = defineForm({
       ]
     },
     {
+      name: "formula",
       label: "Formula & Computed",
       description: "Calculated values and roll-up summaries.",
       collapsible: true,
@@ -4169,6 +4244,7 @@ var fieldForm = defineForm({
       ]
     },
     {
+      name: "advanced",
       label: "Advanced",
       description: "Database, UI, audit, and security settings.",
       collapsible: true,
@@ -5204,120 +5280,7 @@ var RecordSubscriptionSchema = lazySchema(() => z.object({
   /** Timestamps */
   createdAt: z.string().datetime().describe("Subscription creation timestamp")
 }));
-var TenantResolverStrategySchema = lazySchema(() => z.enum([
-  "header",
-  // Resolve from X-Tenant-ID request header
-  "subdomain",
-  // Resolve from subdomain (e.g., acme.app.com → acme)
-  "path",
-  // Resolve from URL path segment (e.g., /api/acme/...)
-  "token",
-  // Resolve from JWT claim (e.g., tenant_id in access token)
-  "lookup"
-  // Resolve from control-plane database lookup
-]).describe("Strategy for resolving tenant identity from request context"));
-var TursoGroupSchema = lazySchema(() => z.object({
-  /**
-   * Group name identifier.
-   * Used to reference the group when creating new tenant databases.
-   */
-  name: z.string().min(1).describe("Turso database group name"),
-  /**
-   * Primary location for the group (Turso region code).
-   * Example: 'iad' (US East), 'lhr' (London), 'nrt' (Tokyo)
-   */
-  primaryLocation: z.string().min(2).describe("Primary Turso region code (e.g., iad, lhr, nrt)"),
-  /**
-   * Additional replica locations for read performance.
-   * Databases in this group will have read replicas in these regions.
-   */
-  replicaLocations: z.array(z.string().min(2)).default([]).describe("Additional replica region codes"),
-  /**
-   * Schema database name within the group.
-   * When using multi-db schemas, this is the "parent" database
-   * whose schema is shared by all child (tenant) databases.
-   */
-  schemaDatabase: z.string().optional().describe("Schema database name for multi-db schemas")
-}).describe("Turso database group configuration"));
-var TenantDatabaseLifecycleSchema = lazySchema(() => z.object({
-  /**
-   * Hook executed when a new tenant is created.
-   * Defines how the tenant database is provisioned.
-   */
-  onTenantCreate: z.object({
-    /** Whether to automatically create a Turso database */
-    autoCreate: z.boolean().default(true).describe("Auto-create database on tenant registration"),
-    /** Database group to create the database in */
-    group: z.string().optional().describe("Turso group for the new database"),
-    /** Whether to apply schema from the group schema database */
-    applyGroupSchema: z.boolean().default(true).describe("Apply shared schema from group"),
-    /** Seed data to populate on creation */
-    seedData: z.boolean().default(false).describe("Populate seed data on creation")
-  }).describe("Tenant creation hook"),
-  /**
-   * Hook executed when a tenant is deleted/destroyed.
-   */
-  onTenantDelete: z.object({
-    /** Whether to destroy the database immediately or schedule for deletion */
-    immediate: z.boolean().default(false).describe("Destroy database immediately"),
-    /** Grace period in hours before permanent deletion (soft-delete) */
-    gracePeriodHours: z.number().int().min(0).default(72).describe("Grace period before permanent deletion"),
-    /** Whether to create a final backup before deletion */
-    createBackup: z.boolean().default(true).describe("Create backup before deletion")
-  }).describe("Tenant deletion hook"),
-  /**
-   * Hook executed when a tenant is suspended (e.g., unpaid, policy violation).
-   */
-  onTenantSuspend: z.object({
-    /** Whether to revoke auth tokens on suspension */
-    revokeTokens: z.boolean().default(true).describe("Revoke auth tokens on suspension"),
-    /** Whether to set database to read-only mode */
-    readOnly: z.boolean().default(true).describe("Set database to read-only on suspension")
-  }).describe("Tenant suspension hook")
-}).describe("Tenant database lifecycle hooks"));
-var TursoMultiTenantConfigSchema = lazySchema(() => z.object({
-  /**
-   * Turso organization slug.
-   * Used for Platform API calls and URL construction.
-   */
-  organizationSlug: z.string().min(1).describe("Turso organization slug"),
-  /**
-   * URL template for constructing tenant database URLs.
-   * Use `{tenant_id}` as placeholder for the tenant identifier.
-   *
-   * Example: 'libsql://{tenant_id}-myorg.turso.io'
-   */
-  urlTemplate: z.string().min(1).describe("URL template with {tenant_id} placeholder"),
-  /**
-   * Group-level auth token for Turso Platform API operations.
-   * Used for database creation, deletion, and management.
-   * This token has full access to all databases in the group.
-   */
-  groupAuthToken: z.string().min(1).describe("Group-level auth token for platform operations"),
-  /**
-   * Strategy for resolving tenant identity from the request context.
-   */
-  tenantResolverStrategy: TenantResolverStrategySchema.default("token"),
-  /**
-   * Turso database group configuration.
-   */
-  group: TursoGroupSchema.optional().describe("Database group configuration"),
-  /**
-   * Lifecycle hooks for tenant database management.
-   */
-  lifecycle: TenantDatabaseLifecycleSchema.optional().describe("Lifecycle hooks"),
-  /**
-   * Maximum number of cached tenant database connections.
-   * Connections are evicted using LRU strategy when the limit is reached.
-   */
-  maxCachedConnections: z.number().int().min(1).default(100).describe("Max cached tenant connections (LRU)"),
-  /**
-   * Connection cache TTL in seconds.
-   * Cached connections are refreshed after this period.
-   */
-  connectionCacheTTL: z.number().int().min(0).default(300).describe("Connection cache TTL in seconds")
-}).describe("Turso multi-tenant router configuration"));
 
-export { ALL_OPERATORS, AddressSchema, AggregationFunction, AggregationMetricType, AggregationNodeSchema, AggregationPipelineSchema, AggregationStageSchema, AnalyticsQuerySchema, ApiMethod, AsyncValidationSchema, BaseEngineOptionsSchema, CDCConfigSchema, ComparisonOperatorSchema, ComputedFieldCacheSchema, ConditionalValidationSchema, ConsistencyLevelSchema, CrossFieldValidationSchema, CubeJoinSchema, CubeSchema, CurrencyConfigSchema, CurrencyValueSchema, CustomValidatorSchema, DATE_MACRO_ALIAS_TOKENS, DATE_MACRO_DESCRIPTIONS, DATE_MACRO_INSTANT_TOKENS, DATE_MACRO_PARAM_RE, DATE_MACRO_PERIOD_TOKENS, DATE_MACRO_TOKENS, DATE_MACRO_UNITS, DATE_MACRO_WRAPPED_RE, DataEngineAggregateOptionsSchema, DataEngineAggregateRequestSchema, DataEngineBatchRequestSchema, DataEngineContractSchema, DataEngineCountOptionsSchema, DataEngineCountRequestSchema, DataEngineDeleteOptionsSchema, DataEngineDeleteRequestSchema, DataEngineExecuteRequestSchema, DataEngineFilterSchema, DataEngineFindOneRequestSchema, DataEngineFindRequestSchema, DataEngineInsertOptionsSchema, DataEngineInsertRequestSchema, DataEngineQueryOptionsSchema, DataEngineRequestSchema, DataEngineSortSchema, DataEngineUpdateOptionsSchema, DataEngineUpdateRequestSchema, DataEngineVectorFindRequestSchema, DataQualityRulesSchema, DataTypeMappingSchema, DatasetLoadResultSchema, DatasetMode, DatasetSchema, DatasourceCapabilities, DatasourceSchema, DateGranularity, DateMacroPlaceholderSchema, DateMacroTokenSchema, DimensionSchema, DimensionType, DocumentSchema, DocumentSchemaValidationSchema, DocumentTemplateSchema, DocumentVersionSchema, DriverCapabilitiesSchema, DriverConfigSchema, DriverDefinitionSchema, DriverInterfaceSchema, DriverOptionsSchema, DriverType, ESignatureConfigSchema, EngineAggregateOptionsSchema, EngineCountOptionsSchema, EngineDeleteOptionsSchema, EngineQueryOptionsSchema, EngineUpdateOptionsSchema, EqualityOperatorSchema, ExpressionBodySchema, ExternalDataSourceSchema, ExternalFieldMappingSchema, ExternalLookupSchema, FILTER_OPERATORS, FeedActorSchema, FeedFilterMode, FeedItemSchema, FeedItemType, FeedVisibility, Field, FieldChangeEntrySchema, FieldMappingSchema, FieldNodeSchema, FieldOperatorsSchema, FieldReferenceSchema, FieldSchema, FieldType, FileAttachmentConfigSchema, FilterConditionSchema, FormatValidationSchema, FullTextSearchSchema, GroupByNodeSchema, HookBodyCapability, HookBodySchema, HookContextSchema, HookEvent, HookSchema, IndexSchema, JSONValidationSchema, JoinNodeSchema, JoinStrategy, JoinType, LOGICAL_OPERATORS, LocationCoordinatesSchema, MappingSchema, MentionSchema, MetricSchema, NoSQLDataTypeMappingSchema, NoSQLDatabaseTypeSchema, NoSQLDriverConfigSchema, NoSQLIndexSchema, NoSQLIndexTypeSchema, NoSQLOperationTypeSchema, NoSQLQueryOptionsSchema, NoSQLTransactionOptionsSchema, NormalizedFilterSchema, NotificationChannel, ObjectCapabilities, ObjectDependencyGraphSchema, ObjectDependencyNodeSchema, ObjectExtensionSchema, ObjectFieldGroupSchema, ObjectOwnershipEnum, ObjectSchema, PartitioningConfigSchema, PoolConfigSchema, QueryFilterSchema, QuerySchema, RangeOperatorSchema, ReactionSchema, RecordSubscriptionSchema, ReferenceResolutionErrorSchema, ReferenceResolutionSchema, ReplicationConfigSchema, SQLDialectSchema, SQLDriverConfigSchema, SQLiteAlterTableLimitations, SQLiteDataTypeMappingDefaults, SSLConfigSchema, ScriptBodySchema, ScriptValidationSchema, SearchConfigSchema, SeedLoaderConfigSchema, SeedLoaderRequestSchema, SeedLoaderResultSchema, SelectOptionSchema, SetOperatorSchema, ShardingConfigSchema, SoftDeleteConfigSchema, SortNodeSchema, SpecialOperatorSchema, StateMachineValidationSchema, StringOperatorSchema, SubscriptionEventType, TenancyConfigSchema, TenantDatabaseLifecycleSchema, TenantResolverStrategySchema, TimeUpdateInterval, TransformType, TursoGroupSchema, TursoMultiTenantConfigSchema, UniquenessValidationSchema, VALID_AST_OPERATORS, ValidationRuleSchema, VectorConfigSchema, VersioningConfigSchema, WindowFunction, WindowFunctionNodeSchema, WindowSpecSchema, defineDataset, fieldForm, hookForm, isDateMacroToken, isFilterAST, objectForm, parseDateMacroParam, parseFilterAST, resolveCrudAffordances };
+export { ALL_OPERATORS, AddressSchema, AggregationFunction, AggregationMetricType, AggregationNodeSchema, AggregationPipelineSchema, AggregationStageSchema, AnalyticsQuerySchema, ApiMethod, AsyncValidationSchema, BaseEngineOptionsSchema, CDCConfigSchema, ComparisonOperatorSchema, ComputedFieldCacheSchema, ConditionalValidationSchema, ConsistencyLevelSchema, CrossFieldValidationSchema, CubeJoinSchema, CubeSchema, CurrencyConfigSchema, CurrencyValueSchema, CustomValidatorSchema, DATE_MACRO_ALIAS_TOKENS, DATE_MACRO_DESCRIPTIONS, DATE_MACRO_INSTANT_TOKENS, DATE_MACRO_PARAM_RE, DATE_MACRO_PERIOD_TOKENS, DATE_MACRO_TOKENS, DATE_MACRO_UNITS, DATE_MACRO_WRAPPED_RE, DataEngineAggregateOptionsSchema, DataEngineAggregateRequestSchema, DataEngineBatchRequestSchema, DataEngineContractSchema, DataEngineCountOptionsSchema, DataEngineCountRequestSchema, DataEngineDeleteOptionsSchema, DataEngineDeleteRequestSchema, DataEngineExecuteRequestSchema, DataEngineFilterSchema, DataEngineFindOneRequestSchema, DataEngineFindRequestSchema, DataEngineInsertOptionsSchema, DataEngineInsertRequestSchema, DataEngineQueryOptionsSchema, DataEngineRequestSchema, DataEngineSortSchema, DataEngineUpdateOptionsSchema, DataEngineUpdateRequestSchema, DataEngineVectorFindRequestSchema, DataQualityRulesSchema, DataTypeMappingSchema, DatasetLoadResultSchema, DatasetMode, DatasetSchema, DatasourceCapabilities, DatasourceSchema, DateGranularity, DateMacroPlaceholderSchema, DateMacroTokenSchema, DimensionSchema, DimensionType, DocumentSchema, DocumentSchemaValidationSchema, DocumentTemplateSchema, DocumentVersionSchema, DriverCapabilitiesSchema, DriverConfigSchema, DriverDefinitionSchema, DriverInterfaceSchema, DriverOptionsSchema, DriverType, ESignatureConfigSchema, EngineAggregateOptionsSchema, EngineCountOptionsSchema, EngineDeleteOptionsSchema, EngineQueryOptionsSchema, EngineUpdateOptionsSchema, EqualityOperatorSchema, ExpressionBodySchema, ExternalDataSourceSchema, ExternalFieldMappingSchema, ExternalLookupSchema, FILTER_OPERATORS, FeedActorSchema, FeedFilterMode, FeedItemSchema, FeedItemType, FeedVisibility, Field, FieldChangeEntrySchema, FieldMappingSchema, FieldNodeSchema, FieldOperatorsSchema, FieldReferenceSchema, FieldSchema, FieldType, FileAttachmentConfigSchema, FilterConditionSchema, FormatValidationSchema, FullTextSearchSchema, GroupByNodeSchema, HookBodyCapability, HookBodySchema, HookContextSchema, HookEvent, HookSchema, IndexSchema, JSONValidationSchema, JoinNodeSchema, JoinStrategy, JoinType, LOGICAL_OPERATORS, LocationCoordinatesSchema, MappingSchema, MentionSchema, MetricSchema, NoSQLDataTypeMappingSchema, NoSQLDatabaseTypeSchema, NoSQLDriverConfigSchema, NoSQLIndexSchema, NoSQLIndexTypeSchema, NoSQLOperationTypeSchema, NoSQLQueryOptionsSchema, NoSQLTransactionOptionsSchema, NormalizedFilterSchema, NotificationChannel, ObjectCapabilities, ObjectDependencyGraphSchema, ObjectDependencyNodeSchema, ObjectExtensionSchema, ObjectFieldGroupSchema, ObjectOwnershipEnum, ObjectSchema, PartitioningConfigSchema, PoolConfigSchema, QueryFilterSchema, QuerySchema, RangeOperatorSchema, ReactionSchema, RecordSubscriptionSchema, ReferenceResolutionErrorSchema, ReferenceResolutionSchema, ReplicationConfigSchema, SQLDialectSchema, SQLDriverConfigSchema, SQLiteAlterTableLimitations, SQLiteDataTypeMappingDefaults, SSLConfigSchema, ScriptBodySchema, ScriptValidationSchema, SearchConfigSchema, SeedLoaderConfigSchema, SeedLoaderRequestSchema, SeedLoaderResultSchema, SelectOptionSchema, SetOperatorSchema, ShardingConfigSchema, SoftDeleteConfigSchema, SortNodeSchema, SpecialOperatorSchema, StateMachineValidationSchema, StringOperatorSchema, SubscriptionEventType, TenancyConfigSchema, TimeUpdateInterval, TransformType, UniquenessValidationSchema, VALID_AST_OPERATORS, ValidationRuleSchema, VectorConfigSchema, VersioningConfigSchema, WindowFunction, WindowFunctionNodeSchema, WindowSpecSchema, defineDataset, fieldForm, hookForm, isDateMacroToken, isFilterAST, objectForm, parseDateMacroParam, parseFilterAST, resolveCrudAffordances };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map