@supernova-studio/client 1.6.6 → 1.6.8

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.
Files changed (7) hide show
  1. package/dist/index.d.mts +164 -22
  2. package/dist/index.d.ts +164 -22
  3. package/dist/index.js +32 -4
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +1520 -1492
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -63658,7 +63658,7 @@ declare const DTOPipeline: z.ZodObject<{
63658
63658
  }>>;
63659
63659
  id: z.ZodString;
63660
63660
  name: z.ZodString;
63661
- eventType: z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "None"]>;
63661
+ eventType: z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "OnDocumentationPublished", "None"]>;
63662
63662
  isEnabled: z.ZodBoolean;
63663
63663
  workspaceId: z.ZodString;
63664
63664
  designSystemId: z.ZodString;
@@ -63674,7 +63674,7 @@ declare const DTOPipeline: z.ZodObject<{
63674
63674
  workspaceId: string;
63675
63675
  exporterId: string;
63676
63676
  isEnabled: boolean;
63677
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
63677
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
63678
63678
  latestJobs: {
63679
63679
  id: string;
63680
63680
  createdAt: Date;
@@ -63899,7 +63899,7 @@ declare const DTOPipeline: z.ZodObject<{
63899
63899
  workspaceId: string;
63900
63900
  exporterId: string;
63901
63901
  isEnabled: boolean;
63902
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
63902
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
63903
63903
  latestJobs: {
63904
63904
  id: string;
63905
63905
  createdAt: Date;
@@ -65228,7 +65228,7 @@ declare const DTOPipelineResponse: z.ZodObject<{
65228
65228
  }>>;
65229
65229
  id: z.ZodString;
65230
65230
  name: z.ZodString;
65231
- eventType: z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "None"]>;
65231
+ eventType: z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "OnDocumentationPublished", "None"]>;
65232
65232
  isEnabled: z.ZodBoolean;
65233
65233
  workspaceId: z.ZodString;
65234
65234
  designSystemId: z.ZodString;
@@ -65244,7 +65244,7 @@ declare const DTOPipelineResponse: z.ZodObject<{
65244
65244
  workspaceId: string;
65245
65245
  exporterId: string;
65246
65246
  isEnabled: boolean;
65247
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
65247
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
65248
65248
  latestJobs: {
65249
65249
  id: string;
65250
65250
  createdAt: Date;
@@ -65469,7 +65469,7 @@ declare const DTOPipelineResponse: z.ZodObject<{
65469
65469
  workspaceId: string;
65470
65470
  exporterId: string;
65471
65471
  isEnabled: boolean;
65472
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
65472
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
65473
65473
  latestJobs: {
65474
65474
  id: string;
65475
65475
  createdAt: Date;
@@ -65696,7 +65696,7 @@ declare const DTOPipelineResponse: z.ZodObject<{
65696
65696
  workspaceId: string;
65697
65697
  exporterId: string;
65698
65698
  isEnabled: boolean;
65699
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
65699
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
65700
65700
  latestJobs: {
65701
65701
  id: string;
65702
65702
  createdAt: Date;
@@ -65923,7 +65923,7 @@ declare const DTOPipelineResponse: z.ZodObject<{
65923
65923
  workspaceId: string;
65924
65924
  exporterId: string;
65925
65925
  isEnabled: boolean;
65926
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
65926
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
65927
65927
  latestJobs: {
65928
65928
  id: string;
65929
65929
  createdAt: Date;
@@ -67253,7 +67253,7 @@ declare const DTOPipelineListResponse: z.ZodObject<{
67253
67253
  }>>;
67254
67254
  id: z.ZodString;
67255
67255
  name: z.ZodString;
67256
- eventType: z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "None"]>;
67256
+ eventType: z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "OnDocumentationPublished", "None"]>;
67257
67257
  isEnabled: z.ZodBoolean;
67258
67258
  workspaceId: z.ZodString;
67259
67259
  designSystemId: z.ZodString;
@@ -67269,7 +67269,7 @@ declare const DTOPipelineListResponse: z.ZodObject<{
67269
67269
  workspaceId: string;
67270
67270
  exporterId: string;
67271
67271
  isEnabled: boolean;
67272
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
67272
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
67273
67273
  latestJobs: {
67274
67274
  id: string;
67275
67275
  createdAt: Date;
@@ -67494,7 +67494,7 @@ declare const DTOPipelineListResponse: z.ZodObject<{
67494
67494
  workspaceId: string;
67495
67495
  exporterId: string;
67496
67496
  isEnabled: boolean;
67497
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
67497
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
67498
67498
  latestJobs: {
67499
67499
  id: string;
67500
67500
  createdAt: Date;
@@ -67721,7 +67721,7 @@ declare const DTOPipelineListResponse: z.ZodObject<{
67721
67721
  workspaceId: string;
67722
67722
  exporterId: string;
67723
67723
  isEnabled: boolean;
67724
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
67724
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
67725
67725
  latestJobs: {
67726
67726
  id: string;
67727
67727
  createdAt: Date;
@@ -67948,7 +67948,7 @@ declare const DTOPipelineListResponse: z.ZodObject<{
67948
67948
  workspaceId: string;
67949
67949
  exporterId: string;
67950
67950
  isEnabled: boolean;
67951
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
67951
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
67952
67952
  latestJobs: {
67953
67953
  id: string;
67954
67954
  createdAt: Date;
@@ -100059,7 +100059,7 @@ declare const DTOPipelineCreateBody: z.ZodObject<{
100059
100059
  exporterId: z.ZodString;
100060
100060
  designSystemId: z.ZodString;
100061
100061
  isEnabled: z.ZodBoolean;
100062
- eventType: z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "None"]>;
100062
+ eventType: z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "OnDocumentationPublished", "None"]>;
100063
100063
  brandPersistentId: z.ZodOptional<z.ZodString>;
100064
100064
  themePersistentId: z.ZodOptional<z.ZodString>;
100065
100065
  themePersistentIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -100452,7 +100452,7 @@ declare const DTOPipelineCreateBody: z.ZodObject<{
100452
100452
  designSystemId: string;
100453
100453
  exporterId: string;
100454
100454
  isEnabled: boolean;
100455
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
100455
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
100456
100456
  gitQuery: {
100457
100457
  organization?: string | undefined;
100458
100458
  project?: string | undefined;
@@ -100544,7 +100544,7 @@ declare const DTOPipelineCreateBody: z.ZodObject<{
100544
100544
  designSystemId: string;
100545
100545
  exporterId: string;
100546
100546
  isEnabled: boolean;
100547
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
100547
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
100548
100548
  gitQuery: {
100549
100549
  organization?: string | undefined;
100550
100550
  project?: string | undefined;
@@ -100637,7 +100637,7 @@ declare const DTOPipelineUpdateBody: z.ZodObject<{
100637
100637
  exporterId: z.ZodOptional<z.ZodString>;
100638
100638
  name: z.ZodOptional<z.ZodString>;
100639
100639
  isEnabled: z.ZodOptional<z.ZodBoolean>;
100640
- eventType: z.ZodOptional<z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "None"]>>;
100640
+ eventType: z.ZodOptional<z.ZodEnum<["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "OnDocumentationPublished", "None"]>>;
100641
100641
  brandPersistentId: z.ZodOptional<z.ZodString>;
100642
100642
  themePersistentId: z.ZodOptional<z.ZodString>;
100643
100643
  themePersistentIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -101058,7 +101058,7 @@ declare const DTOPipelineUpdateBody: z.ZodObject<{
101058
101058
  brandPersistentId?: string | undefined;
101059
101059
  exporterId?: string | undefined;
101060
101060
  isEnabled?: boolean | undefined;
101061
- eventType?: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | undefined;
101061
+ eventType?: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished" | undefined;
101062
101062
  themePersistentId?: string | undefined;
101063
101063
  themePersistentIds?: string[] | undefined;
101064
101064
  exporterPropertyValues?: Record<string, string | number | boolean | Record<string, string> | string[]> | undefined;
@@ -101159,7 +101159,7 @@ declare const DTOPipelineUpdateBody: z.ZodObject<{
101159
101159
  brandPersistentId?: string | undefined;
101160
101160
  exporterId?: string | undefined;
101161
101161
  isEnabled?: boolean | undefined;
101162
- eventType?: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | undefined;
101162
+ eventType?: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished" | undefined;
101163
101163
  themePersistentId?: string | undefined;
101164
101164
  themePersistentIds?: string[] | undefined;
101165
101165
  exporterPropertyValues?: Record<string, string | number | boolean | Record<string, string> | string[]> | undefined;
@@ -102014,7 +102014,7 @@ declare class PipelinesEndpoint {
102014
102014
  workspaceId: string;
102015
102015
  exporterId: string;
102016
102016
  isEnabled: boolean;
102017
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
102017
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
102018
102018
  latestJobs: {
102019
102019
  id: string;
102020
102020
  createdAt: Date;
@@ -102242,7 +102242,7 @@ declare class PipelinesEndpoint {
102242
102242
  workspaceId: string;
102243
102243
  exporterId: string;
102244
102244
  isEnabled: boolean;
102245
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
102245
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
102246
102246
  latestJobs: {
102247
102247
  id: string;
102248
102248
  createdAt: Date;
@@ -102470,7 +102470,7 @@ declare class PipelinesEndpoint {
102470
102470
  workspaceId: string;
102471
102471
  exporterId: string;
102472
102472
  isEnabled: boolean;
102473
- eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
102473
+ eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated" | "OnDocumentationPublished";
102474
102474
  latestJobs: {
102475
102475
  id: string;
102476
102476
  createdAt: Date;
@@ -103089,6 +103089,148 @@ declare class DocumentationEndpoint {
103089
103089
  searchKeywords?: string[] | undefined;
103090
103090
  }[];
103091
103091
  }>;
103092
+ publish(dsId: string, vId: string, body: DTOPublishDocumentationRequest): Promise<{
103093
+ job: {
103094
+ id: string;
103095
+ createdAt: Date;
103096
+ status: "InProgress" | "Failed" | "Success" | "Timeout";
103097
+ designSystem: {
103098
+ id: string;
103099
+ meta: {
103100
+ name: string;
103101
+ description?: string | undefined;
103102
+ };
103103
+ };
103104
+ exporterId: string;
103105
+ destinations: {
103106
+ s3?: {} | undefined;
103107
+ azure?: {
103108
+ branch: string;
103109
+ organizationId: string;
103110
+ projectId: string;
103111
+ repositoryId: string;
103112
+ url?: string | undefined;
103113
+ userId?: number | undefined;
103114
+ relativePath?: string | undefined;
103115
+ purgeDirectory?: boolean | undefined;
103116
+ commitAuthorName?: string | undefined;
103117
+ commitAuthorEmail?: string | undefined;
103118
+ commitMessage?: string | undefined;
103119
+ pullRequestTitle?: string | undefined;
103120
+ pullRequestDescription?: string | undefined;
103121
+ credentialId?: string | undefined;
103122
+ connectionId?: string | undefined;
103123
+ } | undefined;
103124
+ bitbucket?: {
103125
+ branch: string;
103126
+ workspaceSlug: string;
103127
+ projectKey: string;
103128
+ repoSlug: string;
103129
+ url?: string | undefined;
103130
+ userId?: number | undefined;
103131
+ relativePath?: string | undefined;
103132
+ purgeDirectory?: boolean | undefined;
103133
+ commitAuthorName?: string | undefined;
103134
+ commitAuthorEmail?: string | undefined;
103135
+ commitMessage?: string | undefined;
103136
+ pullRequestTitle?: string | undefined;
103137
+ pullRequestDescription?: string | undefined;
103138
+ credentialId?: string | undefined;
103139
+ connectionId?: string | undefined;
103140
+ } | undefined;
103141
+ github?: {
103142
+ url: string;
103143
+ branch: string;
103144
+ userId?: number | undefined;
103145
+ relativePath?: string | undefined;
103146
+ purgeDirectory?: boolean | undefined;
103147
+ commitAuthorName?: string | undefined;
103148
+ commitAuthorEmail?: string | undefined;
103149
+ commitMessage?: string | undefined;
103150
+ pullRequestTitle?: string | undefined;
103151
+ pullRequestDescription?: string | undefined;
103152
+ credentialId?: string | undefined;
103153
+ connectionId?: string | undefined;
103154
+ } | undefined;
103155
+ gitlab?: {
103156
+ branch: string;
103157
+ projectId: string;
103158
+ url?: string | undefined;
103159
+ userId?: number | undefined;
103160
+ relativePath?: string | undefined;
103161
+ purgeDirectory?: boolean | undefined;
103162
+ commitAuthorName?: string | undefined;
103163
+ commitAuthorEmail?: string | undefined;
103164
+ commitMessage?: string | undefined;
103165
+ pullRequestTitle?: string | undefined;
103166
+ pullRequestDescription?: string | undefined;
103167
+ credentialId?: string | undefined;
103168
+ connectionId?: string | undefined;
103169
+ } | undefined;
103170
+ documentation?: {
103171
+ environment: "Live" | "Preview";
103172
+ changes?: {
103173
+ groupPersistentIds: string[];
103174
+ pagePersistentIds: string[];
103175
+ } | undefined;
103176
+ } | undefined;
103177
+ webhookUrl?: string | undefined;
103178
+ };
103179
+ designSystemVersion: {
103180
+ id: string;
103181
+ meta: {
103182
+ name: string;
103183
+ description?: string | undefined;
103184
+ };
103185
+ version: string;
103186
+ isReadonly: boolean;
103187
+ };
103188
+ brandPersistentId?: string | undefined;
103189
+ themePersistentId?: string | undefined;
103190
+ themePersistentIds?: string[] | undefined;
103191
+ exporterPropertyValues?: Record<string, string | number | boolean | Record<string, string> | string[]> | undefined;
103192
+ finishedAt?: Date | undefined;
103193
+ index?: number | undefined;
103194
+ estimatedExecutionTime?: number | undefined;
103195
+ createdBy?: {
103196
+ userId: string;
103197
+ userName: string;
103198
+ } | undefined;
103199
+ scheduleId?: string | undefined;
103200
+ result?: {
103201
+ s3?: {
103202
+ path: string;
103203
+ files: string[];
103204
+ bucket: string;
103205
+ url?: string | undefined;
103206
+ urlPrefix?: string | undefined;
103207
+ urls?: string[] | undefined;
103208
+ } | undefined;
103209
+ azure?: {
103210
+ pullRequestUrl: string;
103211
+ } | undefined;
103212
+ bitbucket?: {
103213
+ pullRequestUrl: string;
103214
+ } | undefined;
103215
+ github?: {
103216
+ pullRequestUrl: string;
103217
+ } | undefined;
103218
+ gitlab?: {
103219
+ pullRequestUrl: string;
103220
+ } | undefined;
103221
+ documentation?: {
103222
+ url: string;
103223
+ } | undefined;
103224
+ error?: string | undefined;
103225
+ logs?: {
103226
+ message: string;
103227
+ type: "error" | "info" | "user" | "success" | "warning";
103228
+ time: Date;
103229
+ id?: string | undefined;
103230
+ }[] | undefined;
103231
+ } | undefined;
103232
+ };
103233
+ }>;
103092
103234
  }
103093
103235
 
103094
103236
  declare class DesignSystemComponentEndpoint {