@supernova-studio/client 0.4.6 → 0.6.0

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.mjs CHANGED
@@ -1,4 +1,4 @@
1
- // src/api/requests/post-bulk-doc-page-elements.ts
1
+ // src/api/dto/documentation-v1.ts
2
2
  import { z as z125 } from "zod";
3
3
 
4
4
  // ../model/dist/index.mjs
@@ -377,7 +377,8 @@ var DataSourceFigmaRemote = z14.object({
377
377
  scope: DataSourceFigmaScope,
378
378
  state: DataSourceFigmaState,
379
379
  lastImportMetadata: DataSourceFigmaImportMetadata.optional(),
380
- downloadChunkSize: z14.number().optional()
380
+ downloadChunkSize: z14.number().optional(),
381
+ figmaRenderChunkSize: z14.number().optional()
381
382
  });
382
383
  var DataSourceTokenStudioRemote = z14.object({
383
384
  type: z14.literal(DataSourceRemoteType.Enum.TokenStudio)
@@ -565,10 +566,8 @@ var DesignElement = ShallowDesignElement.extend({
565
566
  createdAt: z27.date(),
566
567
  updatedAt: z27.date(),
567
568
  exportProperties: DesignSystemElementExportProps.optional(),
568
- data: z27.any(),
569
- // TODO this should be an object, not any.
570
- origin: z27.any().optional()
571
- // TODO object, not any.
569
+ data: z27.record(z27.any()),
570
+ origin: z27.record(z27.any()).optional()
572
571
  });
573
572
  var ElementPropertyType = z28.enum(["Text", "Number", "Boolean", "Select", "Generic", "Link", "URL"]);
574
573
  var ElementPropertyTargetType = z28.enum(["Token", "Component", "DocumentationPage"]);
@@ -996,6 +995,7 @@ var PageBlockItemTextValue = z33.object({
996
995
  var PageBlockItemTokenValue = z33.object({
997
996
  selectedPropertyIds: z33.array(z33.string()).optional(),
998
997
  selectedThemeIds: z33.array(z33.string()).optional(),
998
+ themeDisplayMode: z33.enum(["Split", "Override"]).optional(),
999
999
  value: z33.array(
1000
1000
  z33.object({
1001
1001
  entityId: z33.string(),
@@ -1077,13 +1077,13 @@ var DocumentationItemHeaderImageScaleType = DocumentationItemHeaderImageScaleTyp
1077
1077
  var DocumentationItemHeader = z36.object({
1078
1078
  description: z36.string(),
1079
1079
  alignment: DocumentationItemHeaderAlignmentSchema,
1080
- foregroundColor: ColorTokenData.optional(),
1081
- backgroundColor: ColorTokenData.optional(),
1082
- backgroundImageAsset: DocumentationPageAsset.optional(),
1080
+ foregroundColor: ColorTokenData.nullish(),
1081
+ backgroundColor: ColorTokenData.nullish(),
1082
+ backgroundImageAsset: DocumentationPageAsset.nullish(),
1083
1083
  backgroundImageScaleType: DocumentationItemHeaderImageScaleTypeSchema,
1084
1084
  showBackgroundOverlay: z36.boolean(),
1085
1085
  showCoverText: z36.boolean(),
1086
- minHeight: z36.number().optional()
1086
+ minHeight: z36.number().nullish()
1087
1087
  });
1088
1088
  var defaultDocumentationItemHeader = {
1089
1089
  alignment: DocumentationItemHeaderAlignment.Left,
@@ -1315,15 +1315,6 @@ var DocumentationPageV1 = DesignElementBase.extend(DesignElementGroupableRequire
1315
1315
  shortPersistentId: z64.string(),
1316
1316
  data: DocumentationPageDataV1
1317
1317
  });
1318
- var DocumentationPageDTOV1 = DocumentationPageV1.omit({
1319
- data: true,
1320
- meta: true,
1321
- parentPersistentId: true,
1322
- sortOrder: true
1323
- }).extend(DocumentationPageV1.shape.data.shape).extend({
1324
- title: z64.string(),
1325
- path: z64.string()
1326
- });
1327
1318
  var DocumentationPageV2 = DesignElementBase.extend(DesignElementGroupableRequiredPart.shape).extend(DesignElementSlugPart.shape).extend({
1328
1319
  shortPersistentId: z65.string(),
1329
1320
  data: DocumentationPageDataV2
@@ -1349,22 +1340,6 @@ var ElementGroup = DesignElementBase.extend(DesignElementGroupablePart.shape).ex
1349
1340
  data: ElementGroupData.optional()
1350
1341
  });
1351
1342
  var BrandedElementGroup = ElementGroup.extend(DesignElementBrandedPart.shape);
1352
- var DocumentationGroupDTO = ElementGroup.omit({
1353
- sortOrder: true,
1354
- parentPersistentId: true,
1355
- brandPersistentId: true,
1356
- meta: true,
1357
- childType: true,
1358
- data: true,
1359
- shortPersistentId: true
1360
- }).extend({
1361
- title: z67.string(),
1362
- isRoot: z67.boolean(),
1363
- childrenIds: z67.array(z67.string()),
1364
- groupBehavior: DocumentationGroupBehavior,
1365
- configuration: DocumentationItemConfiguration,
1366
- shortPersistentId: z67.string()
1367
- });
1368
1343
  var PageBlockV2 = DesignElementBase.extend(DesignElementGroupableRequiredPart.shape).extend({
1369
1344
  data: PageBlockDataV2
1370
1345
  });
@@ -2003,20 +1978,26 @@ var DocumentationPage = z88.object({
2003
1978
  updatedAt: z88.date()
2004
1979
  });
2005
1980
  var NpmRegistryAuthType = z89.enum(["Basic", "Bearer", "None", "Custom"]);
2006
- var NpmRegistryType = z89.enum(["NPMJS", "GitHub", "AzureDevOps", "Artifactory", "Custom"]);
1981
+ var registryTypesWithoutAzure = ["NPMJS", "GitHub", "Artifactory", "Custom"];
1982
+ var NpmRegistryType = z89.enum([...registryTypesWithoutAzure, "AzureDevOps"]);
1983
+ var NpmRegistryTypeWithoutAzure = z89.enum(registryTypesWithoutAzure);
2007
1984
  var NpmRegistryBasicAuthConfig = z89.object({
1985
+ registryType: NpmRegistryType,
2008
1986
  authType: z89.literal(NpmRegistryAuthType.Enum.Basic),
2009
1987
  username: z89.string(),
2010
1988
  password: z89.string()
2011
1989
  });
2012
1990
  var NpmRegistryBearerAuthConfig = z89.object({
1991
+ registryType: NpmRegistryTypeWithoutAzure,
2013
1992
  authType: z89.literal(NpmRegistryAuthType.Enum.Bearer),
2014
1993
  accessToken: z89.string()
2015
1994
  });
2016
1995
  var NpmRegistryNoAuthConfig = z89.object({
1996
+ registryType: NpmRegistryTypeWithoutAzure,
2017
1997
  authType: z89.literal(NpmRegistryAuthType.Enum.None)
2018
1998
  });
2019
1999
  var NpmRegistrCustomAuthConfig = z89.object({
2000
+ registryType: NpmRegistryTypeWithoutAzure,
2020
2001
  authType: z89.literal(NpmRegistryAuthType.Enum.Custom),
2021
2002
  authHeaderName: z89.string(),
2022
2003
  authHeaderValue: z89.string()
@@ -2028,7 +2009,6 @@ var NpmRegistryAuthConfig = z89.discriminatedUnion("authType", [
2028
2009
  NpmRegistrCustomAuthConfig
2029
2010
  ]);
2030
2011
  var NpmRegistryConfigBase = z89.object({
2031
- registryType: NpmRegistryType,
2032
2012
  enabledScopes: z89.array(z89.string()),
2033
2013
  customRegistryUrl: z89.string().optional(),
2034
2014
  bypassProxy: z89.boolean().default(false),
@@ -2503,60 +2483,186 @@ var ContentLoaderPayload = z124.object({
2503
2483
  })
2504
2484
  );
2505
2485
 
2506
- // src/api/requests/post-bulk-doc-page-elements.ts
2507
- var CreateBulkElementsInput = z125.object({
2508
- persistentId: z125.string().uuid(),
2486
+ // src/api/dto/documentation-v1.ts
2487
+ var DocumentationPageV1DTO = DocumentationPageV1.omit({
2488
+ data: true,
2489
+ meta: true,
2490
+ parentPersistentId: true,
2491
+ sortOrder: true
2492
+ }).extend(DocumentationPageV1.shape.data.shape).extend({
2509
2493
  title: z125.string(),
2494
+ path: z125.string()
2495
+ });
2496
+
2497
+ // src/api/dto/documentation-v2.ts
2498
+ import { z as z127 } from "zod";
2499
+
2500
+ // src/api/dto/documentation.ts
2501
+ import { z as z126 } from "zod";
2502
+ var DocumentationGroupStructureDTO = ElementGroup.omit({
2503
+ sortOrder: true,
2504
+ parentPersistentId: true,
2505
+ brandPersistentId: true,
2506
+ meta: true,
2507
+ childType: true,
2508
+ data: true,
2509
+ shortPersistentId: true
2510
+ }).extend({
2511
+ title: z126.string(),
2512
+ isRoot: z126.boolean(),
2513
+ childrenIds: z126.array(z126.string()),
2514
+ groupBehavior: DocumentationGroupBehavior,
2515
+ shortPersistentId: z126.string()
2516
+ });
2517
+ var DocumentationGroupDTO = DocumentationGroupStructureDTO.extend({
2518
+ configuration: DocumentationItemConfiguration
2519
+ });
2520
+
2521
+ // src/api/dto/documentation-v2.ts
2522
+ var DocumentationPageStructureV2DTO = DocumentationPageV2.omit({
2523
+ data: true,
2524
+ meta: true,
2525
+ parentPersistentId: true,
2526
+ sortOrder: true
2527
+ }).extend({
2528
+ title: z127.string(),
2529
+ path: z127.string()
2530
+ });
2531
+ var DocumentationPageV2DTO = DocumentationPageStructureV2DTO.extend(DocumentationPageV2.shape.data.shape);
2532
+ var DocumentationHierarchyV2DTO = z127.object({
2533
+ pages: z127.array(DocumentationPageStructureV2DTO),
2534
+ groups: z127.array(DocumentationGroupStructureDTO)
2535
+ });
2536
+
2537
+ // src/api/requests/post-bulk-doc-page-elements.ts
2538
+ import { z as z128 } from "zod";
2539
+ var CreateBulkElementsInput = z128.object({
2540
+ persistentId: z128.string().uuid(),
2541
+ title: z128.string(),
2510
2542
  configuration: DocumentationItemConfiguration,
2511
- parentPersistentId: z125.string().nullish(),
2512
- afterPersistentId: z125.string().nullish()
2543
+ parentPersistentId: z128.string().nullish(),
2544
+ afterPersistentId: z128.string().nullish()
2513
2545
  });
2514
- var UpdateBulkElementsInput = z125.object({
2515
- id: z125.string(),
2516
- title: z125.string().optional(),
2546
+ var UpdateBulkElementsInput = z128.object({
2547
+ id: z128.string(),
2548
+ title: z128.string().optional(),
2517
2549
  configuration: DocumentationItemConfiguration.optional(),
2518
- parentPersistentId: z125.string().optional(),
2519
- afterPersistentId: z125.string().optional()
2520
- });
2521
- var DeleteBulkElementsInput = z125.array(z125.string());
2522
- var DuplicateBulkElementsInput = z125.object({
2523
- id: z125.string(),
2524
- persistentId: z125.string().uuid(),
2525
- parentPersistentId: z125.string().uuid(),
2526
- afterPersistentId: z125.string().uuid().nullish()
2527
- });
2528
- var BulkEditDocPageElementsInput = z125.object({
2529
- documentationPages: z125.object({
2530
- create: z125.array(CreateBulkElementsInput).optional(),
2531
- update: z125.array(UpdateBulkElementsInput).optional(),
2550
+ parentPersistentId: z128.string().optional(),
2551
+ afterPersistentId: z128.string().optional()
2552
+ });
2553
+ var DeleteBulkElementsInput = z128.array(z128.string());
2554
+ var DuplicateBulkElementsInput = z128.object({
2555
+ id: z128.string(),
2556
+ persistentId: z128.string().uuid(),
2557
+ parentPersistentId: z128.string().uuid(),
2558
+ afterPersistentId: z128.string().uuid().nullish()
2559
+ });
2560
+ var BulkEditDocPageElementsInput = z128.object({
2561
+ documentationPages: z128.object({
2562
+ create: z128.array(CreateBulkElementsInput).optional(),
2563
+ update: z128.array(UpdateBulkElementsInput).optional(),
2532
2564
  delete: DeleteBulkElementsInput.optional(),
2533
- duplicate: z125.array(DuplicateBulkElementsInput).optional()
2565
+ duplicate: z128.array(DuplicateBulkElementsInput).optional()
2534
2566
  })
2535
2567
  });
2536
2568
 
2537
2569
  // src/api/requests/post-liveblocks-auth.ts
2538
- import { z as z126 } from "zod";
2539
- var PostLiveblocksAuth = z126.object({
2540
- room: z126.string()
2570
+ import { z as z129 } from "zod";
2571
+ var PostLiveblocksAuth = z129.object({
2572
+ room: z129.string()
2541
2573
  });
2542
2574
 
2543
2575
  // src/api/responses/get-block-definitions.ts
2544
- import { z as z127 } from "zod";
2545
- var GetBlockDefinitionsResponse = z127.object({
2546
- definitions: z127.array(PageBlockDefinition)
2576
+ import { z as z130 } from "zod";
2577
+ var GetBlockDefinitionsResponse = z130.object({
2578
+ definitions: z130.array(PageBlockDefinition)
2547
2579
  });
2548
2580
 
2581
+ // src/design-system-content/documentation-hierarchy.ts
2582
+ function documentationHierarchyToYjs(documentationHierarchy, doc) {
2583
+ doc.transact((trx) => {
2584
+ const pagesMap = trx.doc.getMap("documentationPages");
2585
+ documentationHierarchy.pages.forEach((page) => {
2586
+ pagesMap.set(page.persistentId, page);
2587
+ });
2588
+ const groupsMap = trx.doc.getMap("documentationGroups");
2589
+ documentationHierarchy.groups.forEach((group) => {
2590
+ groupsMap.set(group.persistentId, group);
2591
+ });
2592
+ });
2593
+ return doc;
2594
+ }
2595
+ function yjsToDocumentationHierarchy(doc) {
2596
+ const pagesMap = doc.getMap("documentationPages");
2597
+ const groupsMap = doc.getMap("documentationGroups");
2598
+ const pages = [];
2599
+ pagesMap.forEach((page) => {
2600
+ pages.push(DocumentationPageStructureV2DTO.parse(page));
2601
+ });
2602
+ const groups = [];
2603
+ groupsMap.forEach((group) => {
2604
+ groups.push(DocumentationGroupStructureDTO.parse(group));
2605
+ });
2606
+ return {
2607
+ pages,
2608
+ groups
2609
+ };
2610
+ }
2611
+
2612
+ // src/design-system-content/item-configuration.ts
2613
+ function itemConfigurationToYjs(item, yDoc) {
2614
+ yDoc.transact((trx) => {
2615
+ const header = item.header;
2616
+ if (header) {
2617
+ const headerYMap = trx.doc.getMap("itemHeader");
2618
+ header.description !== void 0 && headerYMap.set("description", header.description);
2619
+ header.alignment !== void 0 && headerYMap.set("alignment", header.alignment);
2620
+ header.foregroundColor !== void 0 && headerYMap.set("foregroundColor", header.foregroundColor);
2621
+ header.backgroundColor !== void 0 && headerYMap.set("backgroundColor", header.backgroundColor);
2622
+ header.backgroundImageAsset !== void 0 && headerYMap.set("backgroundImageAsset", header.backgroundImageAsset);
2623
+ header.backgroundImageScaleType !== void 0 && headerYMap.set("backgroundImageScaleType", header.backgroundImageScaleType);
2624
+ header.showBackgroundOverlay !== void 0 && headerYMap.set("showBackgroundOverlay", header.showBackgroundOverlay);
2625
+ header.showCoverText !== void 0 && headerYMap.set("showCoverText", header.showCoverText);
2626
+ header.minHeight !== void 0 && headerYMap.set("minHeight", header.minHeight);
2627
+ }
2628
+ if (item.showSidebar !== void 0) {
2629
+ const configYMap = trx.doc.getMap("itemConfiguration");
2630
+ configYMap.set("showSidebar", item.showSidebar);
2631
+ }
2632
+ });
2633
+ }
2634
+ function yjsToItemConfiguration(yDoc) {
2635
+ const headerYMap = yDoc.getMap("itemHeader");
2636
+ const rawHeader = {
2637
+ description: headerYMap.get("description"),
2638
+ alignment: headerYMap.get("alignment"),
2639
+ foregroundColor: headerYMap.get("foregroundColor"),
2640
+ backgroundColor: headerYMap.get("backgroundColor"),
2641
+ backgroundImageAsset: headerYMap.get("backgroundImageAsset"),
2642
+ backgroundImageScaleType: headerYMap.get("backgroundImageScaleType"),
2643
+ showBackgroundOverlay: headerYMap.get("showBackgroundOverlay"),
2644
+ showCoverText: headerYMap.get("showCoverText"),
2645
+ minHeight: headerYMap.get("minHeight")
2646
+ };
2647
+ const configYMap = yDoc.getMap("itemConfiguration");
2648
+ const rawConfig = {
2649
+ showSidebar: configYMap.get("showSidebar"),
2650
+ header: rawHeader
2651
+ };
2652
+ return DocumentationItemConfiguration.parse(rawConfig);
2653
+ }
2654
+
2549
2655
  // src/docs-editor/model/block.ts
2550
- import { z as z128 } from "zod";
2551
- var PageBlockEditorModel = z128.object({
2552
- id: z128.string(),
2656
+ import { z as z131 } from "zod";
2657
+ var PageBlockEditorModel = z131.object({
2658
+ id: z131.string(),
2553
2659
  data: PageBlockDataV2
2554
2660
  });
2555
2661
 
2556
2662
  // src/docs-editor/model/page.ts
2557
- import { z as z129 } from "zod";
2558
- var DocumentationPageEditorModel = z129.object({
2559
- blocks: z129.array(PageBlockEditorModel)
2663
+ import { z as z132 } from "zod";
2664
+ var DocumentationPageEditorModel = z132.object({
2665
+ blocks: z132.array(PageBlockEditorModel)
2560
2666
  });
2561
2667
 
2562
2668
  // src/docs-editor/prosemirror/schema.ts
@@ -5694,7 +5800,10 @@ var blocks = [
5694
5800
 
5695
5801
  // src/docs-editor/prosemirror-to-blocks.ts
5696
5802
  import { yXmlFragmentToProsemirrorJSON } from "y-prosemirror";
5697
- function yXmlFragmetToPage(fragment, definitions) {
5803
+ function yDocToPage(yDoc, definitions) {
5804
+ return yXmlFragmentToPage(yDoc.getXmlFragment("default"), definitions);
5805
+ }
5806
+ function yXmlFragmentToPage(fragment, definitions) {
5698
5807
  const prosemirrorJson = yXmlFragmentToProsemirrorJSON(fragment);
5699
5808
  return prosemirrorDocToPage(prosemirrorJson, definitions);
5700
5809
  }
@@ -6149,7 +6258,13 @@ export {
6149
6258
  BulkEditDocPageElementsInput,
6150
6259
  CreateBulkElementsInput,
6151
6260
  DeleteBulkElementsInput,
6261
+ DocumentationGroupDTO,
6262
+ DocumentationGroupStructureDTO,
6263
+ DocumentationHierarchyV2DTO,
6152
6264
  DocumentationPageEditorModel,
6265
+ DocumentationPageStructureV2DTO,
6266
+ DocumentationPageV1DTO,
6267
+ DocumentationPageV2DTO,
6153
6268
  DuplicateBulkElementsInput,
6154
6269
  GetBlockDefinitionsResponse,
6155
6270
  PageBlockEditorModel,
@@ -6157,13 +6272,18 @@ export {
6157
6272
  UpdateBulkElementsInput,
6158
6273
  blockDefinitionForBlock,
6159
6274
  blockToProsemirrorNode,
6275
+ documentationHierarchyToYjs,
6160
6276
  getMockPageBlockDefinitions,
6277
+ itemConfigurationToYjs,
6161
6278
  pageToProsemirrorDoc,
6162
6279
  pageToYXmlFragment,
6163
6280
  pmSchema,
6164
6281
  prosemirrorDocToPage,
6165
6282
  prosemirrorNodeToBlock,
6166
6283
  serializeAsCustomBlock,
6167
- yXmlFragmetToPage
6284
+ yDocToPage,
6285
+ yXmlFragmentToPage,
6286
+ yjsToDocumentationHierarchy,
6287
+ yjsToItemConfiguration
6168
6288
  };
6169
6289
  //# sourceMappingURL=index.mjs.map