@wix/auto_sdk_containers_projects 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1,740 @@
1
- export { AccountInfo, ActionEvent, CreateAgentSessionRequest, CreateAgentSessionResponse, CreateProjectRequest, CreateProjectResponse, CursorPaging, CursorPagingMetadata, Cursors, DeleteProjectRequest, DeleteProjectResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetProjectRequest, GetProjectResponse, IdentificationData, IdentificationDataIdOneOf, ListProjectsForCurrentUserRequest, ListProjectsForCurrentUserResponse, ListProjectsOptions, ListProjectsRequest, ListProjectsResponse, MessageEnvelope, Platform, PlatformWithLiterals, Project, ProjectPlanReady, ProjectResumeRequested, ProjectStartRequested, ProjectStatus, ProjectStatusWithLiterals, RefreshAgentSiteTokenRequest, RefreshAgentSiteTokenResponse, RegenerateProjectIconRequest, RegenerateProjectIconResponse, RegenerateProjectNameRequest, RegenerateProjectNameResponse, RestoreInfo, ResumeProjectRequest, ResumeProjectResponse, SandboxStatus, SandboxStatusWithLiterals, SaveProjectDesignOptions, SaveProjectDesignRequest, SaveProjectDesignResponse, StartProjectRequest, StartProjectResponse, UpdateProject, UpdateProjectRequest, UpdateProjectResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.js';
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
3
+ interface Project {
4
+ /**
5
+ * Project ID.
6
+ * @format GUID
7
+ * @readonly
8
+ */
9
+ _id?: string | null;
10
+ /**
11
+ * Display name for the project.
12
+ * @maxLength 200
13
+ */
14
+ name?: string;
15
+ /** Current status of the project. */
16
+ status?: ProjectStatusWithLiterals;
17
+ /**
18
+ * ID of the template used to create this project.
19
+ * @format GUID
20
+ * @immutable
21
+ */
22
+ templateId?: string | null;
23
+ /**
24
+ * ID of the git-code-store project (and backing dev-center app) for this project. Set on creation.
25
+ * @format GUID
26
+ * @readonly
27
+ */
28
+ codeStoreProjectId?: string | null;
29
+ /**
30
+ * The user id of the owner of this project
31
+ * @format GUID
32
+ * @readonly
33
+ */
34
+ ownerUserId?: string | null;
35
+ /**
36
+ * Revision number, which increments by 1 each time the Project is updated.
37
+ * @readonly
38
+ */
39
+ revision?: string | null;
40
+ /**
41
+ * Date and time the Project was created.
42
+ * @readonly
43
+ */
44
+ _createdDate?: Date | null;
45
+ /**
46
+ * Date and time the Project was last updated.
47
+ * @readonly
48
+ */
49
+ _updatedDate?: Date | null;
50
+ /**
51
+ * Transient lock marking that a sandbox is currently being created for this project.
52
+ * Used to serialize concurrent dev-machine creation; liveness of the sandbox itself is resolved via ListSandboxes.
53
+ * @readonly
54
+ */
55
+ sandboxStatus?: SandboxStatusWithLiterals;
56
+ /**
57
+ * Meta site IDs (MSIDs) of the Wix sites this project is related to.
58
+ * Optional — a project is not required to be tied to a site; may relate to many sites.
59
+ * Preserve the deployed input contract; see containers-projects/SDK_COMPATIBILITY.md.
60
+ * @format GUID
61
+ */
62
+ metaSiteIds?: string[];
63
+ /**
64
+ * Platform this project targets (iOS/Android). Supplied by the client at creation; immutable after.
65
+ * @immutable
66
+ */
67
+ platform?: PlatformWithLiterals;
68
+ /**
69
+ * Optional app icon URL supplied by the client from Wix Media Manager.
70
+ * @maxLength 2000
71
+ */
72
+ appIconUrl?: string | null;
73
+ }
74
+ declare enum ProjectStatus {
75
+ /** Project created; client (via containers-plans) is doing most of the work. */
76
+ PLANNING = "PLANNING",
77
+ /** Generation job created; project moves onward to machine startup. */
78
+ BUILDING = "BUILDING",
79
+ /** Plan finalized; project is about to create the initial generation job. */
80
+ PLAN_READY = "PLAN_READY"
81
+ }
82
+ /** @enumType */
83
+ type ProjectStatusWithLiterals = ProjectStatus | 'PLANNING' | 'BUILDING' | 'PLAN_READY';
84
+ declare enum SandboxStatus {
85
+ /** No sandbox creation in progress. */
86
+ NONE = "NONE",
87
+ /** A caller is currently creating a sandbox for this project (creation lock held). */
88
+ CREATING = "CREATING"
89
+ }
90
+ /** @enumType */
91
+ type SandboxStatusWithLiterals = SandboxStatus | 'NONE' | 'CREATING';
92
+ declare enum Platform {
93
+ IOS = "IOS",
94
+ ANDROID = "ANDROID",
95
+ /**
96
+ * Himalaya Mobile (Wix SDUI/OTA content package): mobile apps built headlessly on the
97
+ * on-demand remote machine via the himi CLI, instead of native iOS/Android pods.
98
+ */
99
+ HIMALAYA_MOBILE = "HIMALAYA_MOBILE"
100
+ }
101
+ /** @enumType */
102
+ type PlatformWithLiterals = Platform | 'IOS' | 'ANDROID' | 'HIMALAYA_MOBILE';
103
+ interface ProjectStartRequested {
104
+ /**
105
+ * ID of the Project to start.
106
+ * @format GUID
107
+ */
108
+ projectId?: string;
109
+ }
110
+ interface ProjectResumeRequested {
111
+ /**
112
+ * ID of the Project to resume.
113
+ * @format GUID
114
+ */
115
+ projectId?: string;
116
+ }
117
+ /**
118
+ * Emitted when the project transitions PLANNING -> PLAN_READY (on plan finalization). The project
119
+ * self-consumes this event to start the app generation: mint the agent session, attach it to the
120
+ * finalized conversation, create the initial generation job, and move to BUILDING. The finalized
121
+ * plan is read back from containers-plans by project id when the job is built.
122
+ */
123
+ interface ProjectPlanReady {
124
+ /**
125
+ * ID of the Project whose plan is ready.
126
+ * @format GUID
127
+ */
128
+ projectId?: string;
129
+ /**
130
+ * ID of the conversation that led to this plan being finalized. The minted agent session id is
131
+ * attached to this conversation so the build can --resume it. Propagated from PlanFinalized.
132
+ * @format GUID
133
+ */
134
+ conversationId?: string;
135
+ }
136
+ interface CreateAgentSessionRequest {
137
+ /**
138
+ * ID of the Project to create an agent session for.
139
+ * @format GUID
140
+ */
141
+ projectId?: string;
142
+ }
143
+ interface CreateAgentSessionResponse {
144
+ /**
145
+ * Agent session ID materialized for the Project.
146
+ * @format GUID
147
+ */
148
+ agentSessionId?: string;
149
+ }
150
+ interface RefreshAgentSiteTokenRequest {
151
+ /**
152
+ * Exact project/job tuple whose initiating user's site token should be re-minted.
153
+ * @format GUID
154
+ */
155
+ projectId?: string;
156
+ /**
157
+ * Job whose persisted initiating user and MetaSite provenance must be revalidated.
158
+ * @format GUID
159
+ */
160
+ jobId?: string;
161
+ }
162
+ interface RefreshAgentSiteTokenResponse {
163
+ /**
164
+ * A freshly minted site-scoped access token for the project owner. Sensitive credential material:
165
+ * marked pii so the platform redacts it from request/response logging (never log it in app code either).
166
+ * maxLength matches the sibling containers-project-versions token fields (4096) — ample for the
167
+ * oauth2-ng user access token, and required by the string-validation standard.
168
+ * @maxLength 4096
169
+ */
170
+ accessToken?: string;
171
+ /** Seconds until the returned token expires, as reported by oauth2-ng. */
172
+ expiresIn?: string;
173
+ /** Version of the job-bound authorization response contract. */
174
+ authorizationVersion?: number;
175
+ /**
176
+ * The project authorized by this refresh.
177
+ * @format GUID
178
+ */
179
+ projectId?: string;
180
+ /**
181
+ * The job authorized by this refresh.
182
+ * @format GUID
183
+ */
184
+ jobId?: string;
185
+ /**
186
+ * Trusted MetaSite captured when the job was created.
187
+ * @format GUID
188
+ */
189
+ metaSiteId?: string;
190
+ /**
191
+ * Trusted dashboard USER captured when the job was created.
192
+ * @format GUID
193
+ */
194
+ initiatingUserId?: string;
195
+ }
196
+ interface DomainEvent extends DomainEventBodyOneOf {
197
+ createdEvent?: EntityCreatedEvent;
198
+ updatedEvent?: EntityUpdatedEvent;
199
+ deletedEvent?: EntityDeletedEvent;
200
+ actionEvent?: ActionEvent;
201
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
202
+ _id?: string;
203
+ /**
204
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
205
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
206
+ */
207
+ entityFqdn?: string;
208
+ /**
209
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
210
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
211
+ */
212
+ slug?: string;
213
+ /** ID of the entity associated with the event. */
214
+ entityId?: string;
215
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
216
+ eventTime?: Date | null;
217
+ /**
218
+ * Whether the event was triggered as a result of a privacy regulation application
219
+ * (for example, GDPR).
220
+ */
221
+ triggeredByAnonymizeRequest?: boolean | null;
222
+ /** If present, indicates the action that triggered the event. */
223
+ originatedFrom?: string | null;
224
+ /**
225
+ * 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.
226
+ * 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.
227
+ */
228
+ entityEventSequence?: string | null;
229
+ }
230
+ /** @oneof */
231
+ interface DomainEventBodyOneOf {
232
+ createdEvent?: EntityCreatedEvent;
233
+ updatedEvent?: EntityUpdatedEvent;
234
+ deletedEvent?: EntityDeletedEvent;
235
+ actionEvent?: ActionEvent;
236
+ }
237
+ interface EntityCreatedEvent {
238
+ entity?: string;
239
+ }
240
+ interface RestoreInfo {
241
+ deletedDate?: Date | null;
242
+ }
243
+ interface EntityUpdatedEvent {
244
+ /**
245
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
246
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
247
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
248
+ */
249
+ currentEntity?: string;
250
+ }
251
+ interface EntityDeletedEvent {
252
+ /** Entity that was deleted. */
253
+ deletedEntity?: string | null;
254
+ }
255
+ interface ActionEvent {
256
+ body?: string;
257
+ }
258
+ interface MessageEnvelope {
259
+ /**
260
+ * App instance ID.
261
+ * @format GUID
262
+ */
263
+ instanceId?: string | null;
264
+ /**
265
+ * Event type.
266
+ * @maxLength 150
267
+ */
268
+ eventType?: string;
269
+ /** The identification type and identity data. */
270
+ identity?: IdentificationData;
271
+ /** Stringify payload. */
272
+ data?: string;
273
+ /** Details related to the account */
274
+ accountInfo?: AccountInfo;
275
+ }
276
+ interface IdentificationData extends IdentificationDataIdOneOf {
277
+ /**
278
+ * ID of a site visitor that has not logged in to the site.
279
+ * @format GUID
280
+ */
281
+ anonymousVisitorId?: string;
282
+ /**
283
+ * ID of a site visitor that has logged in to the site.
284
+ * @format GUID
285
+ */
286
+ memberId?: string;
287
+ /**
288
+ * ID of a Wix user (site owner, contributor, etc.).
289
+ * @format GUID
290
+ */
291
+ wixUserId?: string;
292
+ /**
293
+ * ID of an app.
294
+ * @format GUID
295
+ */
296
+ appId?: string;
297
+ /** @readonly */
298
+ identityType?: WebhookIdentityTypeWithLiterals;
299
+ }
300
+ /** @oneof */
301
+ interface IdentificationDataIdOneOf {
302
+ /**
303
+ * ID of a site visitor that has not logged in to the site.
304
+ * @format GUID
305
+ */
306
+ anonymousVisitorId?: string;
307
+ /**
308
+ * ID of a site visitor that has logged in to the site.
309
+ * @format GUID
310
+ */
311
+ memberId?: string;
312
+ /**
313
+ * ID of a Wix user (site owner, contributor, etc.).
314
+ * @format GUID
315
+ */
316
+ wixUserId?: string;
317
+ /**
318
+ * ID of an app.
319
+ * @format GUID
320
+ */
321
+ appId?: string;
322
+ }
323
+ declare enum WebhookIdentityType {
324
+ UNKNOWN = "UNKNOWN",
325
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
326
+ MEMBER = "MEMBER",
327
+ WIX_USER = "WIX_USER",
328
+ APP = "APP"
329
+ }
330
+ /** @enumType */
331
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
332
+ interface AccountInfo {
333
+ /**
334
+ * ID of the Wix account associated with the event.
335
+ * @format GUID
336
+ */
337
+ accountId?: string | null;
338
+ /**
339
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
340
+ * @format GUID
341
+ */
342
+ parentAccountId?: string | null;
343
+ /**
344
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
345
+ * @format GUID
346
+ */
347
+ siteId?: string | null;
348
+ }
349
+ interface CreateProjectRequest {
350
+ /** Project to be created. */
351
+ project: Project;
352
+ }
353
+ interface CreateProjectResponse {
354
+ /** The created Project. */
355
+ project?: Project;
356
+ }
357
+ interface GetProjectRequest {
358
+ /**
359
+ * ID of the Project to retrieve.
360
+ * @format GUID
361
+ */
362
+ projectId: string;
363
+ }
364
+ interface GetProjectResponse {
365
+ /** The requested Project. */
366
+ project?: Project;
367
+ }
368
+ interface UpdateProjectRequest {
369
+ /** Project to be updated, may be partial. */
370
+ project: Project;
371
+ }
372
+ interface UpdateProjectResponse {
373
+ /** Updated Project. */
374
+ project?: Project;
375
+ }
376
+ interface DeleteProjectRequest {
377
+ /**
378
+ * Id of the Project to delete.
379
+ * @format GUID
380
+ */
381
+ projectId: string;
382
+ }
383
+ interface DeleteProjectResponse {
384
+ }
385
+ interface StartProjectRequest {
386
+ /**
387
+ * ID of the Project to start.
388
+ * @format GUID
389
+ */
390
+ projectId?: string;
391
+ }
392
+ interface StartProjectResponse {
393
+ /** The Project for which start was requested. */
394
+ project?: Project;
395
+ }
396
+ interface ResumeProjectRequest {
397
+ /**
398
+ * ID of the Project to resume.
399
+ * @format GUID
400
+ */
401
+ projectId: string;
402
+ }
403
+ interface ResumeProjectResponse {
404
+ /** The Project for which resume was requested. */
405
+ project?: Project;
406
+ }
407
+ interface RegenerateProjectNameRequest {
408
+ /**
409
+ * ID of the Project to generate a new name for.
410
+ * @format GUID
411
+ */
412
+ projectId: string;
413
+ /**
414
+ * The user's free-text renaming instruction, passed to the name-generation prompt.
415
+ * @maxLength 4000
416
+ */
417
+ prompt: string;
418
+ }
419
+ interface RegenerateProjectNameResponse {
420
+ /**
421
+ * The generated display name, at most 30 characters. Not persisted.
422
+ * @maxLength 30
423
+ */
424
+ name?: string;
425
+ }
426
+ interface RegenerateProjectIconRequest {
427
+ /**
428
+ * ID of the Project to generate a new icon for.
429
+ * @format GUID
430
+ */
431
+ projectId: string;
432
+ /**
433
+ * The user's free-text icon instruction, passed to the icon-generation prompt.
434
+ * @maxLength 4000
435
+ */
436
+ prompt: string;
437
+ }
438
+ interface RegenerateProjectIconResponse {
439
+ /**
440
+ * The generated icon URL. Not persisted.
441
+ * @format WEB_URL
442
+ */
443
+ iconUrl?: string;
444
+ }
445
+ interface ListProjectsForCurrentUserRequest {
446
+ /** Cursor paging options. */
447
+ paging?: CursorPaging;
448
+ }
449
+ interface CursorPaging {
450
+ /**
451
+ * Maximum number of items to return in the results.
452
+ * @max 100
453
+ */
454
+ limit?: number | null;
455
+ /**
456
+ * Pointer to the next or previous page in the list of results.
457
+ *
458
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
459
+ * Not relevant for the first request.
460
+ * @maxLength 16000
461
+ */
462
+ cursor?: string | null;
463
+ }
464
+ interface ListProjectsForCurrentUserResponse {
465
+ /** Projects owned by the current user. */
466
+ projects?: Project[];
467
+ /** Paging metadata for cursor-based pagination. */
468
+ pagingMetadata?: CursorPagingMetadata;
469
+ }
470
+ interface CursorPagingMetadata {
471
+ /** Number of items returned in current page. */
472
+ count?: number | null;
473
+ /** Cursor strings that point to the next page, previous page, or both. */
474
+ cursors?: Cursors;
475
+ /**
476
+ * Whether there are more pages to retrieve following the current page.
477
+ *
478
+ * + `true`: Another page of results can be retrieved.
479
+ * + `false`: This is the last page.
480
+ */
481
+ hasNext?: boolean | null;
482
+ }
483
+ interface Cursors {
484
+ /**
485
+ * Cursor string pointing to the next page in the list of results.
486
+ * @maxLength 16000
487
+ */
488
+ next?: string | null;
489
+ /**
490
+ * Cursor pointing to the previous page in the list of results.
491
+ * @maxLength 16000
492
+ */
493
+ prev?: string | null;
494
+ }
495
+ interface SaveProjectDesignRequest {
496
+ /**
497
+ * Project whose design is being saved. The caller must own it.
498
+ * @format GUID
499
+ */
500
+ projectId: string;
501
+ /**
502
+ * The Himalaya release ID currently displayed by the client. The saved draft branches from
503
+ * exactly this release, even when a newer release exists for the app.
504
+ * @maxLength 100
505
+ */
506
+ baseReleaseId: string;
507
+ /**
508
+ * The complete edited design-token document, as a JSON object string — not a flattened set of
509
+ * preview overrides. The caller is responsible for preserving unknown groups and light/dark
510
+ * values it did not change.
511
+ * @maxLength 65536
512
+ */
513
+ tokensJson: string;
514
+ /**
515
+ * Short-lived, app-scoped Himalaya control credential the client obtained from Himalaya's owner
516
+ * embed-token endpoint. Forwarded to Himalaya for this call only — never logged, persisted, or
517
+ * echoed back in any response, error, or event.
518
+ *
519
+ * The app this call writes to is NOT taken from this request. It is composed from the owner
520
+ * prefix this credential carries plus project_id; see HimalayaAppSlug.
521
+ * @maxLength 4096
522
+ */
523
+ himalayaControlToken: string;
524
+ /**
525
+ * Client assertion of the canonical app returned by authenticated Himalaya lookup. Catalyst
526
+ * resolves and validates the same value; it is never used as an unchecked write target.
527
+ * @maxLength 200
528
+ */
529
+ canonicalApp?: string;
530
+ }
531
+ interface SaveProjectDesignResponse {
532
+ /**
533
+ * The saved draft release. Always a draft, so the app's live release is untouched.
534
+ * @maxLength 100
535
+ */
536
+ himalayaReleaseId?: string;
537
+ /**
538
+ * Short-lived credential for previewing the saved draft release. Response-only: never persisted
539
+ * or placed in a preview URL by this service.
540
+ * @maxLength 4096
541
+ */
542
+ previewToken?: string;
543
+ /** When preview_token expires. */
544
+ previewTokenExpiresAt?: Date | null;
545
+ }
546
+ interface ListProjectsRequest {
547
+ /** Cursor paging options. */
548
+ paging?: CursorPaging;
549
+ }
550
+ interface ListProjectsResponse {
551
+ /** Projects in the current site. */
552
+ projects?: Project[];
553
+ /** Paging metadata for cursor-based pagination. */
554
+ pagingMetadata?: CursorPagingMetadata;
555
+ }
556
+ interface GetHimalayaAuthorizationRequest {
557
+ /**
558
+ * Site-tenanted Containers project being authorized.
559
+ * @format GUID
560
+ */
561
+ projectId: string;
562
+ }
563
+ interface GetHimalayaAuthorizationResponse {
564
+ /** Version of the authorization capability contract. */
565
+ authorizationVersion?: number;
566
+ /**
567
+ * Trusted MetaSite selected from request identity context.
568
+ * @format GUID
569
+ */
570
+ metaSiteId?: string;
571
+ /**
572
+ * Site-tenanted Containers project authorized by the lookup.
573
+ * @format GUID
574
+ */
575
+ projectId?: string;
576
+ /**
577
+ * Verified canonical Himalaya app slug.
578
+ * @maxLength 200
579
+ */
580
+ canonicalApp?: string;
581
+ /** Whether a fresh worker launch is currently authorized. */
582
+ workerLaunch?: boolean;
583
+ /** Whether a fresh design save is currently authorized. */
584
+ saveDesign?: boolean;
585
+ }
586
+ /**
587
+ * Retrieves a Project by ID.
588
+ * @param projectId - ID of the Project to retrieve.
589
+ * @public
590
+ * @documentationMaturity preview
591
+ * @requiredField projectId
592
+ * @permissionId containers:projects:v1:project:get_project
593
+ * @returns The requested Project.
594
+ * @fqn wix.containers.projects.v1.ContainersProjects.GetProject
595
+ */
596
+ declare function getProject(projectId: string): Promise<NonNullablePaths<Project, `name` | `status` | `sandboxStatus` | `metaSiteIds` | `platform`, 0>>;
597
+ interface UpdateProject {
598
+ /**
599
+ * Project ID.
600
+ * @format GUID
601
+ * @readonly
602
+ */
603
+ _id?: string | null;
604
+ /**
605
+ * Display name for the project.
606
+ * @maxLength 200
607
+ */
608
+ name?: string;
609
+ /** Current status of the project. */
610
+ status?: ProjectStatusWithLiterals;
611
+ /**
612
+ * ID of the template used to create this project.
613
+ * @format GUID
614
+ * @immutable
615
+ */
616
+ templateId?: string | null;
617
+ /**
618
+ * ID of the git-code-store project (and backing dev-center app) for this project. Set on creation.
619
+ * @format GUID
620
+ * @readonly
621
+ */
622
+ codeStoreProjectId?: string | null;
623
+ /**
624
+ * The user id of the owner of this project
625
+ * @format GUID
626
+ * @readonly
627
+ */
628
+ ownerUserId?: string | null;
629
+ /**
630
+ * Revision number, which increments by 1 each time the Project is updated.
631
+ * @readonly
632
+ */
633
+ revision?: string | null;
634
+ /**
635
+ * Date and time the Project was created.
636
+ * @readonly
637
+ */
638
+ _createdDate?: Date | null;
639
+ /**
640
+ * Date and time the Project was last updated.
641
+ * @readonly
642
+ */
643
+ _updatedDate?: Date | null;
644
+ /**
645
+ * Transient lock marking that a sandbox is currently being created for this project.
646
+ * Used to serialize concurrent dev-machine creation; liveness of the sandbox itself is resolved via ListSandboxes.
647
+ * @readonly
648
+ */
649
+ sandboxStatus?: SandboxStatusWithLiterals;
650
+ /**
651
+ * Meta site IDs (MSIDs) of the Wix sites this project is related to.
652
+ * Optional — a project is not required to be tied to a site; may relate to many sites.
653
+ * Preserve the deployed input contract; see containers-projects/SDK_COMPATIBILITY.md.
654
+ * @format GUID
655
+ */
656
+ metaSiteIds?: string[];
657
+ /**
658
+ * Platform this project targets (iOS/Android). Supplied by the client at creation; immutable after.
659
+ * @immutable
660
+ */
661
+ platform?: PlatformWithLiterals;
662
+ /**
663
+ * Optional app icon URL supplied by the client from Wix Media Manager.
664
+ * @maxLength 2000
665
+ */
666
+ appIconUrl?: string | null;
667
+ }
668
+ /**
669
+ * Requests Project resume by starting or reusing its configured remote machine asynchronously.
670
+ * @param projectId - ID of the Project to resume.
671
+ * @public
672
+ * @documentationMaturity preview
673
+ * @requiredField projectId
674
+ * @permissionId containers:projects:v1:project:resume_project
675
+ * @fqn wix.containers.projects.v1.ContainersProjects.ResumeProject
676
+ */
677
+ declare function resumeProject(projectId: string): Promise<NonNullablePaths<ResumeProjectResponse, `project.name` | `project.status` | `project.sandboxStatus` | `project.metaSiteIds` | `project.platform`, 1>>;
678
+ /**
679
+ * Persists a complete design-token document as a new Himalaya draft release, branched from the
680
+ * release the client currently has displayed.
681
+ *
682
+ * Synchronous: the Himalaya write completes before this call returns. Never touches the project's
683
+ * sandbox, runs a build, or activates the app — the saved release stays a draft, so what the live
684
+ * app serves is unaffected. Persists nothing on our side: this creates no entity and posts no
685
+ * chat checkpoint.
686
+ * @param projectId - Project whose design is being saved. The caller must own it.
687
+ * @param baseReleaseId - The Himalaya release ID currently displayed by the client. The saved draft branches from
688
+ * exactly this release, even when a newer release exists for the app.
689
+ * @public
690
+ * @documentationMaturity preview
691
+ * @requiredField baseReleaseId
692
+ * @requiredField options.himalayaControlToken
693
+ * @requiredField options.tokensJson
694
+ * @requiredField projectId
695
+ * @permissionId containers:projects:v1:project:save_project_design
696
+ * @fqn wix.containers.projects.v1.ContainersProjects.SaveProjectDesign
697
+ */
698
+ declare function saveProjectDesign(projectId: string, baseReleaseId: string, options?: NonNullablePaths<SaveProjectDesignOptions, `himalayaControlToken` | `tokensJson`, 0>): Promise<NonNullablePaths<SaveProjectDesignResponse, `himalayaReleaseId` | `previewToken`, 0>>;
699
+ interface SaveProjectDesignOptions {
700
+ /**
701
+ * The complete edited design-token document, as a JSON object string — not a flattened set of
702
+ * preview overrides. The caller is responsible for preserving unknown groups and light/dark
703
+ * values it did not change.
704
+ * @maxLength 65536
705
+ */
706
+ tokensJson: string;
707
+ /**
708
+ * Short-lived, app-scoped Himalaya control credential the client obtained from Himalaya's owner
709
+ * embed-token endpoint. Forwarded to Himalaya for this call only — never logged, persisted, or
710
+ * echoed back in any response, error, or event.
711
+ *
712
+ * The app this call writes to is NOT taken from this request. It is composed from the owner
713
+ * prefix this credential carries plus project_id; see HimalayaAppSlug.
714
+ * @maxLength 4096
715
+ */
716
+ himalayaControlToken: string;
717
+ /**
718
+ * Client assertion of the canonical app returned by authenticated Himalaya lookup. Catalyst
719
+ * resolves and validates the same value; it is never used as an unchecked write target.
720
+ * @maxLength 200
721
+ */
722
+ canonicalApp?: string;
723
+ }
724
+ interface ListProjectsOptions {
725
+ /** Cursor paging options. */
726
+ paging?: CursorPaging;
727
+ }
728
+ /**
729
+ * Repeats authenticated Himalaya authorization for the current collaborator. This response is
730
+ * a capability check only; every worker/design mutation performs a fresh check.
731
+ * @param projectId - Site-tenanted Containers project being authorized.
732
+ * @public
733
+ * @documentationMaturity preview
734
+ * @requiredField projectId
735
+ * @permissionId containers:projects:v1:project:get_himalaya_authorization
736
+ * @fqn wix.containers.projects.v1.ContainersProjects.GetHimalayaAuthorization
737
+ */
738
+ declare function getHimalayaAuthorization(projectId: string): Promise<NonNullablePaths<GetHimalayaAuthorizationResponse, `authorizationVersion` | `metaSiteId` | `projectId` | `canonicalApp` | `workerLaunch` | `saveDesign`, 0>>;
739
+
740
+ 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 GetHimalayaAuthorizationRequest, type GetHimalayaAuthorizationResponse, 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, getHimalayaAuthorization, getProject, resumeProject, saveProjectDesign };