@kittycad/lib 4.5.16 → 4.5.24

package/dist/types/src/models.d.ts

@@ -528,16 +528,9 @@ export interface Announcement {
      */
     updated_at: string;
 }
-export interface AnnouncementResultsPage {
-    /** list of items on this page of results */
-    items: Announcement[];
-    /**
-     * {
-     *   "nullable": true,
-     *   "description": "token used to fetch the next page of results (if any)"
-     * }
-     */
-    next_page?: string;
+export interface AnnouncementList {
+    /** The list of active announcements. */
+    announcements: Announcement[];
 }
 export type ApiCallStatus = 'queued' | 'uploaded' | 'in_progress' | 'completed' | 'failed';
 export interface ApiCallWithPrice {
@@ -1804,6 +1797,12 @@ export interface CreatePlanarSurface {
      */
     surfaces: string[];
 }
+export interface CreateProjectLibraryRequest {
+    /** Display name for the library. */
+    name: string;
+    /** Whether the library belongs to the user or their active organization. */
+    scope: ProjectLibraryScope;
+}
 export interface CreateProjectShareLinkRequest {
     /** default:anyone_with_link, description:Access policy for the generated share link. */
     access_mode?: KclProjectShareLinkAccessMode;
@@ -2767,7 +2766,7 @@ export interface FailureWebSocketResponse {
     success: boolean;
 }
 export type FbxStorage = 'ascii' | 'binary';
-export type Feature = 'auth_restricted_to_employees' | 'big_query_telemetry' | 'billing' | 'disallow_self_signup' | 'email_with_s_e_s' | 'execution_jobs' | 'enable_z0006_lint' | 'factory_portal' | 'kcl_cek_executor' | 'kcl_new_lexer_parser' | 'redirect_to_govcloud' | 'require_saml_auth' | 'local_dev' | 'newsletter' | 'prefix_email_subject' | 'enterprise_cockroach' | 'same_site_none_cookies' | 'validate_tax_info' | 'dfm_review' | 'drawings' | 'modeling_dialogs' | 'named_views_ui' | 'plugins' | 'proprietary_to_kcl_conversion_beta' | 'segments_based_regions' | 'legacy_sketch_mode' | 'sketch_experimental_features' | 'zookeeper_pro_mode' | 'zookeeper_ultra_mode' | 'zookeeper_client_commands' | 'zookeeper_kcl_migration' | 'unsafe_allow_api_key_auth' | 'unsafe_allow_localhost_shortlinks' | 'zoo_corp_auth';
+export type Feature = 'auth_restricted_to_employees' | 'big_query_telemetry' | 'billing' | 'disallow_self_signup' | 'email_with_s_e_s' | 'execution_jobs' | 'enable_z0006_lint' | 'factory_portal' | 'kcl_cek_executor' | 'redirect_to_govcloud' | 'require_saml_auth' | 'local_dev' | 'newsletter' | 'prefix_email_subject' | 'enterprise_cockroach' | 'same_site_none_cookies' | 'validate_tax_info' | 'dfm_review' | 'drawings' | 'modeling_dialogs' | 'scene_browser' | 'plugins' | 'proprietary_to_kcl_conversion_beta' | 'sketch_experimental_features' | 'zookeeper_pro_mode' | 'zookeeper_ultra_mode' | 'zookeeper_client_commands' | 'zookeeper_kcl_migration' | 'unsafe_allow_api_key_auth' | 'unsafe_allow_localhost_shortlinks' | 'zoo_corp_auth';
 export interface FileBoundingBox {
     /**
      * {
@@ -3708,6 +3707,19 @@ export interface KclCodeCompletionRequest {
 export interface KclCodeCompletionResponse {
     completions: string[];
 }
+export interface KclMigrationApplication {
+    /**
+     * {
+     *   "format": "uint32",
+     *   "minimum": 0,
+     *   "description": "Starts at zero. Each accepted state change increments it once."
+     * }
+     */
+    revision: number;
+    /** Last reported state; not independent verification of local files. */
+    status: KclMigrationApplicationStatus;
+}
+export type KclMigrationApplicationStatus = 'not_applied' | 'applied' | 'undone';
 export type KclMigrationClientMessage = {
     headers: {
         [key: string]: string;
@@ -3737,9 +3749,67 @@ export type KclMigrationClientMessage = {
      */
     operation_id: Uuid;
     type: 'cancel';
+} | {
+    /**
+     * {
+     *   "$ref": "#/components/schemas/Uuid"
+     * }
+     */
+    conversation_id: Uuid;
+    type: 'history';
+} | {
+    /**
+     * {
+     *   "format": "uint32",
+     *   "minimum": 0,
+     *   "description": "The revision read before making the local change. Retrying is idempotent."
+     * }
+     */
+    expected_revision: number;
+    /**
+     * {
+     *   "$ref": "#/components/schemas/Uuid"
+     * }
+     */
+    operation_id: Uuid;
+    /**
+     * {
+     *   "$ref": "#/components/schemas/KclMigrationApplicationStatus"
+     * }
+     */
+    status: KclMigrationApplicationStatus;
+    type: 'application';
 } | {
     type: 'ping';
 };
+export interface KclMigrationHistoryEntry {
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Place this entry after this ordinary prompt when replaying the conversation."
+     * }
+     */
+    after_prompt_id?: Uuid;
+    /** Most recent client acknowledgement. */
+    application: KclMigrationApplication;
+    /** Conversation that owns this entry. */
+    conversation_id: Uuid;
+    /** format:date-time, description:Admission time, used for chronological display. */
+    created_at: string;
+    /** Outcome summary for display and subsequent model context. */
+    detail: string;
+    /** Migration request ID. Use the status command to retrieve a candidate explicitly. */
+    operation_id: Uuid;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Persisted Copilot prompt, when this migration has a conversation transcript."
+     * }
+     */
+    prompt_id?: Uuid;
+    /** Conversion outcome. Success alone does not mean files were applied. */
+    status: KclMigrationStatus;
+}
 export interface KclMigrationOperation {
     /**
      * {
@@ -3767,6 +3837,13 @@ export interface KclMigrationOperation {
 export interface KclMigrationRequest {
     /** default:false, description:Explicit consent to unstable preview semantics. */
     allow_preview?: boolean;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Existing customer conversation to link and use as background context. API verifies ownership; migration keeps its own sponsored execution record."
+     * }
+     */
+    conversation_id?: Uuid;
     current_files: {
         [key: string]: number[];
     };
@@ -3816,6 +3893,29 @@ export type KclMigrationServerMessage = {
     /** The initiating request ID, used to keep progress with its migration. */
     operation_id: Uuid;
     type: 'progress';
+} | {
+    /**
+     * {
+     *   "$ref": "#/components/schemas/Uuid"
+     * }
+     */
+    conversation_id: Uuid;
+    entries: KclMigrationHistoryEntry[];
+    type: 'history';
+} | {
+    /**
+     * {
+     *   "$ref": "#/components/schemas/KclMigrationApplication"
+     * }
+     */
+    application: KclMigrationApplication;
+    /**
+     * {
+     *   "$ref": "#/components/schemas/Uuid"
+     * }
+     */
+    operation_id: Uuid;
+    type: 'application';
 } | {
     detail: string;
     type: 'error';
@@ -3853,7 +3953,7 @@ export type KclProjectPreviewStatus = 'pending' | 'ready' | 'failed';
 export type KclProjectPublicationStatus = 'private' | 'draft' | 'pending_review' | 'published' | 'rejected' | 'deleted' | 'changes_requested';
 export type KclProjectShareLinkAccessMode = 'anyone_with_link' | 'organization_only';
 export type KclProjectVersionAncestryStatus = 'root' | 'recorded' | 'legacy_unknown';
-export type KclVersion = '1.0' | '2.0' | '3.0-preview' | '3.0';
+export type KclVersion = '1.0' | '2.0' | '3.0-preview' | '3.0' | '4.0-preview';
 export type LengthUnit = number;
 export type LenientUrl = 
 /**
@@ -6309,6 +6409,10 @@ export type ModelingCmd = {
     type: 'create_region';
     /** Which version of the Region endpoint to call. */
     version?: RegionVersion;
+} | {
+    /** Should graphics be enabled? */
+    graphics_enabled: boolean;
+    type: 'toggle_graphics';
 } | {
     /**
      * {
@@ -6425,6 +6529,22 @@ export interface MouseMove {
 }
 export interface MovePathPen {
 }
+export interface NamedView {
+    /** Baseline visibility.
+  
+  Determines whether entities are visible or by default. */
+    baseline: Visibility;
+    /** Exceptions to the baseline visibility. */
+    except_ids: ModelingCmdId[];
+    /** Projection kind. */
+    projection: Projection;
+    /** Target point. */
+    target: Point3d;
+    /** Up direction. */
+    up: Point3d;
+    /** Vantage point. */
+    vantage: Point3d;
+}
 export interface NewAnnotation {
 }
 export type OAuth2AppClientType = 'public' | 'confidential';
@@ -7835,6 +7955,14 @@ export type OkModelingCmdResponse = {
      */
     data: CreateRegion;
     type: 'create_region';
+} | {
+    /**
+     * {
+     *   "$ref": "#/components/schemas/ToggleGraphics"
+     * }
+     */
+    data: ToggleGraphics;
+    type: 'toggle_graphics';
 } | {
     /**
      * {
@@ -8555,11 +8683,20 @@ export type OutputFormat3d = {
      * }
      */
     include_uuids?: boolean;
-    /** Specifies how the JSON will be presented. */
-    presentation: GltfPresentation;
-    /** Specifies which kind of glTF 2.0 will be exported. */
-    storage: GltfStorage;
+    /** default:pretty, description:Specifies how the JSON will be presented. */
+    presentation?: GltfPresentation;
+    /**
+     * {
+     *   "default": "embedded",
+     *   "description": "Specifies which kind of glTF 2.0 will be exported."
+     * }
+     */
+    storage?: GltfStorage;
     type: 'gltf';
+    /** Named views in the scene. */
+    views?: {
+        [key: string]: NamedView;
+    };
 } | {
     /** Co-ordinate system of output data.
 
@@ -8609,9 +8746,20 @@ Defaults to millimeters. */
     created?: string;
     /** default:pretty, description:Presentation style. */
     presentation?: StepPresentation;
+    /**
+     * {
+     *   "default": "ap242",
+     *   "description": "STEP application protocol schema. Defaults to AP242."
+     * }
+     */
+    schema?: StepSchema;
     type: 'step';
     /** default:m, description:Export length unit.\n\nDefaults to meters. */
     units?: UnitLength;
+    /** Named views in the scene. */
+    views?: {
+        [key: string]: NamedView;
+    };
 } | {
     /** Co-ordinate system of output data.
 
@@ -8864,19 +9012,19 @@ export interface Point2d {
 export interface Point3d {
     /**
      * {
-     *   "format": "float"
+     *   "format": "double"
      * }
      */
     x: number;
     /**
      * {
-     *   "format": "float"
+     *   "format": "double"
      * }
      */
     y: number;
     /**
      * {
-     *   "format": "float"
+     *   "format": "double"
      * }
      */
     z: number;
@@ -8913,7 +9061,7 @@ export interface Pong {
 }
 export type PostEffectType = 
 /** Post effect type */
-'phosphor' | 'ssao' | 'noeffect';
+'phosphor' | 'ssao' | 'retrocad' | 'noeffect';
 export interface PrimitiveTopologyFallback {
     /**
      * {
@@ -8971,17 +9119,6 @@ export interface ProjectCategoryResponse {
      */
     sort_order: number;
 }
-export interface ProjectCategoryResponseResultsPage {
-    /** list of items on this page of results */
-    items: ProjectCategoryResponse[];
-    /**
-     * {
-     *   "nullable": true,
-     *   "description": "token used to fetch the next page of results (if any)"
-     * }
-     */
-    next_page?: string;
-}
 export interface ProjectEntityToPlane {
     /** Projected points. */
     projected_points: Point3d[];
@@ -9011,6 +9148,36 @@ export interface ProjectFileResponse {
     /** title:DateTime, format:date-time, description:File last update timestamp. */
     updated_at: string;
 }
+export interface ProjectLibraryResponse {
+    /** Whether the caller may rename or delete this library. */
+    can_manage: boolean;
+    /** title:DateTime, format:date-time, description:When the library was created. */
+    created_at: string;
+    /** Unique library identifier. */
+    id: Uuid;
+    /** Display name, preserving the owner's capitalization. */
+    name: string;
+    /** nullable:true, description:Organization owner; null for a personal library. */
+    org_id?: Uuid;
+    /** Opaque revision token required when renaming or deleting the library. */
+    revision: string;
+    /** title:DateTime, format:date-time, description:When the library was last updated. */
+    updated_at: string;
+    /** nullable:true, description:Personal owner; null for an organization library. */
+    user_id?: Uuid;
+}
+export interface ProjectLibraryResponseResultsPage {
+    /** list of items on this page of results */
+    items: ProjectLibraryResponse[];
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "token used to fetch the next page of results (if any)"
+     * }
+     */
+    next_page?: string;
+}
+export type ProjectLibraryScope = 'personal' | 'organization';
 export interface ProjectPointsToPlane {
     /** Projected points. */
     projected_points: Point3d[];
@@ -9066,6 +9233,15 @@ export interface ProjectResponse {
     files: ProjectFileResponse[];
     /** Unique project identifier. */
     id: Uuid;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Named library containing the project; null means unassigned."
+     * }
+     */
+    library_id?: Uuid;
+    /** Opaque token used to detect conflicting library moves. */
+    metadata_revision: string;
     /** Current preview generation state. */
     preview_status: KclProjectPreviewStatus;
     /**
@@ -9085,9 +9261,47 @@ export interface ProjectResponse {
     revision: string;
     /** User-facing project title. */
     title: string;
-    /** title:DateTime, format:date-time, description:When the project row was last updated. */
+    /**
+     * {
+     *   "title": "DateTime",
+     *   "format": "date-time",
+     *   "description": "When the current version was last updated, including preview updates. This is separate from the project row's update timestamp."
+     * }
+     */
     updated_at: string;
 }
+export interface ProjectSemanticSearchMatch {
+    /** Bounded project description. */
+    description: string;
+    /** Project in the caller's current organization library. */
+    project_id: Uuid;
+    /** format:double, description:Cosine similarity to the embedded query. */
+    similarity: number;
+    /** Bounded project title. */
+    title: string;
+    /** Current version represented by this match. */
+    version_id: Uuid;
+}
+export interface ProjectSemanticSearchRequest {
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Restrict results to this library in the authenticated organization."
+     * }
+     */
+    library_id?: Uuid;
+    /**
+     * {
+     *   "nullable": true,
+     *   "format": "uint32",
+     *   "minimum": 0,
+     *   "description": "Maximum matching projects; defaults to 10 and must be between 1 and 100."
+     * }
+     */
+    limit?: number;
+    /** Search text, limited to 2,048 characters after trimming whitespace. */
+    q: string;
+}
 export interface ProjectShareLinkResponse {
     /** Access policy for the share link. */
     access_mode: KclProjectShareLinkAccessMode;
@@ -9124,6 +9338,15 @@ export interface ProjectSummaryResponse {
     entrypoint_path: string;
     /** Unique project identifier. */
     id: Uuid;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Named library containing the project; null means unassigned."
+     * }
+     */
+    library_id?: Uuid;
+    /** Opaque token used to detect conflicting library moves. */
+    metadata_revision: string;
     /** Current preview generation state. */
     preview_status: KclProjectPreviewStatus;
     /**
@@ -9143,7 +9366,13 @@ export interface ProjectSummaryResponse {
     revision: string;
     /** User-facing project title. */
     title: string;
-    /** title:DateTime, format:date-time, description:When the project row was last updated. */
+    /**
+     * {
+     *   "title": "DateTime",
+     *   "format": "date-time",
+     *   "description": "When the current version was last updated, including preview updates. This is separate from the project row's update timestamp."
+     * }
+     */
     updated_at: string;
 }
 export interface ProjectSummaryResponseResultsPage {
@@ -9215,6 +9444,11 @@ export interface ProjectVersionSummaryResponseResultsPage {
      */
     next_page?: string;
 }
+export type Projection = {
+    type: 'orthographic';
+} | {
+    type: 'perspective';
+};
 export interface PublicEmailMarketingConsentRequest {
     /** format:email, description:The email */
     email: string;
@@ -9402,6 +9636,12 @@ export type RegionVersion = 'V0' | 'V1';
 export type RelativeTo = 'sketch_plane' | 'trajectory_curve';
 export interface RemoveSceneObjects {
 }
+export interface RenameProjectLibraryRequest {
+    /** Revision returned by the last library read. */
+    expected_revision: string;
+    /** New display name. */
+    name: string;
+}
 export interface Revolve {
     /** Any new bodies created by the request. */
     bodies_created?: BodiesCreated;
@@ -9847,6 +10087,7 @@ export interface StartPath {
 }
 export type StepImportTargetRepresentation = 'mesh' | 'brep';
 export type StepPresentation = 'compact' | 'pretty';
+export type StepSchema = 'ap203' | 'ap214' | 'ap242';
 export type StlStorage = 'ascii' | 'binary';
 export type StorageProvider = 's3' | 'zoo_managed';
 export type SubscriptionActionType = 'payment_intent' | 'setup_intent';
@@ -10162,6 +10403,8 @@ export interface TextToCadResponseResultsPage {
      */
     next_page?: string;
 }
+export interface ToggleGraphics {
+}
 export interface TokenRevokeRequestForm {
     /** format:uuid, description:The client ID. */
     client_id: string;
@@ -10871,6 +11114,17 @@ export interface UpdateOrgDatasetSource {
      */
     uri?: string;
 }
+export interface UpdateProjectLibraryRequest {
+    /** Metadata revision returned by the last project read. */
+    expected_revision: string;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "Destination library; null leaves the project unassigned."
+     * }
+     */
+    library_id?: Uuid;
+}
 export interface UpdateShortlinkRequest {
     /**
      * {
@@ -11110,6 +11364,7 @@ export interface ViewIsometric {
     /** Camera settings */
     settings: CameraSettings;
 }
+export type Visibility = 'show' | 'hide';
 export interface Volume {
     /** The output unit for the volume. */
     output_unit: UnitVolume;
@@ -11712,7 +11967,7 @@ export interface Models {
     AnnotationTextOptions: AnnotationTextOptions;
     AnnotationType: AnnotationType;
     Announcement: Announcement;
-    AnnouncementResultsPage: AnnouncementResultsPage;
+    AnnouncementList: AnnouncementList;
     ApiCallStatus: ApiCallStatus;
     ApiCallWithPrice: ApiCallWithPrice;
     ApiCallWithPriceResultsPage: ApiCallWithPriceResultsPage;
@@ -11779,6 +12034,7 @@ export interface Models {
     CreateOAuth2AppRequest: CreateOAuth2AppRequest;
     CreateOrgDataset: CreateOrgDataset;
     CreatePlanarSurface: CreatePlanarSurface;
+    CreateProjectLibraryRequest: CreateProjectLibraryRequest;
     CreateProjectShareLinkRequest: CreateProjectShareLinkRequest;
     CreateProjectVersionResponse: CreateProjectVersionResponse;
     CreateRegion: CreateRegion;
@@ -11924,7 +12180,10 @@ export interface Models {
     KclCodeCompletionParams: KclCodeCompletionParams;
     KclCodeCompletionRequest: KclCodeCompletionRequest;
     KclCodeCompletionResponse: KclCodeCompletionResponse;
+    KclMigrationApplication: KclMigrationApplication;
+    KclMigrationApplicationStatus: KclMigrationApplicationStatus;
     KclMigrationClientMessage: KclMigrationClientMessage;
+    KclMigrationHistoryEntry: KclMigrationHistoryEntry;
     KclMigrationOperation: KclMigrationOperation;
     KclMigrationRequest: KclMigrationRequest;
     KclMigrationResult: KclMigrationResult;
@@ -11976,6 +12235,7 @@ export interface Models {
     MouseClick: MouseClick;
     MouseMove: MouseMove;
     MovePathPen: MovePathPen;
+    NamedView: NamedView;
     NewAnnotation: NewAnnotation;
     OAuth2AppClientType: OAuth2AppClientType;
     OAuth2AppGrantType: OAuth2AppGrantType;
@@ -12060,12 +12320,16 @@ export interface Models {
     ProjectAccessScope: ProjectAccessScope;
     ProjectArchiveFormat: ProjectArchiveFormat;
     ProjectCategoryResponse: ProjectCategoryResponse;
-    ProjectCategoryResponseResultsPage: ProjectCategoryResponseResultsPage;
     ProjectEntityToPlane: ProjectEntityToPlane;
     ProjectFileResponse: ProjectFileResponse;
+    ProjectLibraryResponse: ProjectLibraryResponse;
+    ProjectLibraryResponseResultsPage: ProjectLibraryResponseResultsPage;
+    ProjectLibraryScope: ProjectLibraryScope;
     ProjectPointsToPlane: ProjectPointsToPlane;
     ProjectPublicationInfoResponse: ProjectPublicationInfoResponse;
     ProjectResponse: ProjectResponse;
+    ProjectSemanticSearchMatch: ProjectSemanticSearchMatch;
+    ProjectSemanticSearchRequest: ProjectSemanticSearchRequest;
     ProjectShareLinkResponse: ProjectShareLinkResponse;
     ProjectShareLinkResponseResultsPage: ProjectShareLinkResponseResultsPage;
     ProjectSummaryResponse: ProjectSummaryResponse;
@@ -12073,6 +12337,7 @@ export interface Models {
     ProjectVersionDetailResponse: ProjectVersionDetailResponse;
     ProjectVersionSummaryResponse: ProjectVersionSummaryResponse;
     ProjectVersionSummaryResponseResultsPage: ProjectVersionSummaryResponseResultsPage;
+    Projection: Projection;
     PublicEmailMarketingConsentRequest: PublicEmailMarketingConsentRequest;
     PublicMailingListMembershipRequest: PublicMailingListMembershipRequest;
     PublicProjectOwnerResponse: PublicProjectOwnerResponse;
@@ -12089,6 +12354,7 @@ export interface Models {
     RegionVersion: RegionVersion;
     RelativeTo: RelativeTo;
     RemoveSceneObjects: RemoveSceneObjects;
+    RenameProjectLibraryRequest: RenameProjectLibraryRequest;
     Revolve: Revolve;
     RevolveAboutEdge: RevolveAboutEdge;
     Rotation: Rotation;
@@ -12162,6 +12428,7 @@ export interface Models {
     StartPath: StartPath;
     StepImportTargetRepresentation: StepImportTargetRepresentation;
     StepPresentation: StepPresentation;
+    StepSchema: StepSchema;
     StlStorage: StlStorage;
     StorageProvider: StorageProvider;
     SubscriptionActionType: SubscriptionActionType;
@@ -12184,6 +12451,7 @@ export interface Models {
     TextToCadMultiFileIterationBody: TextToCadMultiFileIterationBody;
     TextToCadResponse: TextToCadResponse;
     TextToCadResponseResultsPage: TextToCadResponseResultsPage;
+    ToggleGraphics: ToggleGraphics;
     TokenRevokeRequestForm: TokenRevokeRequestForm;
     Tolerance: Tolerance;
     Transform: Transform;
@@ -12223,6 +12491,7 @@ export interface Models {
     UpdateOAuth2AppRequest: UpdateOAuth2AppRequest;
     UpdateOrgDataset: UpdateOrgDataset;
     UpdateOrgDatasetSource: UpdateOrgDatasetSource;
+    UpdateProjectLibraryRequest: UpdateProjectLibraryRequest;
     UpdateShortlinkRequest: UpdateShortlinkRequest;
     UpdateUser: UpdateUser;
     UploadOrgDatasetFilesResponse: UploadOrgDatasetFilesResponse;
@@ -12235,6 +12504,7 @@ export interface Models {
     Uuid: Uuid;
     VerificationTokenResponse: VerificationTokenResponse;
     ViewIsometric: ViewIsometric;
+    Visibility: Visibility;
     Volume: Volume;
     WebSocketRequest: WebSocketRequest;
     WebSocketResponse: WebSocketResponse;