plutonium 0.42.0 → 0.43.1

data/lib/generators/pu/core/typespec/templates/common.tsp.tt

@@ -0,0 +1,95 @@
+/**
+ * Common TypeSpec definitions for <%= Rails.application.class.module_parent_name %> API
+ * Generated by Plutonium TypeSpec Generator
+ */
+
+import "@typespec/http";
+
+using TypeSpec.Http;
+
+/**
+ * Signed Global ID - cryptographically signed resource identifier
+ * Format: gid://app/Model/id--signature
+ */
+@pattern("gid://.*--.*")
+@doc("Signed Global ID for secure resource identification")
+scalar SignedGlobalId extends string;
+
+/**
+ * Base fields included in all resource responses
+ */
+@doc("Common fields present in all API resource responses")
+model ResourceBase {
+  @doc("Signed Global ID for secure references")
+  sgid: SignedGlobalId;
+
+  @doc("API URL for this resource")
+  url: url;
+}
+
+/**
+ * Validation error detail
+ */
+model ValidationError {
+  @doc("Attribute that failed validation")
+  attribute: string;
+
+  @doc("Error detail/code")
+  detail: string;
+
+  @doc("Human-readable error message")
+  message: string;
+
+  @doc("Full error message including attribute name")
+  full_message: string;
+}
+
+/**
+ * Error response wrapper
+ */
+model ErrorResponse {
+  @doc("List of validation errors")
+  errors: ValidationError[];
+}
+
+/**
+ * Pagination metadata
+ */
+model PaginationMeta {
+  @doc("Current page number")
+  current_page: int32;
+
+  @doc("Total number of pages")
+  total_pages: int32;
+
+  @doc("Total number of records")
+  total_count: int64;
+
+  @doc("Number of records per page")
+  per_page: int32;
+}
+
+/**
+ * Standard list query parameters
+ */
+model ListQueryParams {
+  @query
+  @doc("Page number for pagination")
+  page?: int32 = 1;
+
+  @query
+  @doc("Number of items per page")
+  per_page?: int32 = 25;
+
+  @query
+  @doc("Sort field")
+  sort?: string;
+
+  @query
+  @doc("Sort direction")
+  direction?: "asc" | "desc";
+
+  @query
+  @doc("Search query")
+  q?: string;
+}

data/lib/generators/pu/core/typespec/templates/main.tsp.tt

@@ -0,0 +1,27 @@
+/**
+ * <%= @current_portal[:name] %> API Specification
+ * Generated by Plutonium TypeSpec Generator
+ */
+
+import "@typespec/http";
+import "@typespec/rest";
+import "@typespec/openapi3";
+
+<%- if @single_portal -%>
+import "./common.tsp";
+<%- else -%>
+import "../common.tsp";
+<%- end -%>
+<%- @current_portal[:resources].each do |resource| -%>
+import "./models/<%= resource[:file_name] %>.tsp";
+<%- end -%>
+
+using TypeSpec.Http;
+using TypeSpec.Rest;
+
+@service({
+  title: "<%= @current_portal[:name] %> API",
+  version: "1.0.0",
+})
+@server("http://localhost:3000<%= @current_portal[:route_path] %>", "Development server")
+namespace <%= @current_portal[:name].gsub('::', '') %>;

data/lib/generators/pu/core/typespec/templates/main_multi.tsp.tt

@@ -0,0 +1,25 @@
+/**
+ * <%= Rails.application.class.module_parent_name %> API Specification
+ * Generated by Plutonium TypeSpec Generator
+ *
+ * This file imports all portal APIs.
+ */
+
+import "@typespec/http";
+import "@typespec/rest";
+import "@typespec/openapi3";
+
+import "./common.tsp";
+<%- @portals.each do |portal| -%>
+import "./<%= portal[:file_name] %>/main.tsp";
+<%- end -%>
+
+using TypeSpec.Http;
+using TypeSpec.Rest;
+
+@service({
+  title: "<%= Rails.application.class.module_parent_name %> API",
+  version: "1.0.0",
+})
+@server("http://localhost:3000", "Development server")
+namespace <%= Rails.application.class.module_parent_name %>;

data/lib/generators/pu/core/typespec/templates/model.tsp.tt

@@ -0,0 +1,226 @@
+<%-
+# Helper methods for template
+def optional_marker(column)
+  column[:null] ? '?' : ''
+end
+
+resource = @current_resource
+model_name = resource[:typespec_name]
+all_columns = resource[:columns]
+all_column_names = all_columns.map { |c| c[:name] }
+
+# Extract special columns if they exist
+primary_key_column = all_columns.find { |c| c[:name] == resource[:primary_key] }
+created_at_column = all_columns.find { |c| c[:name] == 'created_at' }
+updated_at_column = all_columns.find { |c| c[:name] == 'updated_at' }
+
+# Regular columns exclude primary key and timestamps
+columns = all_columns.reject { |c| [resource[:primary_key], 'created_at', 'updated_at'].include?(c[:name]) }
+associations = resource[:associations]
+enums = resource[:enums] || {}
+definition = resource[:definition]
+inputs = definition ? definition[:inputs] : []
+
+# Separate association columns (foreign keys) from regular columns
+belongs_to_assocs = associations.select { |a| a[:macro] == 'belongs_to' }
+has_many_assocs = associations.select { |a| a[:macro] == 'has_many' }
+has_one_assocs = associations.select { |a| a[:macro] == 'has_one' }
+
+# Foreign key columns to exclude from regular attributes
+fk_columns = belongs_to_assocs.map { |a| a[:foreign_key] }.compact
+regular_columns = columns.reject { |c| fk_columns.include?(c[:name]) }
+
+# Check if we have definition-based inputs
+has_definition_inputs = inputs.any?
+-%>
+/**
+ * <%= model_name %> resource
+ * Table: <%= resource[:table_name] %>
+ * Route: <%= resource[:route_path] %>
+ */
+
+<%- if @single_portal -%>
+import "../common.tsp";
+<%- else -%>
+import "../../common.tsp";
+<%- end -%>
+
+using TypeSpec.Http;
+
+<%- enums.each do |enum_name, values| -%>
+/** <%= enum_name.humanize %> options */
+enum <%= model_name %><%= enum_name.camelize %> {
+<%- values.each do |value| -%>
+  <%= value %>,
+<%- end -%>
+}
+
+<%- end -%>
+/**
+ * <%= model_name %> response model
+ */
+model <%= model_name %> extends ResourceBase {
+<%- if primary_key_column -%>
+  @doc("Unique identifier")
+  <%= resource[:primary_key] %>: <%= resource[:primary_key_type] %>;
+<%- end -%>
+<%- if created_at_column -%>
+  @doc("Creation timestamp")
+  created_at: utcDateTime;
+<%- end -%>
+<%- if updated_at_column -%>
+  @doc("Last update timestamp")
+  updated_at: utcDateTime;
+<%- end -%>
+<%- if (primary_key_column || created_at_column || updated_at_column) && regular_columns.any? -%>
+
+<%- end -%>
+<%- regular_columns.each do |column| -%>
+<%- if enums.key?(column[:name]) -%>
+  <%= column[:name] %><%= optional_marker(column) %>: <%= model_name %><%= column[:name].camelize %>;
+<%- else -%>
+  <%= column[:name] %><%= optional_marker(column) %>: <%= column[:typespec_type] %>;
+<%- end -%>
+<%- end -%>
+
+<%- belongs_to_assocs.each do |assoc| -%>
+<%- if assoc[:polymorphic] -%>
+  /** Polymorphic association type */
+  <%= assoc[:name] %>_type?: string;
+  /** Polymorphic association ID */
+  <%= assoc[:name] %>_id?: <%= assoc[:foreign_key_type] %>;
+  /** Polymorphic association SGID */
+  <%= assoc[:name] %>_sgid?: SignedGlobalId;
+<%- else -%>
+  /** <%= assoc[:name].humanize %> ID */
+  <%= assoc[:foreign_key] || "#{assoc[:name]}_id" %>?: <%= assoc[:foreign_key_type] %>;
+  /** <%= assoc[:name].humanize %> SGID */
+  <%= assoc[:name] %>_sgid?: SignedGlobalId;
+<%- end -%>
+<%- end -%>
+
+<%- has_many_assocs.each do |assoc| -%>
+  /** <%= assoc[:name].to_s.singularize.humanize %> IDs */
+  <%= assoc[:name].to_s.singularize %>_ids?: <%= assoc[:foreign_key_type] %>[];
+  /** <%= assoc[:name].to_s.singularize.humanize %> SGIDs */
+  <%= assoc[:name].to_s.singularize %>_sgids?: SignedGlobalId[];
+<%- end -%>
+<%- has_one_assocs.each do |assoc| -%>
+  /** <%= assoc[:name].humanize %> ID */
+  <%= assoc[:name] %>_id?: <%= assoc[:foreign_key_type] %>;
+  /** <%= assoc[:name].humanize %> SGID */
+  <%= assoc[:name] %>_sgid?: SignedGlobalId;
+<%- end -%>
+}
+
+/**
+ * <%= model_name %> input model for create/update operations
+<%- if has_definition_inputs -%>
+ * Based on definition: <%= definition[:class_name] %>
+<%- end -%>
+ */
+model <%= model_name %>Input {
+<%- if has_definition_inputs -%>
+<%# Use definition inputs -%>
+<%- inputs.each do |input| -%>
+<%- next if input[:nested] # Skip nested inputs for now -%>
+<%- if input[:is_association] -%>
+<%- if input[:is_polymorphic] -%>
+  /** Polymorphic <%= input[:name] %> (SGID) */
+  <%= input[:name] %>_sgid<%= input[:required] ? '' : '?' %>: SignedGlobalId;
+<%- elsif input[:association_macro] == 'has_many' || input[:association_macro] == 'has_and_belongs_to_many' -%>
+  /** <%= input[:name].singularize.humanize %> SGIDs */
+  <%= input[:name].singularize %>_sgids<%= input[:required] ? '' : '?' %>: SignedGlobalId[];
+<%- else -%>
+  /** <%= input[:name].humanize %> (SGID) */
+  <%= input[:name] %>_sgid<%= input[:required] ? '' : '?' %>: SignedGlobalId;
+<%- end -%>
+<%- else -%>
+  <%= input[:name] %><%= input[:required] ? '' : '?' %>: <%= input[:typespec_type] %>;
+<%- end -%>
+<%- end -%>
+<%- else -%>
+<%# Fallback to column-based inputs -%>
+<%- regular_columns.each do |column| -%>
+<%- next if column[:name].end_with?('_count') # skip counter caches -%>
+<%- if enums.key?(column[:name]) -%>
+  <%= column[:name] %><%= optional_marker(column) %>: <%= model_name %><%= column[:name].camelize %>;
+<%- else -%>
+  <%= column[:name] %><%= optional_marker(column) %>: <%= column[:typespec_type] %>;
+<%- end -%>
+<%- end -%>
+
+<%- belongs_to_assocs.each do |assoc| -%>
+<%- if assoc[:polymorphic] -%>
+  /** Polymorphic <%= assoc[:name] %> (SGID) */
+  <%= assoc[:name] %>_sgid?: SignedGlobalId;
+<%- else -%>
+  /** <%= assoc[:name].humanize %> (SGID) */
+  <%= assoc[:name] %>_sgid?: SignedGlobalId;
+<%- end -%>
+<%- end -%>
+
+<%- has_many_assocs.each do |assoc| -%>
+  /** <%= assoc[:name].to_s.singularize.humanize %> SGIDs */
+  <%= assoc[:name].to_s.singularize %>_sgids?: SignedGlobalId[];
+<%- end -%>
+<%- end -%>
+}
+
+/**
+ * <%= model_name %> list response
+ */
+model <%= model_name %>ListResponse {
+  <%= model_name.underscore.pluralize %>: <%= model_name %>[];
+}
+
+/**
+ * <%= model_name %> CRUD operations
+ */
+@route("<%= resource[:route_path] %>")
+@tag("<%= model_name.pluralize %>")
+interface <%= model_name %>Operations {
+  /**
+   * List all <%= model_name.underscore.humanize.pluralize.downcase %>
+   */
+  @get
+  list(...ListQueryParams): <%= model_name %>ListResponse;
+
+  /**
+   * Get a single <%= model_name.underscore.humanize.downcase %>
+   */
+  @route("{id}")
+  @get
+  show(@path id: <%= resource[:primary_key_type] %>): <%= model_name %>;
+
+  /**
+   * Create a new <%= model_name.underscore.humanize.downcase %>
+   */
+  @post
+  create(@body input: <%= model_name %>Input): {
+    @statusCode statusCode: 201;
+    @body body: <%= model_name %>;
+  } | {
+    @statusCode statusCode: 422;
+    @body body: ErrorResponse;
+  };
+
+  /**
+   * Update a <%= model_name.underscore.humanize.downcase %>
+   */
+  @route("{id}")
+  @patch
+  update(@path id: <%= resource[:primary_key_type] %>, @body input: <%= model_name %>Input): <%= model_name %> | {
+    @statusCode statusCode: 422;
+    @body body: ErrorResponse;
+  };
+
+  /**
+   * Delete a <%= model_name.underscore.humanize.downcase %>
+   */
+  @route("{id}")
+  @delete
+  destroy(@path id: <%= resource[:primary_key_type] %>): {
+    @statusCode statusCode: 204;
+  };
+}