@wix/auto_sdk_containers_projects 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,616 @@
+interface Project {
+    /**
+     * Project ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Display name for the project.
+     * @maxLength 200
+     */
+    name?: string;
+    /** Current status of the project. */
+    status?: ProjectStatusWithLiterals;
+    /**
+     * ID of the template used to create this project.
+     * @format GUID
+     * @immutable
+     */
+    templateId?: string | null;
+    /**
+     * ID of the git-code-store project (and backing dev-center app) for this project. Set on creation.
+     * @format GUID
+     * @readonly
+     */
+    codeStoreProjectId?: string | null;
+    /**
+     * The user id of the owner of this project
+     * @format GUID
+     * @readonly
+     */
+    ownerUserId?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Project is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Project was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Project was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Transient lock marking that a sandbox is currently being created for this project.
+     * Used to serialize concurrent dev-machine creation; liveness of the sandbox itself is resolved via ListSandboxes.
+     * @readonly
+     */
+    sandboxStatus?: SandboxStatusWithLiterals;
+    /**
+     * Meta site IDs (MSIDs) of the Wix sites this project is related to.
+     * Optional — a project is not required to be tied to a site; may relate to many sites.
+     * Preserve the deployed input contract; see containers-projects/SDK_COMPATIBILITY.md.
+     * @format GUID
+     */
+    metaSiteIds?: string[];
+    /**
+     * Platform this project targets (iOS/Android). Supplied by the client at creation; immutable after.
+     * @immutable
+     */
+    platform?: PlatformWithLiterals;
+    /**
+     * Optional app icon URL supplied by the client from Wix Media Manager.
+     * @maxLength 2000
+     */
+    appIconUrl?: string | null;
+}
+declare enum ProjectStatus {
+    /** Project created; client (via containers-plans) is doing most of the work. */
+    PLANNING = "PLANNING",
+    /** Generation job created; project moves onward to machine startup. */
+    BUILDING = "BUILDING",
+    /** Plan finalized; project is about to create the initial generation job. */
+    PLAN_READY = "PLAN_READY"
+}
+/** @enumType */
+type ProjectStatusWithLiterals = ProjectStatus | 'PLANNING' | 'BUILDING' | 'PLAN_READY';
+declare enum SandboxStatus {
+    /** No sandbox creation in progress. */
+    NONE = "NONE",
+    /** A caller is currently creating a sandbox for this project (creation lock held). */
+    CREATING = "CREATING"
+}
+/** @enumType */
+type SandboxStatusWithLiterals = SandboxStatus | 'NONE' | 'CREATING';
+declare enum Platform {
+    IOS = "IOS",
+    ANDROID = "ANDROID",
+    /**
+     * Himalaya Mobile (Wix SDUI/OTA content package): mobile apps built headlessly on the
+     * on-demand remote machine via the himi CLI, instead of native iOS/Android pods.
+     */
+    HIMALAYA_MOBILE = "HIMALAYA_MOBILE"
+}
+/** @enumType */
+type PlatformWithLiterals = Platform | 'IOS' | 'ANDROID' | 'HIMALAYA_MOBILE';
+interface ProjectStartRequested {
+    /**
+     * ID of the Project to start.
+     * @format GUID
+     */
+    projectId?: string;
+}
+interface ProjectResumeRequested {
+    /**
+     * ID of the Project to resume.
+     * @format GUID
+     */
+    projectId?: string;
+}
+/**
+ * Emitted when the project transitions PLANNING -> PLAN_READY (on plan finalization). The project
+ * self-consumes this event to start the app generation: mint the agent session, attach it to the
+ * finalized conversation, create the initial generation job, and move to BUILDING. The finalized
+ * plan is read back from containers-plans by project id when the job is built.
+ */
+interface ProjectPlanReady {
+    /**
+     * ID of the Project whose plan is ready.
+     * @format GUID
+     */
+    projectId?: string;
+    /**
+     * ID of the conversation that led to this plan being finalized. The minted agent session id is
+     * attached to this conversation so the build can --resume it. Propagated from PlanFinalized.
+     * @format GUID
+     */
+    conversationId?: string;
+}
+interface CreateAgentSessionRequest {
+    /**
+     * ID of the Project to create an agent session for.
+     * @format GUID
+     */
+    projectId?: string;
+}
+interface CreateAgentSessionResponse {
+    /**
+     * Agent session ID materialized for the Project.
+     * @format GUID
+     */
+    agentSessionId?: string;
+}
+interface RefreshAgentSiteTokenRequest {
+    /**
+     * ID of the Project whose owner site token should be re-minted.
+     * @format GUID
+     */
+    projectId?: string;
+}
+interface RefreshAgentSiteTokenResponse {
+    /**
+     * A freshly minted site-scoped access token for the project owner. Sensitive credential material:
+     * marked pii so the platform redacts it from request/response logging (never log it in app code either).
+     * maxLength matches the sibling containers-project-versions token fields (4096) — ample for the
+     * oauth2-ng user access token, and required by the string-validation standard.
+     * @maxLength 4096
+     */
+    accessToken?: string;
+    /** Seconds until the returned token expires, as reported by oauth2-ng. */
+    expiresIn?: string;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+interface CreateProjectRequest {
+    /** Project to be created. */
+    project: Project;
+}
+interface CreateProjectResponse {
+    /** The created Project. */
+    project?: Project;
+}
+interface GetProjectRequest {
+    /**
+     * ID of the Project to retrieve.
+     * @format GUID
+     */
+    projectId: string;
+}
+interface GetProjectResponse {
+    /** The requested Project. */
+    project?: Project;
+}
+interface UpdateProjectRequest {
+    /** Project to be updated, may be partial. */
+    project: Project;
+}
+interface UpdateProjectResponse {
+    /** Updated Project. */
+    project?: Project;
+}
+interface DeleteProjectRequest {
+    /**
+     * Id of the Project to delete.
+     * @format GUID
+     */
+    projectId: string;
+}
+interface DeleteProjectResponse {
+}
+interface StartProjectRequest {
+    /**
+     * ID of the Project to start.
+     * @format GUID
+     */
+    projectId?: string;
+}
+interface StartProjectResponse {
+    /** The Project for which start was requested. */
+    project?: Project;
+}
+interface ResumeProjectRequest {
+    /**
+     * ID of the Project to resume.
+     * @format GUID
+     */
+    projectId: string;
+}
+interface ResumeProjectResponse {
+    /** The Project for which resume was requested. */
+    project?: Project;
+}
+interface RegenerateProjectNameRequest {
+    /**
+     * ID of the Project to generate a new name for.
+     * @format GUID
+     */
+    projectId: string;
+    /**
+     * The user's free-text renaming instruction, passed to the name-generation prompt.
+     * @maxLength 4000
+     */
+    prompt: string;
+}
+interface RegenerateProjectNameResponse {
+    /**
+     * The generated display name, at most 30 characters. Not persisted.
+     * @maxLength 30
+     */
+    name?: string;
+}
+interface RegenerateProjectIconRequest {
+    /**
+     * ID of the Project to generate a new icon for.
+     * @format GUID
+     */
+    projectId: string;
+    /**
+     * The user's free-text icon instruction, passed to the icon-generation prompt.
+     * @maxLength 4000
+     */
+    prompt: string;
+}
+interface RegenerateProjectIconResponse {
+    /**
+     * The generated icon URL. Not persisted.
+     * @format WEB_URL
+     */
+    iconUrl?: string;
+}
+interface ListProjectsForCurrentUserRequest {
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface ListProjectsForCurrentUserResponse {
+    /** Projects owned by the current user. */
+    projects?: Project[];
+    /** Paging metadata for cursor-based pagination. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface SaveProjectDesignRequest {
+    /**
+     * Project whose design is being saved. The caller must own it.
+     * @format GUID
+     */
+    projectId: string;
+    /**
+     * The Himalaya release ID currently displayed by the client. The saved draft branches from
+     * exactly this release, even when a newer release exists for the app.
+     * @maxLength 100
+     */
+    baseReleaseId: string;
+    /**
+     * The complete edited design-token document, as a JSON object string — not a flattened set of
+     * preview overrides. The caller is responsible for preserving unknown groups and light/dark
+     * values it did not change.
+     * @maxLength 65536
+     */
+    tokensJson: string;
+    /**
+     * Short-lived, app-scoped Himalaya control credential the client obtained from Himalaya's owner
+     * embed-token endpoint. Forwarded to Himalaya for this call only — never logged, persisted, or
+     * echoed back in any response, error, or event.
+     *
+     * The app this call writes to is NOT taken from this request. It is composed from the owner
+     * prefix this credential carries plus project_id; see HimalayaAppSlug.
+     * @maxLength 4096
+     */
+    himalayaControlToken: string;
+}
+interface SaveProjectDesignResponse {
+    /**
+     * The saved draft release. Always a draft, so the app's live release is untouched.
+     * @maxLength 100
+     */
+    himalayaReleaseId?: string;
+    /**
+     * Short-lived credential for previewing the saved draft release. Response-only: never persisted
+     * or placed in a preview URL by this service.
+     * @maxLength 4096
+     */
+    previewToken?: string;
+    /** When preview_token expires. */
+    previewTokenExpiresAt?: Date | null;
+}
+interface ListProjectsRequest {
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+}
+interface ListProjectsResponse {
+    /** Projects in the current site. */
+    projects?: Project[];
+    /** Paging metadata for cursor-based pagination. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface UpdateProject {
+    /**
+     * Project ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Display name for the project.
+     * @maxLength 200
+     */
+    name?: string;
+    /** Current status of the project. */
+    status?: ProjectStatusWithLiterals;
+    /**
+     * ID of the template used to create this project.
+     * @format GUID
+     * @immutable
+     */
+    templateId?: string | null;
+    /**
+     * ID of the git-code-store project (and backing dev-center app) for this project. Set on creation.
+     * @format GUID
+     * @readonly
+     */
+    codeStoreProjectId?: string | null;
+    /**
+     * The user id of the owner of this project
+     * @format GUID
+     * @readonly
+     */
+    ownerUserId?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Project is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Project was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Project was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Transient lock marking that a sandbox is currently being created for this project.
+     * Used to serialize concurrent dev-machine creation; liveness of the sandbox itself is resolved via ListSandboxes.
+     * @readonly
+     */
+    sandboxStatus?: SandboxStatusWithLiterals;
+    /**
+     * Meta site IDs (MSIDs) of the Wix sites this project is related to.
+     * Optional — a project is not required to be tied to a site; may relate to many sites.
+     * Preserve the deployed input contract; see containers-projects/SDK_COMPATIBILITY.md.
+     * @format GUID
+     */
+    metaSiteIds?: string[];
+    /**
+     * Platform this project targets (iOS/Android). Supplied by the client at creation; immutable after.
+     * @immutable
+     */
+    platform?: PlatformWithLiterals;
+    /**
+     * Optional app icon URL supplied by the client from Wix Media Manager.
+     * @maxLength 2000
+     */
+    appIconUrl?: string | null;
+}
+interface SaveProjectDesignOptions {
+    /**
+     * The complete edited design-token document, as a JSON object string — not a flattened set of
+     * preview overrides. The caller is responsible for preserving unknown groups and light/dark
+     * values it did not change.
+     * @maxLength 65536
+     */
+    tokensJson: string;
+    /**
+     * Short-lived, app-scoped Himalaya control credential the client obtained from Himalaya's owner
+     * embed-token endpoint. Forwarded to Himalaya for this call only — never logged, persisted, or
+     * echoed back in any response, error, or event.
+     *
+     * The app this call writes to is NOT taken from this request. It is composed from the owner
+     * prefix this credential carries plus project_id; see HimalayaAppSlug.
+     * @maxLength 4096
+     */
+    himalayaControlToken: string;
+}
+interface ListProjectsOptions {
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+}
+
+export { type AccountInfo, type ActionEvent, type CreateAgentSessionRequest, type CreateAgentSessionResponse, type CreateProjectRequest, type CreateProjectResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DeleteProjectRequest, type DeleteProjectResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetProjectRequest, type GetProjectResponse, type IdentificationData, type IdentificationDataIdOneOf, type ListProjectsForCurrentUserRequest, type ListProjectsForCurrentUserResponse, type ListProjectsOptions, type ListProjectsRequest, type ListProjectsResponse, type MessageEnvelope, Platform, type PlatformWithLiterals, type Project, type ProjectPlanReady, type ProjectResumeRequested, type ProjectStartRequested, ProjectStatus, type ProjectStatusWithLiterals, type RefreshAgentSiteTokenRequest, type RefreshAgentSiteTokenResponse, type RegenerateProjectIconRequest, type RegenerateProjectIconResponse, type RegenerateProjectNameRequest, type RegenerateProjectNameResponse, type RestoreInfo, type ResumeProjectRequest, type ResumeProjectResponse, SandboxStatus, type SandboxStatusWithLiterals, type SaveProjectDesignOptions, type SaveProjectDesignRequest, type SaveProjectDesignResponse, type StartProjectRequest, type StartProjectResponse, type UpdateProject, type UpdateProjectRequest, type UpdateProjectResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals };