@kittycad/lib 4.5.19 → 4.5.26

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

@@ -1802,6 +1802,13 @@ export interface CreateProjectLibraryRequest {
     name: string;
     /** Whether the library belongs to the user or their active organization. */
     scope: ProjectLibraryScope;
+    /**
+     * {
+     *   "default": "zds",
+     *   "description": "Application creating the library. Defaults to zds when omitted."
+     * }
+     */
+    source?: KclProjectLibrarySource;
 }
 export interface CreateProjectShareLinkRequest {
     /** default:anyone_with_link, description:Access policy for the generated share link. */
@@ -2712,6 +2719,12 @@ export interface FactoryCustomerJobDetail {
     /** The same summary returned by the customer job list. */
     job: FactoryCustomerJobSummary;
 }
+export interface FactoryCustomerJobFile {
+    /** Authenticated Factory download URL. */
+    download_url: string;
+    /** Submitted file's display name. */
+    file_name: string;
+}
 export interface FactoryCustomerJobSummary {
     /** title:DateTime, format:date-time, description:When the job was created. */
     created_at: string;
@@ -2739,16 +2752,34 @@ export interface FactoryCustomerJobVersion {
     /** title:DateTime, format:date-time, description:When this version was created. */
     created_at: string;
     file_names: string[];
-    /** Identifier of the current version. */
+    /** Submitted input names and authenticated download links. */
+    files: FactoryCustomerJobFile[];
+    /** Identifier of this Factory revision. */
     id: Uuid;
     specs: string;
 }
+export interface FactoryCustomerJobVersionResultsPage {
+    /** list of items on this page of results */
+    items: FactoryCustomerJobVersion[];
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "token used to fetch the next page of results (if any)"
+     * }
+     */
+    next_page?: string;
+}
 export interface FactoryJobResponse {
-    /** nullable:true, description:The current (first) version id of the job. */
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "The newly submitted Factory version id of the job."
+     * }
+     */
     current_version_id?: Uuid;
     /** The stable, customer-facing job id. */
     id: Uuid;
-    /** The initial workflow status (`new`). */
+    /** The workflow status after submission (`new` for creation, `quoting` for a revision). */
     status: string;
 }
 export interface FailureWebSocketResponse {
@@ -2766,7 +2797,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' | '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' | '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 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' | 'hosted_mcp' | 'org_dataset_cloud_projects' | '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' | '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 {
     /**
      * {
@@ -3707,6 +3738,17 @@ export interface KclCodeCompletionRequest {
 export interface KclCodeCompletionResponse {
     completions: string[];
 }
+export interface KclFile {
+    /**
+     * {
+     *   "format": "uint8",
+     *   "minimum": 0
+     * }
+     */
+    contents: number[];
+    /** Where is the file, relative to the project directory? */
+    path: SafeFilepath;
+}
 export interface KclMigrationApplication {
     /**
      * {
@@ -3948,7 +3990,14 @@ export interface KclModel {
     /** The KCL code. */
     code: string;
 }
+export interface KclProject {
+    /** Which file is the entrypoint? This is the first KCL file to be executed, the root of the KCL module tree. */
+    entrypoint: SafeFilepath;
+    /** All files in the project. */
+    files: KclFile[];
+}
 export type KclProjectFileRole = 'project_toml' | 'project_file' | 'preview_image';
+export type KclProjectLibrarySource = 'zds' | 'factory_portal' | 'org_dataset';
 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';
@@ -4126,6 +4175,24 @@ export type MlCopilotClientMessage = {
     /** The source ranges the user suggested to change. If empty, the content (prompt) will be used and is required. */
     source_ranges?: SourceRangePrompt[];
     type: 'user';
+} | {
+    /** Complete isolated input. API binds it to the active conversation; a supplied conversation ID must match that conversation. */
+    request: KclMigrationRequest;
+    type: 'migrate_kcl';
+} | {
+    /**
+     * {
+     *   "format": "uint32",
+     *   "minimum": 0,
+     *   "description": "Last acknowledged revision. Retrying the same change is idempotent."
+     * }
+     */
+    expected_revision: number;
+    /** Migration request ID, independent of the connection and prompt IDs. */
+    operation_id: Uuid;
+    /** Client-reported project state. */
+    status: KclMigrationApplicationStatus;
+    type: 'kcl_migration_application';
 } | {
     /**
      * {
@@ -4306,6 +4373,18 @@ export type MlCopilotServerMessage = {
         /** Whether reconnecting without an external account change can help. */
         retryable: boolean;
     };
+} | {
+    kcl_migration_operation: {
+        /** Durable migration outcome and the source snapshot it was based on. */
+        operation: KclMigrationOperation;
+    };
+} | {
+    kcl_migration_application: {
+        /** Accepted state and revision for subsequent acknowledgements. */
+        application: KclMigrationApplication;
+        /** Migration request ID. */
+        operation_id: Uuid;
+    };
 } | {
     info: {
         /** The informational text. */
@@ -5183,6 +5262,13 @@ export type ModelingCmd = {
     entity_ids: string[];
     /** The file format to export to. */
     format: OutputFormat3d;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "KCL source to embed in formats that support source metadata."
+     * }
+     */
+    kcl_source?: KclProject;
     type: 'export3d';
 } | {
     /**
@@ -5193,6 +5279,13 @@ export type ModelingCmd = {
     entity_ids: string[];
     /** The file format to export to. */
     format: OutputFormat3d;
+    /**
+     * {
+     *   "nullable": true,
+     *   "description": "KCL source to embed in formats that support source metadata."
+     * }
+     */
+    kcl_source?: KclProject;
     type: 'export';
 } | {
     /** format:uuid, description:ID of the entity being queried. */
@@ -6529,6 +6622,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';
@@ -8667,11 +8776,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.
 
@@ -8721,9 +8839,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.
 
@@ -8976,19 +9105,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;
@@ -9025,7 +9154,7 @@ export interface Pong {
 }
 export type PostEffectType = 
 /** Post effect type */
-'phosphor' | 'ssao' | 'noeffect';
+'phosphor' | 'ssao' | 'retrocad' | 'noeffect';
 export interface PrimitiveTopologyFallback {
     /**
      * {
@@ -9083,6 +9212,13 @@ export interface ProjectCategoryResponse {
      */
     sort_order: number;
 }
+export interface ProjectDownloadErrorResponse {
+    error_code?: string;
+    message: string;
+    /** Requested IDs absent from the resolved project version. Present for `InvalidProjectFileSelection`, with duplicate IDs listed once. */
+    missing_file_ids?: Uuid[];
+    request_id: string;
+}
 export interface ProjectEntityToPlane {
     /** Projected points. */
     projected_points: Point3d[];
@@ -9125,6 +9261,8 @@ export interface ProjectLibraryResponse {
     org_id?: Uuid;
     /** Opaque revision token required when renaming or deleting the library. */
     revision: string;
+    /** Application that created the library. Cannot be changed after creation. */
+    source: KclProjectLibrarySource;
     /** 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. */
@@ -9204,6 +9342,8 @@ export interface ProjectResponse {
      * }
      */
     library_id?: Uuid;
+    /** Opaque token for library moves. Send as expected_revision to the library endpoint. Read a fresh value after a save, move, or ownership change; do not parse it. */
+    metadata_revision: string;
     /** Current preview generation state. */
     preview_status: KclProjectPreviewStatus;
     /**
@@ -9219,13 +9359,51 @@ export interface ProjectResponse {
     publication: ProjectPublicationInfoResponse;
     /** Current publication workflow state. */
     publication_status: KclProjectPublicationStatus;
-    /** Opaque revision token for optimistic project mutations. */
+    /** Current content version's revision. Use as expected_revision for content saves. Library moves do not change this value. */
     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;
@@ -9269,6 +9447,8 @@ export interface ProjectSummaryResponse {
      * }
      */
     library_id?: Uuid;
+    /** Opaque token for library moves. Send as expected_revision to the library endpoint. Read a fresh value after a save, move, or ownership change; do not parse it. */
+    metadata_revision: string;
     /** Current preview generation state. */
     preview_status: KclProjectPreviewStatus;
     /**
@@ -9284,11 +9464,17 @@ export interface ProjectSummaryResponse {
     publication: ProjectPublicationInfoResponse;
     /** Current publication workflow state. */
     publication_status: KclProjectPublicationStatus;
-    /** Opaque revision token for optimistic project mutations. */
+    /** Current content version's revision. Use as expected_revision for content saves. Library moves do not change this value. */
     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 {
@@ -9360,6 +9546,11 @@ export interface ProjectVersionSummaryResponseResultsPage {
      */
     next_page?: string;
 }
+export type Projection = {
+    type: 'orthographic';
+} | {
+    type: 'perspective';
+};
 export interface PublicEmailMarketingConsentRequest {
     /** format:email, description:The email */
     email: string;
@@ -9607,6 +9798,9 @@ export interface RtcSessionDescription {
     /** SDP type. */
     type: RtcSdpType;
 }
+export type SafeFilepath = 
+/** Filepath which is guaranteed to be relative and not contain parent directory jumps like '..' */
+string;
 export type SalesInquiryType = 'pilot_inquiry' | 'general_inquiry' | 'sales_question' | 'developer_inquiry' | 'partnership_opportunity' | 'other_sales_inquiry';
 export interface SamlIdentityProvider {
     /** title:String, format:uri, description:The ACS (Assertion Consumer Service) URL. */
@@ -9998,6 +10192,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';
@@ -11024,6 +11219,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 {
     /**
      * {
@@ -11263,6 +11469,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;
@@ -12034,9 +12241,11 @@ export interface Models {
     FactoryCustomerCatalogOption: FactoryCustomerCatalogOption;
     FactoryCustomerCatalogOptionResultsPage: FactoryCustomerCatalogOptionResultsPage;
     FactoryCustomerJobDetail: FactoryCustomerJobDetail;
+    FactoryCustomerJobFile: FactoryCustomerJobFile;
     FactoryCustomerJobSummary: FactoryCustomerJobSummary;
     FactoryCustomerJobSummaryResultsPage: FactoryCustomerJobSummaryResultsPage;
     FactoryCustomerJobVersion: FactoryCustomerJobVersion;
+    FactoryCustomerJobVersionResultsPage: FactoryCustomerJobVersionResultsPage;
     FactoryJobResponse: FactoryJobResponse;
     FailureWebSocketResponse: FailureWebSocketResponse;
     FbxStorage: FbxStorage;
@@ -12078,6 +12287,7 @@ export interface Models {
     KclCodeCompletionParams: KclCodeCompletionParams;
     KclCodeCompletionRequest: KclCodeCompletionRequest;
     KclCodeCompletionResponse: KclCodeCompletionResponse;
+    KclFile: KclFile;
     KclMigrationApplication: KclMigrationApplication;
     KclMigrationApplicationStatus: KclMigrationApplicationStatus;
     KclMigrationClientMessage: KclMigrationClientMessage;
@@ -12090,7 +12300,9 @@ export interface Models {
     KclMigrationTarget: KclMigrationTarget;
     KclMigrationValidation: KclMigrationValidation;
     KclModel: KclModel;
+    KclProject: KclProject;
     KclProjectFileRole: KclProjectFileRole;
+    KclProjectLibrarySource: KclProjectLibrarySource;
     KclProjectPreviewStatus: KclProjectPreviewStatus;
     KclProjectPublicationStatus: KclProjectPublicationStatus;
     KclProjectShareLinkAccessMode: KclProjectShareLinkAccessMode;
@@ -12133,6 +12345,7 @@ export interface Models {
     MouseClick: MouseClick;
     MouseMove: MouseMove;
     MovePathPen: MovePathPen;
+    NamedView: NamedView;
     NewAnnotation: NewAnnotation;
     OAuth2AppClientType: OAuth2AppClientType;
     OAuth2AppGrantType: OAuth2AppGrantType;
@@ -12217,6 +12430,7 @@ export interface Models {
     ProjectAccessScope: ProjectAccessScope;
     ProjectArchiveFormat: ProjectArchiveFormat;
     ProjectCategoryResponse: ProjectCategoryResponse;
+    ProjectDownloadErrorResponse: ProjectDownloadErrorResponse;
     ProjectEntityToPlane: ProjectEntityToPlane;
     ProjectFileResponse: ProjectFileResponse;
     ProjectLibraryResponse: ProjectLibraryResponse;
@@ -12225,6 +12439,8 @@ export interface Models {
     ProjectPointsToPlane: ProjectPointsToPlane;
     ProjectPublicationInfoResponse: ProjectPublicationInfoResponse;
     ProjectResponse: ProjectResponse;
+    ProjectSemanticSearchMatch: ProjectSemanticSearchMatch;
+    ProjectSemanticSearchRequest: ProjectSemanticSearchRequest;
     ProjectShareLinkResponse: ProjectShareLinkResponse;
     ProjectShareLinkResponseResultsPage: ProjectShareLinkResponseResultsPage;
     ProjectSummaryResponse: ProjectSummaryResponse;
@@ -12232,6 +12448,7 @@ export interface Models {
     ProjectVersionDetailResponse: ProjectVersionDetailResponse;
     ProjectVersionSummaryResponse: ProjectVersionSummaryResponse;
     ProjectVersionSummaryResponseResultsPage: ProjectVersionSummaryResponseResultsPage;
+    Projection: Projection;
     PublicEmailMarketingConsentRequest: PublicEmailMarketingConsentRequest;
     PublicMailingListMembershipRequest: PublicMailingListMembershipRequest;
     PublicProjectOwnerResponse: PublicProjectOwnerResponse;
@@ -12255,6 +12472,7 @@ export interface Models {
     RtcIceCandidateInit: RtcIceCandidateInit;
     RtcSdpType: RtcSdpType;
     RtcSessionDescription: RtcSessionDescription;
+    SafeFilepath: SafeFilepath;
     SalesInquiryType: SalesInquiryType;
     SamlIdentityProvider: SamlIdentityProvider;
     SamlIdentityProviderCreate: SamlIdentityProviderCreate;
@@ -12322,6 +12540,7 @@ export interface Models {
     StartPath: StartPath;
     StepImportTargetRepresentation: StepImportTargetRepresentation;
     StepPresentation: StepPresentation;
+    StepSchema: StepSchema;
     StlStorage: StlStorage;
     StorageProvider: StorageProvider;
     SubscriptionActionType: SubscriptionActionType;
@@ -12384,6 +12603,7 @@ export interface Models {
     UpdateOAuth2AppRequest: UpdateOAuth2AppRequest;
     UpdateOrgDataset: UpdateOrgDataset;
     UpdateOrgDatasetSource: UpdateOrgDatasetSource;
+    UpdateProjectLibraryRequest: UpdateProjectLibraryRequest;
     UpdateShortlinkRequest: UpdateShortlinkRequest;
     UpdateUser: UpdateUser;
     UploadOrgDatasetFilesResponse: UploadOrgDatasetFilesResponse;
@@ -12396,6 +12616,7 @@ export interface Models {
     Uuid: Uuid;
     VerificationTokenResponse: VerificationTokenResponse;
     ViewIsometric: ViewIsometric;
+    Visibility: Visibility;
     Volume: Volume;
     WebSocketRequest: WebSocketRequest;
     WebSocketResponse: WebSocketResponse;