@supernova-studio/client 0.58.4 → 0.58.5
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.
- package/dist/index.d.mts +158 -0
- package/dist/index.d.ts +158 -0
- package/dist/index.js +48 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +93 -45
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/api/dto/design-systems/component.ts +10 -0
- package/src/api/dto/design-systems/index.ts +1 -0
- package/src/api/dto/elements/documentation/index.ts +1 -0
- package/src/api/dto/elements/documentation/structure.ts +37 -0
- package/src/api/endpoints/design-system/versions/brands.ts +12 -0
- package/src/api/endpoints/design-system/versions/components.ts +15 -0
- package/src/api/endpoints/design-system/versions/elements-actions.ts +20 -0
- package/src/api/endpoints/design-system/versions/index.ts +2 -0
- package/src/api/endpoints/design-system/versions/versions.ts +6 -0
package/dist/index.d.mts
CHANGED
|
@@ -84416,6 +84416,17 @@ declare class BrandsEndpoint {
|
|
|
84416
84416
|
designSystemVersionId: string;
|
|
84417
84417
|
}[];
|
|
84418
84418
|
}>;
|
|
84419
|
+
create(designSystemId: string, versionId: string, body: DTOCreateBrandInput): Promise<{
|
|
84420
|
+
brand: {
|
|
84421
|
+
id: string;
|
|
84422
|
+
persistentId: string;
|
|
84423
|
+
meta: {
|
|
84424
|
+
name: string;
|
|
84425
|
+
description?: string | undefined;
|
|
84426
|
+
};
|
|
84427
|
+
designSystemVersionId: string;
|
|
84428
|
+
};
|
|
84429
|
+
}>;
|
|
84419
84430
|
}
|
|
84420
84431
|
|
|
84421
84432
|
declare class ImportJobsEndpoint {
|
|
@@ -86127,6 +86138,151 @@ declare class TokensEndpoint {
|
|
|
86127
86138
|
get(dsId: string, versionId: string, tokenId: string): Promise<DTODesignTokenListResponse>;
|
|
86128
86139
|
}
|
|
86129
86140
|
|
|
86141
|
+
declare const DTODesignSystemComponentCreateInput: z.ZodObject<{
|
|
86142
|
+
brandId: z.ZodString;
|
|
86143
|
+
persistentId: z.ZodString;
|
|
86144
|
+
meta: z.ZodObject<{
|
|
86145
|
+
name: z.ZodString;
|
|
86146
|
+
description: z.ZodOptional<z.ZodString>;
|
|
86147
|
+
}, "strip", z.ZodTypeAny, {
|
|
86148
|
+
name: string;
|
|
86149
|
+
description?: string | undefined;
|
|
86150
|
+
}, {
|
|
86151
|
+
name: string;
|
|
86152
|
+
description?: string | undefined;
|
|
86153
|
+
}>;
|
|
86154
|
+
}, "strip", z.ZodTypeAny, {
|
|
86155
|
+
persistentId: string;
|
|
86156
|
+
meta: {
|
|
86157
|
+
name: string;
|
|
86158
|
+
description?: string | undefined;
|
|
86159
|
+
};
|
|
86160
|
+
brandId: string;
|
|
86161
|
+
}, {
|
|
86162
|
+
persistentId: string;
|
|
86163
|
+
meta: {
|
|
86164
|
+
name: string;
|
|
86165
|
+
description?: string | undefined;
|
|
86166
|
+
};
|
|
86167
|
+
brandId: string;
|
|
86168
|
+
}>;
|
|
86169
|
+
type DTODesignSystemComponentCreateInput = z.infer<typeof DTODesignSystemComponentCreateInput>;
|
|
86170
|
+
|
|
86171
|
+
declare class DesignSystemComponentEndpoint {
|
|
86172
|
+
private readonly requestExecutor;
|
|
86173
|
+
constructor(requestExecutor: RequestExecutor);
|
|
86174
|
+
create(dsId: string, vId: string, body: DTODesignSystemComponentCreateInput): Promise<any>;
|
|
86175
|
+
}
|
|
86176
|
+
|
|
86177
|
+
declare class ElementsActionsEndpoint {
|
|
86178
|
+
private readonly requestExecutor;
|
|
86179
|
+
constructor(requestExecutor: RequestExecutor);
|
|
86180
|
+
createDocPage(dsId: string, vId: string, input: DTOCreateDocumentationPageInputV2): Promise<{
|
|
86181
|
+
type: "DocumentationGroupCreate";
|
|
86182
|
+
output: {
|
|
86183
|
+
success: true;
|
|
86184
|
+
};
|
|
86185
|
+
} | {
|
|
86186
|
+
type: "DocumentationTabCreate";
|
|
86187
|
+
output: {
|
|
86188
|
+
success: true;
|
|
86189
|
+
};
|
|
86190
|
+
} | {
|
|
86191
|
+
type: "DocumentationGroupUpdate";
|
|
86192
|
+
output: {
|
|
86193
|
+
success: true;
|
|
86194
|
+
};
|
|
86195
|
+
} | {
|
|
86196
|
+
type: "DocumentationGroupMove";
|
|
86197
|
+
output: {
|
|
86198
|
+
success: true;
|
|
86199
|
+
};
|
|
86200
|
+
} | {
|
|
86201
|
+
type: "DocumentationGroupDuplicate";
|
|
86202
|
+
output: {
|
|
86203
|
+
success: true;
|
|
86204
|
+
};
|
|
86205
|
+
} | {
|
|
86206
|
+
type: "DocumentationGroupDelete";
|
|
86207
|
+
output: {
|
|
86208
|
+
success: true;
|
|
86209
|
+
};
|
|
86210
|
+
} | {
|
|
86211
|
+
type: "DocumentationTabGroupDelete";
|
|
86212
|
+
output: {
|
|
86213
|
+
success: true;
|
|
86214
|
+
};
|
|
86215
|
+
} | {
|
|
86216
|
+
type: "DocumentationPageCreate";
|
|
86217
|
+
output: {
|
|
86218
|
+
success: true;
|
|
86219
|
+
};
|
|
86220
|
+
} | {
|
|
86221
|
+
type: "DocumentationPageUpdate";
|
|
86222
|
+
output: {
|
|
86223
|
+
success: true;
|
|
86224
|
+
};
|
|
86225
|
+
} | {
|
|
86226
|
+
type: "DocumentationPageMove";
|
|
86227
|
+
output: {
|
|
86228
|
+
success: true;
|
|
86229
|
+
};
|
|
86230
|
+
} | {
|
|
86231
|
+
type: "DocumentationPageDuplicate";
|
|
86232
|
+
output: {
|
|
86233
|
+
success: true;
|
|
86234
|
+
};
|
|
86235
|
+
} | {
|
|
86236
|
+
type: "DocumentationPageDelete";
|
|
86237
|
+
output: {
|
|
86238
|
+
success: true;
|
|
86239
|
+
};
|
|
86240
|
+
} | {
|
|
86241
|
+
type: "DocumentationPageRestore";
|
|
86242
|
+
output: {
|
|
86243
|
+
success: true;
|
|
86244
|
+
};
|
|
86245
|
+
} | {
|
|
86246
|
+
type: "DocumentationGroupRestore";
|
|
86247
|
+
output: {
|
|
86248
|
+
success: true;
|
|
86249
|
+
};
|
|
86250
|
+
} | {
|
|
86251
|
+
type: "DocumentationPageApprovalStateChange";
|
|
86252
|
+
output: {
|
|
86253
|
+
success: true;
|
|
86254
|
+
};
|
|
86255
|
+
} | {
|
|
86256
|
+
type: "FigmaNodeRender";
|
|
86257
|
+
figmaNodes: {
|
|
86258
|
+
id: string;
|
|
86259
|
+
persistentId: string;
|
|
86260
|
+
meta: {
|
|
86261
|
+
name: string;
|
|
86262
|
+
description?: string | undefined;
|
|
86263
|
+
};
|
|
86264
|
+
designSystemVersionId: string;
|
|
86265
|
+
createdAt: Date;
|
|
86266
|
+
updatedAt: Date;
|
|
86267
|
+
data: {
|
|
86268
|
+
figmaNodeId: string;
|
|
86269
|
+
isValid: boolean;
|
|
86270
|
+
assetId: string;
|
|
86271
|
+
assetUrl: string;
|
|
86272
|
+
assetFormat: "Png" | "Svg";
|
|
86273
|
+
assetScale: number;
|
|
86274
|
+
assetWidth?: number | undefined;
|
|
86275
|
+
assetHeight?: number | undefined;
|
|
86276
|
+
};
|
|
86277
|
+
origin: {
|
|
86278
|
+
sourceId: string;
|
|
86279
|
+
fileId?: string | undefined;
|
|
86280
|
+
parentName?: string | undefined;
|
|
86281
|
+
};
|
|
86282
|
+
}[];
|
|
86283
|
+
}>;
|
|
86284
|
+
}
|
|
86285
|
+
|
|
86130
86286
|
declare class DesignSystemVersionsEndpoint {
|
|
86131
86287
|
private readonly requestExecutor;
|
|
86132
86288
|
readonly themes: ThemesEndpoint;
|
|
@@ -86138,6 +86294,8 @@ declare class DesignSystemVersionsEndpoint {
|
|
|
86138
86294
|
readonly stats: VersionStatsEndpoint;
|
|
86139
86295
|
readonly elementPropertyDefinitions: ElementPropertyDefinitionsEndpoint;
|
|
86140
86296
|
readonly elementPropertyValues: ElementPropertyValuesEndpoint;
|
|
86297
|
+
readonly elementsActions: ElementsActionsEndpoint;
|
|
86298
|
+
readonly designSystemComponents: DesignSystemComponentEndpoint;
|
|
86141
86299
|
constructor(requestExecutor: RequestExecutor);
|
|
86142
86300
|
list(dsId: string): Promise<{
|
|
86143
86301
|
designSystemVersions: {
|
package/dist/index.d.ts
CHANGED
|
@@ -84416,6 +84416,17 @@ declare class BrandsEndpoint {
|
|
|
84416
84416
|
designSystemVersionId: string;
|
|
84417
84417
|
}[];
|
|
84418
84418
|
}>;
|
|
84419
|
+
create(designSystemId: string, versionId: string, body: DTOCreateBrandInput): Promise<{
|
|
84420
|
+
brand: {
|
|
84421
|
+
id: string;
|
|
84422
|
+
persistentId: string;
|
|
84423
|
+
meta: {
|
|
84424
|
+
name: string;
|
|
84425
|
+
description?: string | undefined;
|
|
84426
|
+
};
|
|
84427
|
+
designSystemVersionId: string;
|
|
84428
|
+
};
|
|
84429
|
+
}>;
|
|
84419
84430
|
}
|
|
84420
84431
|
|
|
84421
84432
|
declare class ImportJobsEndpoint {
|
|
@@ -86127,6 +86138,151 @@ declare class TokensEndpoint {
|
|
|
86127
86138
|
get(dsId: string, versionId: string, tokenId: string): Promise<DTODesignTokenListResponse>;
|
|
86128
86139
|
}
|
|
86129
86140
|
|
|
86141
|
+
declare const DTODesignSystemComponentCreateInput: z.ZodObject<{
|
|
86142
|
+
brandId: z.ZodString;
|
|
86143
|
+
persistentId: z.ZodString;
|
|
86144
|
+
meta: z.ZodObject<{
|
|
86145
|
+
name: z.ZodString;
|
|
86146
|
+
description: z.ZodOptional<z.ZodString>;
|
|
86147
|
+
}, "strip", z.ZodTypeAny, {
|
|
86148
|
+
name: string;
|
|
86149
|
+
description?: string | undefined;
|
|
86150
|
+
}, {
|
|
86151
|
+
name: string;
|
|
86152
|
+
description?: string | undefined;
|
|
86153
|
+
}>;
|
|
86154
|
+
}, "strip", z.ZodTypeAny, {
|
|
86155
|
+
persistentId: string;
|
|
86156
|
+
meta: {
|
|
86157
|
+
name: string;
|
|
86158
|
+
description?: string | undefined;
|
|
86159
|
+
};
|
|
86160
|
+
brandId: string;
|
|
86161
|
+
}, {
|
|
86162
|
+
persistentId: string;
|
|
86163
|
+
meta: {
|
|
86164
|
+
name: string;
|
|
86165
|
+
description?: string | undefined;
|
|
86166
|
+
};
|
|
86167
|
+
brandId: string;
|
|
86168
|
+
}>;
|
|
86169
|
+
type DTODesignSystemComponentCreateInput = z.infer<typeof DTODesignSystemComponentCreateInput>;
|
|
86170
|
+
|
|
86171
|
+
declare class DesignSystemComponentEndpoint {
|
|
86172
|
+
private readonly requestExecutor;
|
|
86173
|
+
constructor(requestExecutor: RequestExecutor);
|
|
86174
|
+
create(dsId: string, vId: string, body: DTODesignSystemComponentCreateInput): Promise<any>;
|
|
86175
|
+
}
|
|
86176
|
+
|
|
86177
|
+
declare class ElementsActionsEndpoint {
|
|
86178
|
+
private readonly requestExecutor;
|
|
86179
|
+
constructor(requestExecutor: RequestExecutor);
|
|
86180
|
+
createDocPage(dsId: string, vId: string, input: DTOCreateDocumentationPageInputV2): Promise<{
|
|
86181
|
+
type: "DocumentationGroupCreate";
|
|
86182
|
+
output: {
|
|
86183
|
+
success: true;
|
|
86184
|
+
};
|
|
86185
|
+
} | {
|
|
86186
|
+
type: "DocumentationTabCreate";
|
|
86187
|
+
output: {
|
|
86188
|
+
success: true;
|
|
86189
|
+
};
|
|
86190
|
+
} | {
|
|
86191
|
+
type: "DocumentationGroupUpdate";
|
|
86192
|
+
output: {
|
|
86193
|
+
success: true;
|
|
86194
|
+
};
|
|
86195
|
+
} | {
|
|
86196
|
+
type: "DocumentationGroupMove";
|
|
86197
|
+
output: {
|
|
86198
|
+
success: true;
|
|
86199
|
+
};
|
|
86200
|
+
} | {
|
|
86201
|
+
type: "DocumentationGroupDuplicate";
|
|
86202
|
+
output: {
|
|
86203
|
+
success: true;
|
|
86204
|
+
};
|
|
86205
|
+
} | {
|
|
86206
|
+
type: "DocumentationGroupDelete";
|
|
86207
|
+
output: {
|
|
86208
|
+
success: true;
|
|
86209
|
+
};
|
|
86210
|
+
} | {
|
|
86211
|
+
type: "DocumentationTabGroupDelete";
|
|
86212
|
+
output: {
|
|
86213
|
+
success: true;
|
|
86214
|
+
};
|
|
86215
|
+
} | {
|
|
86216
|
+
type: "DocumentationPageCreate";
|
|
86217
|
+
output: {
|
|
86218
|
+
success: true;
|
|
86219
|
+
};
|
|
86220
|
+
} | {
|
|
86221
|
+
type: "DocumentationPageUpdate";
|
|
86222
|
+
output: {
|
|
86223
|
+
success: true;
|
|
86224
|
+
};
|
|
86225
|
+
} | {
|
|
86226
|
+
type: "DocumentationPageMove";
|
|
86227
|
+
output: {
|
|
86228
|
+
success: true;
|
|
86229
|
+
};
|
|
86230
|
+
} | {
|
|
86231
|
+
type: "DocumentationPageDuplicate";
|
|
86232
|
+
output: {
|
|
86233
|
+
success: true;
|
|
86234
|
+
};
|
|
86235
|
+
} | {
|
|
86236
|
+
type: "DocumentationPageDelete";
|
|
86237
|
+
output: {
|
|
86238
|
+
success: true;
|
|
86239
|
+
};
|
|
86240
|
+
} | {
|
|
86241
|
+
type: "DocumentationPageRestore";
|
|
86242
|
+
output: {
|
|
86243
|
+
success: true;
|
|
86244
|
+
};
|
|
86245
|
+
} | {
|
|
86246
|
+
type: "DocumentationGroupRestore";
|
|
86247
|
+
output: {
|
|
86248
|
+
success: true;
|
|
86249
|
+
};
|
|
86250
|
+
} | {
|
|
86251
|
+
type: "DocumentationPageApprovalStateChange";
|
|
86252
|
+
output: {
|
|
86253
|
+
success: true;
|
|
86254
|
+
};
|
|
86255
|
+
} | {
|
|
86256
|
+
type: "FigmaNodeRender";
|
|
86257
|
+
figmaNodes: {
|
|
86258
|
+
id: string;
|
|
86259
|
+
persistentId: string;
|
|
86260
|
+
meta: {
|
|
86261
|
+
name: string;
|
|
86262
|
+
description?: string | undefined;
|
|
86263
|
+
};
|
|
86264
|
+
designSystemVersionId: string;
|
|
86265
|
+
createdAt: Date;
|
|
86266
|
+
updatedAt: Date;
|
|
86267
|
+
data: {
|
|
86268
|
+
figmaNodeId: string;
|
|
86269
|
+
isValid: boolean;
|
|
86270
|
+
assetId: string;
|
|
86271
|
+
assetUrl: string;
|
|
86272
|
+
assetFormat: "Png" | "Svg";
|
|
86273
|
+
assetScale: number;
|
|
86274
|
+
assetWidth?: number | undefined;
|
|
86275
|
+
assetHeight?: number | undefined;
|
|
86276
|
+
};
|
|
86277
|
+
origin: {
|
|
86278
|
+
sourceId: string;
|
|
86279
|
+
fileId?: string | undefined;
|
|
86280
|
+
parentName?: string | undefined;
|
|
86281
|
+
};
|
|
86282
|
+
}[];
|
|
86283
|
+
}>;
|
|
86284
|
+
}
|
|
86285
|
+
|
|
86130
86286
|
declare class DesignSystemVersionsEndpoint {
|
|
86131
86287
|
private readonly requestExecutor;
|
|
86132
86288
|
readonly themes: ThemesEndpoint;
|
|
@@ -86138,6 +86294,8 @@ declare class DesignSystemVersionsEndpoint {
|
|
|
86138
86294
|
readonly stats: VersionStatsEndpoint;
|
|
86139
86295
|
readonly elementPropertyDefinitions: ElementPropertyDefinitionsEndpoint;
|
|
86140
86296
|
readonly elementPropertyValues: ElementPropertyValuesEndpoint;
|
|
86297
|
+
readonly elementsActions: ElementsActionsEndpoint;
|
|
86298
|
+
readonly designSystemComponents: DesignSystemComponentEndpoint;
|
|
86141
86299
|
constructor(requestExecutor: RequestExecutor);
|
|
86142
86300
|
list(dsId: string): Promise<{
|
|
86143
86301
|
designSystemVersions: {
|
package/dist/index.js
CHANGED
|
@@ -6994,6 +6994,16 @@ var BrandsEndpoint = class {
|
|
|
6994
6994
|
DTOBrandsListResponse
|
|
6995
6995
|
);
|
|
6996
6996
|
}
|
|
6997
|
+
create(designSystemId, versionId, body) {
|
|
6998
|
+
return this.requestExecutor.json(
|
|
6999
|
+
`/design-systems/${designSystemId}/versions/${versionId}/brands`,
|
|
7000
|
+
DTOBrandGetResponse,
|
|
7001
|
+
{
|
|
7002
|
+
method: "POST",
|
|
7003
|
+
body
|
|
7004
|
+
}
|
|
7005
|
+
);
|
|
7006
|
+
}
|
|
6997
7007
|
};
|
|
6998
7008
|
|
|
6999
7009
|
// src/api/endpoints/design-system/versions/import-jobs.ts
|
|
@@ -7185,6 +7195,40 @@ var TokensEndpoint = class {
|
|
|
7185
7195
|
}
|
|
7186
7196
|
};
|
|
7187
7197
|
|
|
7198
|
+
// src/api/endpoints/design-system/versions/components.ts
|
|
7199
|
+
|
|
7200
|
+
var DesignSystemComponentEndpoint = class {
|
|
7201
|
+
constructor(requestExecutor) {
|
|
7202
|
+
this.requestExecutor = requestExecutor;
|
|
7203
|
+
}
|
|
7204
|
+
async create(dsId, vId, body) {
|
|
7205
|
+
return this.requestExecutor.json(`/design-systems/${dsId}/versions/${vId}/design-system-components`, _zod.z.any(), {
|
|
7206
|
+
body,
|
|
7207
|
+
method: "POST"
|
|
7208
|
+
});
|
|
7209
|
+
}
|
|
7210
|
+
};
|
|
7211
|
+
|
|
7212
|
+
// src/api/endpoints/design-system/versions/elements-actions.ts
|
|
7213
|
+
var ElementsActionsEndpoint = class {
|
|
7214
|
+
constructor(requestExecutor) {
|
|
7215
|
+
this.requestExecutor = requestExecutor;
|
|
7216
|
+
}
|
|
7217
|
+
async createDocPage(dsId, vId, input) {
|
|
7218
|
+
return this.requestExecutor.json(
|
|
7219
|
+
`/design-systems/${dsId}/versions/${vId}/elements-action`,
|
|
7220
|
+
DTOElementActionOutput,
|
|
7221
|
+
{
|
|
7222
|
+
body: {
|
|
7223
|
+
type: "DocumentationPageCreate",
|
|
7224
|
+
input
|
|
7225
|
+
},
|
|
7226
|
+
method: "POST"
|
|
7227
|
+
}
|
|
7228
|
+
);
|
|
7229
|
+
}
|
|
7230
|
+
};
|
|
7231
|
+
|
|
7188
7232
|
// src/api/endpoints/design-system/versions/versions.ts
|
|
7189
7233
|
var DesignSystemVersionsEndpoint = class {
|
|
7190
7234
|
constructor(requestExecutor) {
|
|
@@ -7198,6 +7242,8 @@ var DesignSystemVersionsEndpoint = class {
|
|
|
7198
7242
|
__publicField(this, "stats");
|
|
7199
7243
|
__publicField(this, "elementPropertyDefinitions");
|
|
7200
7244
|
__publicField(this, "elementPropertyValues");
|
|
7245
|
+
__publicField(this, "elementsActions");
|
|
7246
|
+
__publicField(this, "designSystemComponents");
|
|
7201
7247
|
this.themes = new ThemesEndpoint(requestExecutor);
|
|
7202
7248
|
this.brands = new BrandsEndpoint(requestExecutor);
|
|
7203
7249
|
this.tokenCollections = new TokenCollectionsEndpoint(requestExecutor);
|
|
@@ -7207,6 +7253,8 @@ var DesignSystemVersionsEndpoint = class {
|
|
|
7207
7253
|
this.stats = new VersionStatsEndpoint(requestExecutor);
|
|
7208
7254
|
this.elementPropertyDefinitions = new ElementPropertyDefinitionsEndpoint(requestExecutor);
|
|
7209
7255
|
this.elementPropertyValues = new ElementPropertyValuesEndpoint(requestExecutor);
|
|
7256
|
+
this.elementsActions = new ElementsActionsEndpoint(requestExecutor);
|
|
7257
|
+
this.designSystemComponents = new DesignSystemComponentEndpoint(requestExecutor);
|
|
7210
7258
|
}
|
|
7211
7259
|
list(dsId) {
|
|
7212
7260
|
return this.requestExecutor.json(`/design-systems/${dsId}/versions`, DTODesignSystemVersionsListResponse);
|