@supernova-studio/client 0.47.38 → 0.47.39

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 CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _supernova_studio_model from '@supernova-studio/model';
2
- import { PageBlockV1, DocumentationPageV2, ElementGroup, DocumentationGroupV1, DocumentationPageV1, DocumentationItemConfigurationV1, DocumentationItemConfigurationV2, Pipeline, GitOrganization, GitProject, GitRepository, GitBranch, ExtendedIntegration, IntegrationCredentials, SsoProvider, PageBlockItemUntypedValue, PageBlockDefinition, PageBlockText, PageBlockDefinitionProperty, PageBlockDefinitionMultiRichTextPropertyStyle, PageBlockItemV2, PageBlockItemRichTextValue, PageBlockItemMultiRichTextValue, PageBlockItemTableValue, PageBlockItemEmbedValue, PageBlockDefinitionPropertyType } from '@supernova-studio/model';
2
+ import { PageBlockV1, DocumentationPageV2, ElementGroup, DesignElementSnapshot, DocumentationGroupV1, DocumentationPageV1, DocumentationItemConfigurationV1, DocumentationItemConfigurationV2, Pipeline, GitOrganization, GitProject, GitRepository, GitBranch, ExtendedIntegration, IntegrationCredentials, SsoProvider, PageBlockItemUntypedValue, PageBlockDefinition, PageBlockText, PageBlockDefinitionProperty, PageBlockDefinitionMultiRichTextPropertyStyle, PageBlockItemV2, PageBlockItemRichTextValue, PageBlockItemMultiRichTextValue, PageBlockItemTableValue, PageBlockItemEmbedValue, PageBlockDefinitionPropertyType } from '@supernova-studio/model';
3
3
  import * as zod from 'zod';
4
4
  import { z, ZodTypeDef } from 'zod';
5
5
  import * as Y from 'yjs';
@@ -15329,6 +15329,10 @@ declare const DTODocumentationPageV2: z.ZodObject<z.objectUtil.extendShape<Omit<
15329
15329
  type: z.ZodLiteral<"Page">;
15330
15330
  configuration: z.ZodObject<{
15331
15331
  showSidebar: z.ZodBoolean;
15332
+ /**
15333
+ * Structure DTO is element properties minus element data (in other words data required
15334
+ * to display the element in the left panel)
15335
+ */
15332
15336
  isPrivate: z.ZodBoolean;
15333
15337
  isHidden: z.ZodBoolean;
15334
15338
  header: z.ZodObject<{
@@ -16204,6 +16208,10 @@ declare const DTODocumentationPageStructureV2: z.ZodObject<z.objectUtil.extendSh
16204
16208
  type: z.ZodLiteral<"Page">;
16205
16209
  configuration: z.ZodObject<{
16206
16210
  showSidebar: z.ZodBoolean;
16211
+ /**
16212
+ * Structure DTO is element properties minus element data (in other words data required
16213
+ * to display the element in the left panel)
16214
+ */
16207
16215
  isPrivate: z.ZodBoolean;
16208
16216
  isHidden: z.ZodBoolean;
16209
16217
  header: z.ZodObject<{
@@ -17080,6 +17088,10 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
17080
17088
  type: z.ZodLiteral<"Page">;
17081
17089
  configuration: z.ZodObject<{
17082
17090
  showSidebar: z.ZodBoolean;
17091
+ /**
17092
+ * Structure DTO is element properties minus element data (in other words data required
17093
+ * to display the element in the left panel)
17094
+ */
17083
17095
  isPrivate: z.ZodBoolean;
17084
17096
  isHidden: z.ZodBoolean;
17085
17097
  header: z.ZodObject<{
@@ -17588,6 +17600,10 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
17588
17600
  shortPersistentId: z.ZodString;
17589
17601
  configuration: z.ZodObject<{
17590
17602
  showSidebar: z.ZodBoolean;
17603
+ /**
17604
+ * Structure DTO is element properties minus element data (in other words data required
17605
+ * to display the element in the left panel)
17606
+ */
17591
17607
  isPrivate: z.ZodBoolean;
17592
17608
  isHidden: z.ZodBoolean;
17593
17609
  header: z.ZodObject<{
@@ -17870,6 +17886,40 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
17870
17886
  slug?: string | undefined;
17871
17887
  userSlug?: string | undefined;
17872
17888
  }>, "many">;
17889
+ publishedPagesSnapshots: z.ZodArray<z.ZodObject<{
17890
+ id: z.ZodString;
17891
+ designSystemVersionId: z.ZodString;
17892
+ elementId: z.ZodString;
17893
+ elementType: z.ZodUnion<[z.ZodEnum<["Color", "Border", "Gradient", "Shadow", "Dimension", "Duration", "Size", "Space", "Opacity", "FontSize", "LineHeight", "LetterSpacing", "ParagraphSpacing", "BorderWidth", "BorderRadius", "Duration", "ZIndex", "Image", "String", "ProductCopy", "FontFamily", "FontWeight", "TextDecoration", "TextCase", "Visibility", "Typography", "Blur", "Font"]>, z.ZodEnum<["Component", "Theme", "Documentation", "DocumentationPage", "DesignSystemComponent", "ElementGroup", "FigmaNodeStructure", "FigmaNodeReference", "PageBlock"]>]>;
17894
+ elementPersistentId: z.ZodString;
17895
+ elementParentPersistentId: z.ZodString;
17896
+ elementName: z.ZodString;
17897
+ hash: z.ZodString;
17898
+ storageKey: z.ZodString;
17899
+ createdAt: z.ZodDate;
17900
+ }, "strip", z.ZodTypeAny, {
17901
+ id: string;
17902
+ createdAt: Date;
17903
+ designSystemVersionId: string;
17904
+ elementId: string;
17905
+ elementType: "Documentation" | "Theme" | "Component" | "DocumentationPage" | "Image" | "Font" | "Color" | "Border" | "Gradient" | "Shadow" | "Dimension" | "Duration" | "Size" | "Space" | "Opacity" | "FontSize" | "LineHeight" | "LetterSpacing" | "ParagraphSpacing" | "BorderWidth" | "BorderRadius" | "ZIndex" | "String" | "ProductCopy" | "FontFamily" | "FontWeight" | "TextDecoration" | "TextCase" | "Visibility" | "Typography" | "Blur" | "DesignSystemComponent" | "ElementGroup" | "FigmaNodeStructure" | "FigmaNodeReference" | "PageBlock";
17906
+ elementPersistentId: string;
17907
+ elementParentPersistentId: string;
17908
+ elementName: string;
17909
+ hash: string;
17910
+ storageKey: string;
17911
+ }, {
17912
+ id: string;
17913
+ createdAt: Date;
17914
+ designSystemVersionId: string;
17915
+ elementId: string;
17916
+ elementType: "Documentation" | "Theme" | "Component" | "DocumentationPage" | "Image" | "Font" | "Color" | "Border" | "Gradient" | "Shadow" | "Dimension" | "Duration" | "Size" | "Space" | "Opacity" | "FontSize" | "LineHeight" | "LetterSpacing" | "ParagraphSpacing" | "BorderWidth" | "BorderRadius" | "ZIndex" | "String" | "ProductCopy" | "FontFamily" | "FontWeight" | "TextDecoration" | "TextCase" | "Visibility" | "Typography" | "Blur" | "DesignSystemComponent" | "ElementGroup" | "FigmaNodeStructure" | "FigmaNodeReference" | "PageBlock";
17917
+ elementPersistentId: string;
17918
+ elementParentPersistentId: string;
17919
+ elementName: string;
17920
+ hash: string;
17921
+ storageKey: string;
17922
+ }>, "many">;
17873
17923
  }, "strip", z.ZodTypeAny, {
17874
17924
  pages: {
17875
17925
  id: string;
@@ -17963,6 +18013,18 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
17963
18013
  slug?: string | undefined;
17964
18014
  userSlug?: string | undefined;
17965
18015
  }[];
18016
+ publishedPagesSnapshots: {
18017
+ id: string;
18018
+ createdAt: Date;
18019
+ designSystemVersionId: string;
18020
+ elementId: string;
18021
+ elementType: "Documentation" | "Theme" | "Component" | "DocumentationPage" | "Image" | "Font" | "Color" | "Border" | "Gradient" | "Shadow" | "Dimension" | "Duration" | "Size" | "Space" | "Opacity" | "FontSize" | "LineHeight" | "LetterSpacing" | "ParagraphSpacing" | "BorderWidth" | "BorderRadius" | "ZIndex" | "String" | "ProductCopy" | "FontFamily" | "FontWeight" | "TextDecoration" | "TextCase" | "Visibility" | "Typography" | "Blur" | "DesignSystemComponent" | "ElementGroup" | "FigmaNodeStructure" | "FigmaNodeReference" | "PageBlock";
18022
+ elementPersistentId: string;
18023
+ elementParentPersistentId: string;
18024
+ elementName: string;
18025
+ hash: string;
18026
+ storageKey: string;
18027
+ }[];
17966
18028
  }, {
17967
18029
  pages: {
17968
18030
  id: string;
@@ -18056,6 +18118,18 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
18056
18118
  slug?: string | undefined;
18057
18119
  userSlug?: string | undefined;
18058
18120
  }[];
18121
+ publishedPagesSnapshots: {
18122
+ id: string;
18123
+ createdAt: Date;
18124
+ designSystemVersionId: string;
18125
+ elementId: string;
18126
+ elementType: "Documentation" | "Theme" | "Component" | "DocumentationPage" | "Image" | "Font" | "Color" | "Border" | "Gradient" | "Shadow" | "Dimension" | "Duration" | "Size" | "Space" | "Opacity" | "FontSize" | "LineHeight" | "LetterSpacing" | "ParagraphSpacing" | "BorderWidth" | "BorderRadius" | "ZIndex" | "String" | "ProductCopy" | "FontFamily" | "FontWeight" | "TextDecoration" | "TextCase" | "Visibility" | "Typography" | "Blur" | "DesignSystemComponent" | "ElementGroup" | "FigmaNodeStructure" | "FigmaNodeReference" | "PageBlock";
18127
+ elementPersistentId: string;
18128
+ elementParentPersistentId: string;
18129
+ elementName: string;
18130
+ hash: string;
18131
+ storageKey: string;
18132
+ }[];
18059
18133
  }>;
18060
18134
  type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;
18061
18135
  declare const DTOCreateDocumentationPageInputV2: z.ZodObject<{
@@ -32820,7 +32894,7 @@ declare const DTOWorkspace: z.ZodObject<{
32820
32894
  }>;
32821
32895
  type DTOWorkspace = z.infer<typeof DTOWorkspace>;
32822
32896
 
32823
- declare function documentationElementsToHierarchyDto(docPages: DocumentationPageV2[], docGroups: ElementGroup[], routingVersion: string): DTODocumentationHierarchyV2;
32897
+ declare function documentationElementsToHierarchyDto(docPages: DocumentationPageV2[], docGroups: ElementGroup[], publishedPagesSnapshots: DesignElementSnapshot[], routingVersion: string): DTODocumentationHierarchyV2;
32824
32898
 
32825
32899
  declare function elementGroupsToDocumentationGroupStructureDTOV1(groups: DocumentationGroupV1[], pages: (DocumentationPageV1 | DocumentationPageV2)[]): DTODocumentationGroupStructureV1[];
32826
32900
  declare function elementGroupsToDocumentationGroupDTOV1(groups: DocumentationGroupV1[], pages: (DocumentationPageV1 | DocumentationPageV2)[]): DTODocumentationGroupV1[];
@@ -34968,14 +35042,18 @@ type DocumentationHierarchyTransaction = {
34968
35042
  groups: ElementGroup[];
34969
35043
  pageIdsToDelete: string[];
34970
35044
  groupIdsToDelete: string[];
35045
+ publishedPageSnapshots: DesignElementSnapshot[];
34971
35046
  internalSettings: DocumentationHierarchySettings | undefined;
34972
35047
  };
34973
35048
  declare const DocumentationHierarchySettings: z.ZodObject<{
34974
35049
  routingVersion: z.ZodString;
35050
+ isDraftFeatureAdopted: z.ZodBoolean;
34975
35051
  }, "strip", z.ZodTypeAny, {
34976
35052
  routingVersion: string;
35053
+ isDraftFeatureAdopted: boolean;
34977
35054
  }, {
34978
35055
  routingVersion: string;
35056
+ isDraftFeatureAdopted: boolean;
34979
35057
  }>;
34980
35058
  type DocumentationHierarchySettings = z.infer<typeof DocumentationHierarchySettings>;
34981
35059
  declare function documentationHierarchyToYjs(doc: Y.Doc, transaction: DocumentationHierarchyTransaction): Y.Doc;
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _supernova_studio_model from '@supernova-studio/model';
2
- import { PageBlockV1, DocumentationPageV2, ElementGroup, DocumentationGroupV1, DocumentationPageV1, DocumentationItemConfigurationV1, DocumentationItemConfigurationV2, Pipeline, GitOrganization, GitProject, GitRepository, GitBranch, ExtendedIntegration, IntegrationCredentials, SsoProvider, PageBlockItemUntypedValue, PageBlockDefinition, PageBlockText, PageBlockDefinitionProperty, PageBlockDefinitionMultiRichTextPropertyStyle, PageBlockItemV2, PageBlockItemRichTextValue, PageBlockItemMultiRichTextValue, PageBlockItemTableValue, PageBlockItemEmbedValue, PageBlockDefinitionPropertyType } from '@supernova-studio/model';
2
+ import { PageBlockV1, DocumentationPageV2, ElementGroup, DesignElementSnapshot, DocumentationGroupV1, DocumentationPageV1, DocumentationItemConfigurationV1, DocumentationItemConfigurationV2, Pipeline, GitOrganization, GitProject, GitRepository, GitBranch, ExtendedIntegration, IntegrationCredentials, SsoProvider, PageBlockItemUntypedValue, PageBlockDefinition, PageBlockText, PageBlockDefinitionProperty, PageBlockDefinitionMultiRichTextPropertyStyle, PageBlockItemV2, PageBlockItemRichTextValue, PageBlockItemMultiRichTextValue, PageBlockItemTableValue, PageBlockItemEmbedValue, PageBlockDefinitionPropertyType } from '@supernova-studio/model';
3
3
  import * as zod from 'zod';
4
4
  import { z, ZodTypeDef } from 'zod';
5
5
  import * as Y from 'yjs';
@@ -15329,6 +15329,10 @@ declare const DTODocumentationPageV2: z.ZodObject<z.objectUtil.extendShape<Omit<
15329
15329
  type: z.ZodLiteral<"Page">;
15330
15330
  configuration: z.ZodObject<{
15331
15331
  showSidebar: z.ZodBoolean;
15332
+ /**
15333
+ * Structure DTO is element properties minus element data (in other words data required
15334
+ * to display the element in the left panel)
15335
+ */
15332
15336
  isPrivate: z.ZodBoolean;
15333
15337
  isHidden: z.ZodBoolean;
15334
15338
  header: z.ZodObject<{
@@ -16204,6 +16208,10 @@ declare const DTODocumentationPageStructureV2: z.ZodObject<z.objectUtil.extendSh
16204
16208
  type: z.ZodLiteral<"Page">;
16205
16209
  configuration: z.ZodObject<{
16206
16210
  showSidebar: z.ZodBoolean;
16211
+ /**
16212
+ * Structure DTO is element properties minus element data (in other words data required
16213
+ * to display the element in the left panel)
16214
+ */
16207
16215
  isPrivate: z.ZodBoolean;
16208
16216
  isHidden: z.ZodBoolean;
16209
16217
  header: z.ZodObject<{
@@ -17080,6 +17088,10 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
17080
17088
  type: z.ZodLiteral<"Page">;
17081
17089
  configuration: z.ZodObject<{
17082
17090
  showSidebar: z.ZodBoolean;
17091
+ /**
17092
+ * Structure DTO is element properties minus element data (in other words data required
17093
+ * to display the element in the left panel)
17094
+ */
17083
17095
  isPrivate: z.ZodBoolean;
17084
17096
  isHidden: z.ZodBoolean;
17085
17097
  header: z.ZodObject<{
@@ -17588,6 +17600,10 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
17588
17600
  shortPersistentId: z.ZodString;
17589
17601
  configuration: z.ZodObject<{
17590
17602
  showSidebar: z.ZodBoolean;
17603
+ /**
17604
+ * Structure DTO is element properties minus element data (in other words data required
17605
+ * to display the element in the left panel)
17606
+ */
17591
17607
  isPrivate: z.ZodBoolean;
17592
17608
  isHidden: z.ZodBoolean;
17593
17609
  header: z.ZodObject<{
@@ -17870,6 +17886,40 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
17870
17886
  slug?: string | undefined;
17871
17887
  userSlug?: string | undefined;
17872
17888
  }>, "many">;
17889
+ publishedPagesSnapshots: z.ZodArray<z.ZodObject<{
17890
+ id: z.ZodString;
17891
+ designSystemVersionId: z.ZodString;
17892
+ elementId: z.ZodString;
17893
+ elementType: z.ZodUnion<[z.ZodEnum<["Color", "Border", "Gradient", "Shadow", "Dimension", "Duration", "Size", "Space", "Opacity", "FontSize", "LineHeight", "LetterSpacing", "ParagraphSpacing", "BorderWidth", "BorderRadius", "Duration", "ZIndex", "Image", "String", "ProductCopy", "FontFamily", "FontWeight", "TextDecoration", "TextCase", "Visibility", "Typography", "Blur", "Font"]>, z.ZodEnum<["Component", "Theme", "Documentation", "DocumentationPage", "DesignSystemComponent", "ElementGroup", "FigmaNodeStructure", "FigmaNodeReference", "PageBlock"]>]>;
17894
+ elementPersistentId: z.ZodString;
17895
+ elementParentPersistentId: z.ZodString;
17896
+ elementName: z.ZodString;
17897
+ hash: z.ZodString;
17898
+ storageKey: z.ZodString;
17899
+ createdAt: z.ZodDate;
17900
+ }, "strip", z.ZodTypeAny, {
17901
+ id: string;
17902
+ createdAt: Date;
17903
+ designSystemVersionId: string;
17904
+ elementId: string;
17905
+ elementType: "Documentation" | "Theme" | "Component" | "DocumentationPage" | "Image" | "Font" | "Color" | "Border" | "Gradient" | "Shadow" | "Dimension" | "Duration" | "Size" | "Space" | "Opacity" | "FontSize" | "LineHeight" | "LetterSpacing" | "ParagraphSpacing" | "BorderWidth" | "BorderRadius" | "ZIndex" | "String" | "ProductCopy" | "FontFamily" | "FontWeight" | "TextDecoration" | "TextCase" | "Visibility" | "Typography" | "Blur" | "DesignSystemComponent" | "ElementGroup" | "FigmaNodeStructure" | "FigmaNodeReference" | "PageBlock";
17906
+ elementPersistentId: string;
17907
+ elementParentPersistentId: string;
17908
+ elementName: string;
17909
+ hash: string;
17910
+ storageKey: string;
17911
+ }, {
17912
+ id: string;
17913
+ createdAt: Date;
17914
+ designSystemVersionId: string;
17915
+ elementId: string;
17916
+ elementType: "Documentation" | "Theme" | "Component" | "DocumentationPage" | "Image" | "Font" | "Color" | "Border" | "Gradient" | "Shadow" | "Dimension" | "Duration" | "Size" | "Space" | "Opacity" | "FontSize" | "LineHeight" | "LetterSpacing" | "ParagraphSpacing" | "BorderWidth" | "BorderRadius" | "ZIndex" | "String" | "ProductCopy" | "FontFamily" | "FontWeight" | "TextDecoration" | "TextCase" | "Visibility" | "Typography" | "Blur" | "DesignSystemComponent" | "ElementGroup" | "FigmaNodeStructure" | "FigmaNodeReference" | "PageBlock";
17917
+ elementPersistentId: string;
17918
+ elementParentPersistentId: string;
17919
+ elementName: string;
17920
+ hash: string;
17921
+ storageKey: string;
17922
+ }>, "many">;
17873
17923
  }, "strip", z.ZodTypeAny, {
17874
17924
  pages: {
17875
17925
  id: string;
@@ -17963,6 +18013,18 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
17963
18013
  slug?: string | undefined;
17964
18014
  userSlug?: string | undefined;
17965
18015
  }[];
18016
+ publishedPagesSnapshots: {
18017
+ id: string;
18018
+ createdAt: Date;
18019
+ designSystemVersionId: string;
18020
+ elementId: string;
18021
+ elementType: "Documentation" | "Theme" | "Component" | "DocumentationPage" | "Image" | "Font" | "Color" | "Border" | "Gradient" | "Shadow" | "Dimension" | "Duration" | "Size" | "Space" | "Opacity" | "FontSize" | "LineHeight" | "LetterSpacing" | "ParagraphSpacing" | "BorderWidth" | "BorderRadius" | "ZIndex" | "String" | "ProductCopy" | "FontFamily" | "FontWeight" | "TextDecoration" | "TextCase" | "Visibility" | "Typography" | "Blur" | "DesignSystemComponent" | "ElementGroup" | "FigmaNodeStructure" | "FigmaNodeReference" | "PageBlock";
18022
+ elementPersistentId: string;
18023
+ elementParentPersistentId: string;
18024
+ elementName: string;
18025
+ hash: string;
18026
+ storageKey: string;
18027
+ }[];
17966
18028
  }, {
17967
18029
  pages: {
17968
18030
  id: string;
@@ -18056,6 +18118,18 @@ declare const DTODocumentationHierarchyV2: z.ZodObject<{
18056
18118
  slug?: string | undefined;
18057
18119
  userSlug?: string | undefined;
18058
18120
  }[];
18121
+ publishedPagesSnapshots: {
18122
+ id: string;
18123
+ createdAt: Date;
18124
+ designSystemVersionId: string;
18125
+ elementId: string;
18126
+ elementType: "Documentation" | "Theme" | "Component" | "DocumentationPage" | "Image" | "Font" | "Color" | "Border" | "Gradient" | "Shadow" | "Dimension" | "Duration" | "Size" | "Space" | "Opacity" | "FontSize" | "LineHeight" | "LetterSpacing" | "ParagraphSpacing" | "BorderWidth" | "BorderRadius" | "ZIndex" | "String" | "ProductCopy" | "FontFamily" | "FontWeight" | "TextDecoration" | "TextCase" | "Visibility" | "Typography" | "Blur" | "DesignSystemComponent" | "ElementGroup" | "FigmaNodeStructure" | "FigmaNodeReference" | "PageBlock";
18127
+ elementPersistentId: string;
18128
+ elementParentPersistentId: string;
18129
+ elementName: string;
18130
+ hash: string;
18131
+ storageKey: string;
18132
+ }[];
18059
18133
  }>;
18060
18134
  type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;
18061
18135
  declare const DTOCreateDocumentationPageInputV2: z.ZodObject<{
@@ -32820,7 +32894,7 @@ declare const DTOWorkspace: z.ZodObject<{
32820
32894
  }>;
32821
32895
  type DTOWorkspace = z.infer<typeof DTOWorkspace>;
32822
32896
 
32823
- declare function documentationElementsToHierarchyDto(docPages: DocumentationPageV2[], docGroups: ElementGroup[], routingVersion: string): DTODocumentationHierarchyV2;
32897
+ declare function documentationElementsToHierarchyDto(docPages: DocumentationPageV2[], docGroups: ElementGroup[], publishedPagesSnapshots: DesignElementSnapshot[], routingVersion: string): DTODocumentationHierarchyV2;
32824
32898
 
32825
32899
  declare function elementGroupsToDocumentationGroupStructureDTOV1(groups: DocumentationGroupV1[], pages: (DocumentationPageV1 | DocumentationPageV2)[]): DTODocumentationGroupStructureV1[];
32826
32900
  declare function elementGroupsToDocumentationGroupDTOV1(groups: DocumentationGroupV1[], pages: (DocumentationPageV1 | DocumentationPageV2)[]): DTODocumentationGroupV1[];
@@ -34968,14 +35042,18 @@ type DocumentationHierarchyTransaction = {
34968
35042
  groups: ElementGroup[];
34969
35043
  pageIdsToDelete: string[];
34970
35044
  groupIdsToDelete: string[];
35045
+ publishedPageSnapshots: DesignElementSnapshot[];
34971
35046
  internalSettings: DocumentationHierarchySettings | undefined;
34972
35047
  };
34973
35048
  declare const DocumentationHierarchySettings: z.ZodObject<{
34974
35049
  routingVersion: z.ZodString;
35050
+ isDraftFeatureAdopted: z.ZodBoolean;
34975
35051
  }, "strip", z.ZodTypeAny, {
34976
35052
  routingVersion: string;
35053
+ isDraftFeatureAdopted: boolean;
34977
35054
  }, {
34978
35055
  routingVersion: string;
35056
+ isDraftFeatureAdopted: boolean;
34979
35057
  }>;
34980
35058
  type DocumentationHierarchySettings = z.infer<typeof DocumentationHierarchySettings>;
34981
35059
  declare function documentationHierarchyToYjs(doc: Y.Doc, transaction: DocumentationHierarchyTransaction): Y.Doc;
package/dist/index.js CHANGED
@@ -114,6 +114,7 @@ var _zod = require('zod');
114
114
 
115
115
 
116
116
 
117
+
117
118
 
118
119
 
119
120
  var _ipcidr = require('ip-cidr'); var _ipcidr2 = _interopRequireDefault(_ipcidr);
@@ -534,6 +535,53 @@ var Asset = _zod.z.object({
534
535
  var ResolvedAsset = Asset.extend({
535
536
  url: _zod.z.string()
536
537
  });
538
+ var DesignElementOrigin = _zod.z.object({
539
+ id: _zod.z.string(),
540
+ sourceId: _zod.z.string(),
541
+ name: _zod.z.string()
542
+ });
543
+ var DesignElementBase = _zod.z.object({
544
+ id: _zod.z.string(),
545
+ persistentId: _zod.z.string(),
546
+ meta: ObjectMeta,
547
+ designSystemVersionId: _zod.z.string(),
548
+ createdAt: _zod.z.coerce.date(),
549
+ updatedAt: _zod.z.coerce.date()
550
+ });
551
+ var DesignElementImportedBase = DesignElementBase.extend({
552
+ origin: DesignElementOrigin
553
+ });
554
+ var DesignElementGroupablePart = _zod.z.object({
555
+ parentPersistentId: _zod.z.string().optional(),
556
+ sortOrder: _zod.z.number()
557
+ });
558
+ var DesignElementGroupableBase = DesignElementBase.extend(DesignElementGroupablePart.shape);
559
+ var DesignElementGroupableRequiredPart = DesignElementGroupablePart.extend({
560
+ parentPersistentId: _zod.z.string()
561
+ });
562
+ var DesignElementBrandedPart = _zod.z.object({
563
+ brandPersistentId: _zod.z.string()
564
+ });
565
+ var DesignElementSlugPart = _zod.z.object({
566
+ slug: _zod.z.string().optional(),
567
+ userSlug: _zod.z.string().optional()
568
+ });
569
+ var ComponentOriginPart = _zod.z.object({
570
+ nodeId: _zod.z.string().optional(),
571
+ width: _zod.z.number().optional(),
572
+ height: _zod.z.number().optional()
573
+ });
574
+ var ComponentAsset = _zod.z.object({
575
+ assetId: _zod.z.string(),
576
+ assetPath: _zod.z.string()
577
+ });
578
+ var ComponentOrigin = DesignElementOrigin.extend(ComponentOriginPart.shape);
579
+ var Component = DesignElementBase.extend(DesignElementGroupableRequiredPart.shape).extend(DesignElementBrandedPart.shape).extend({
580
+ origin: ComponentOrigin.optional(),
581
+ thumbnail: ComponentAsset,
582
+ svg: ComponentAsset.optional(),
583
+ isAsset: _zod.z.boolean()
584
+ });
537
585
  var TokenDataAliasSchema = _zod.z.object({
538
586
  aliasTo: _zod.z.string().optional().nullable().transform((v) => _nullishCoalesce(v, () => ( void 0)))
539
587
  });
@@ -1278,37 +1326,6 @@ var DocumentationItemConfigurationV2 = _zod.z.object({
1278
1326
  var DocumentationPageDataV2 = _zod.z.object({
1279
1327
  configuration: nullishToOptional(DocumentationItemConfigurationV2)
1280
1328
  });
1281
- var DesignElementOrigin = _zod.z.object({
1282
- id: _zod.z.string(),
1283
- sourceId: _zod.z.string(),
1284
- name: _zod.z.string()
1285
- });
1286
- var DesignElementBase = _zod.z.object({
1287
- id: _zod.z.string(),
1288
- persistentId: _zod.z.string(),
1289
- meta: ObjectMeta,
1290
- designSystemVersionId: _zod.z.string(),
1291
- createdAt: _zod.z.coerce.date(),
1292
- updatedAt: _zod.z.coerce.date()
1293
- });
1294
- var DesignElementImportedBase = DesignElementBase.extend({
1295
- origin: DesignElementOrigin
1296
- });
1297
- var DesignElementGroupablePart = _zod.z.object({
1298
- parentPersistentId: _zod.z.string().optional(),
1299
- sortOrder: _zod.z.number()
1300
- });
1301
- var DesignElementGroupableBase = DesignElementBase.extend(DesignElementGroupablePart.shape);
1302
- var DesignElementGroupableRequiredPart = DesignElementGroupablePart.extend({
1303
- parentPersistentId: _zod.z.string()
1304
- });
1305
- var DesignElementBrandedPart = _zod.z.object({
1306
- brandPersistentId: _zod.z.string()
1307
- });
1308
- var DesignElementSlugPart = _zod.z.object({
1309
- slug: _zod.z.string().optional(),
1310
- userSlug: _zod.z.string().optional()
1311
- });
1312
1329
  var PageBlockV2 = DesignElementBase.extend(DesignElementGroupableRequiredPart.shape).extend({
1313
1330
  data: PageBlockDataV2
1314
1331
  });
@@ -1515,22 +1532,6 @@ var ZIndexValue = _zod.z.object({
1515
1532
  measure: _zod.z.number()
1516
1533
  });
1517
1534
  var ZIndexTokenData = tokenAliasOrValue(ZIndexValue);
1518
- var ComponentOriginPart = _zod.z.object({
1519
- nodeId: _zod.z.string().optional(),
1520
- width: _zod.z.number().optional(),
1521
- height: _zod.z.number().optional()
1522
- });
1523
- var ComponentAsset = _zod.z.object({
1524
- assetId: _zod.z.string(),
1525
- assetPath: _zod.z.string()
1526
- });
1527
- var ComponentOrigin = DesignElementOrigin.extend(ComponentOriginPart.shape);
1528
- var Component = DesignElementBase.extend(DesignElementGroupableRequiredPart.shape).extend(DesignElementBrandedPart.shape).extend({
1529
- origin: ComponentOrigin.optional(),
1530
- thumbnail: ComponentAsset,
1531
- svg: ComponentAsset.optional(),
1532
- isAsset: _zod.z.boolean()
1533
- });
1534
1535
  var ElementGroup = DesignElementBase.extend(DesignElementGroupablePart.shape).extend(DesignElementSlugPart.shape).extend(DesignElementBrandedPart.partial().shape).extend({
1535
1536
  shortPersistentId: _zod.z.string().optional(),
1536
1537
  childType: DesignElementType,
@@ -1552,6 +1553,23 @@ var DocumentationPageV2 = DesignElementBase.extend(DesignElementGroupableRequire
1552
1553
  oldBlocks: _zod.z.array(PageBlockV1).optional()
1553
1554
  })
1554
1555
  });
1556
+ var DesignElementSnapshot = _zod.z.object({
1557
+ id: _zod.z.string(),
1558
+ // Scope
1559
+ designSystemVersionId: _zod.z.string(),
1560
+ // Metadata about the element that needs to be indexed in the db
1561
+ elementId: _zod.z.string(),
1562
+ elementType: DesignElementType,
1563
+ elementPersistentId: _zod.z.string(),
1564
+ elementParentPersistentId: _zod.z.string(),
1565
+ elementName: _zod.z.string(),
1566
+ // Computed hash to compare to current state of the element
1567
+ hash: _zod.z.string(),
1568
+ // Where is the element's full shapshot stored
1569
+ storageKey: _zod.z.string(),
1570
+ // When the element was snapshotted
1571
+ createdAt: _zod.z.coerce.date()
1572
+ });
1555
1573
  var FigmaFileStructureOrigin = _zod.z.object({
1556
1574
  sourceId: _zod.z.string(),
1557
1575
  fileId: _zod.z.string().optional()
@@ -2796,16 +2814,19 @@ var DesignSystemVersionRoom = Entity.extend({
2796
2814
  liveblocksId: _zod.z.string()
2797
2815
  });
2798
2816
  var DesignSystemVersionRoomInternalSettings = _zod.z.object({
2799
- routingVersion: _zod.z.string()
2817
+ routingVersion: _zod.z.string(),
2818
+ isDraftFeatureAdopted: _zod.z.boolean()
2800
2819
  });
2801
2820
  var DesignSystemVersionRoomInitialState = _zod.z.object({
2802
2821
  pages: _zod.z.array(DocumentationPageV2),
2803
2822
  groups: _zod.z.array(ElementGroup),
2823
+ documentationPublishedState: _zod.z.array(DesignElementSnapshot),
2804
2824
  internalSettings: DesignSystemVersionRoomInternalSettings
2805
2825
  });
2806
2826
  var DesignSystemVersionRoomUpdate = _zod.z.object({
2807
2827
  pages: _zod.z.array(DocumentationPageV2),
2808
2828
  groups: _zod.z.array(ElementGroup),
2829
+ documentationPublishedState: _zod.z.array(DesignElementSnapshot),
2809
2830
  deletedPageIds: _zod.z.array(_zod.z.string()),
2810
2831
  deletedGroupIds: _zod.z.array(_zod.z.string())
2811
2832
  });
@@ -4332,10 +4353,11 @@ function documentationPageToStructureDTOV2(page, pagePathMap) {
4332
4353
  }
4333
4354
 
4334
4355
  // src/api/conversion/documentation/documentation-elements-to-hierarchy-v2-dto.ts
4335
- function documentationElementsToHierarchyDto(docPages, docGroups, routingVersion) {
4356
+ function documentationElementsToHierarchyDto(docPages, docGroups, publishedPagesSnapshots, routingVersion) {
4336
4357
  return {
4337
4358
  pages: documentationPagesToStructureDTOV2(docPages, docGroups, routingVersion),
4338
- groups: elementGroupsToDocumentationGroupStructureDTOV2(docGroups, docPages)
4359
+ groups: elementGroupsToDocumentationGroupStructureDTOV2(docGroups, docPages),
4360
+ publishedPagesSnapshots
4339
4361
  };
4340
4362
  }
4341
4363
 
@@ -5153,7 +5175,8 @@ var DTODocumentationPageV2 = DocumentationPageV2.omit({
5153
5175
  var DTODocumentationPageStructureV2 = DTODocumentationPageV2;
5154
5176
  var DTODocumentationHierarchyV2 = _zod.z.object({
5155
5177
  pages: _zod.z.array(DTODocumentationPageStructureV2),
5156
- groups: _zod.z.array(DTODocumentationGroupStructureV2)
5178
+ groups: _zod.z.array(DTODocumentationGroupStructureV2),
5179
+ publishedPagesSnapshots: DesignElementSnapshot.array()
5157
5180
  });
5158
5181
  var DTOCreateDocumentationPageInputV2 = _zod.z.object({
5159
5182
  // Identifier
@@ -5660,7 +5683,8 @@ var DTOUserWorkspaceMembershipsResponse = _zod.z.object({
5660
5683
  // src/yjs/design-system-content/documentation-hierarchy.ts
5661
5684
 
5662
5685
  var DocumentationHierarchySettings = _zod.z.object({
5663
- routingVersion: _zod.z.string()
5686
+ routingVersion: _zod.z.string(),
5687
+ isDraftFeatureAdopted: _zod.z.boolean()
5664
5688
  });
5665
5689
  function documentationHierarchyToYjs(doc, transaction) {
5666
5690
  doc.transact((trx) => {
@@ -5684,6 +5708,10 @@ function documentationHierarchyToYjs(doc, transaction) {
5684
5708
  transaction.groups.forEach((group) => {
5685
5709
  groupsMap.set(group.id, JSON.parse(JSON.stringify(group)));
5686
5710
  });
5711
+ const publishedSnapshotsMap = getPublishedSnapshotsYMap(trx.doc);
5712
+ transaction.publishedPageSnapshots.forEach((state) => {
5713
+ publishedSnapshotsMap.set(state.id, JSON.parse(JSON.stringify(state)));
5714
+ });
5687
5715
  if (transaction.internalSettings) {
5688
5716
  serializeDocumentationInternalSettings(trx.doc, transaction.internalSettings);
5689
5717
  }
@@ -5693,10 +5721,12 @@ function documentationHierarchyToYjs(doc, transaction) {
5693
5721
  function serializeDocumentationInternalSettings(doc, settings) {
5694
5722
  const map = getInternalSettingsYMap(doc);
5695
5723
  map.set("routingVersion", settings.routingVersion);
5724
+ settings.isDraftFeatureAdopted !== void 0 && map.set("isDraftFeatureAdapted", settings.isDraftFeatureAdopted);
5696
5725
  }
5697
5726
  function yjsToDocumentationHierarchy(doc) {
5698
5727
  const pagesMap = getPagesYMap(doc);
5699
5728
  const groupsMap = getGroupsYMap(doc);
5729
+ const publishedSnapshotsMap = getPublishedSnapshotsYMap(doc);
5700
5730
  const pages = [];
5701
5731
  pagesMap.forEach((page) => {
5702
5732
  pages.push(DocumentationPageV2.parse(page));
@@ -5705,18 +5735,31 @@ function yjsToDocumentationHierarchy(doc) {
5705
5735
  groupsMap.forEach((group) => {
5706
5736
  groups.push(ElementGroup.parse(group));
5707
5737
  });
5738
+ const publishedSnapshots = [];
5739
+ publishedSnapshotsMap.forEach((state) => {
5740
+ publishedSnapshots.push(DesignElementSnapshot.parse(state));
5741
+ });
5708
5742
  const internalSettings = parseDocumentationInternalSettings(doc);
5709
- const hierarchy = documentationElementsToHierarchyDto(pages, groups, _nullishCoalesce(internalSettings.routingVersion, () => ( "2")));
5743
+ const hierarchy = documentationElementsToHierarchyDto(
5744
+ pages,
5745
+ groups,
5746
+ publishedSnapshots,
5747
+ _nullishCoalesce(internalSettings.routingVersion, () => ( "2"))
5748
+ );
5710
5749
  return hierarchy;
5711
5750
  }
5712
5751
  function parseDocumentationInternalSettings(doc) {
5713
5752
  const map = getInternalSettingsYMap(doc);
5714
5753
  const rawSettings = {
5715
- routingVersion: map.get("routingVersion")
5754
+ routingVersion: map.get("routingVersion"),
5755
+ isDraftFeatureAdopted: _nullishCoalesce(map.get("isDraftFeatureAdapted"), () => ( false))
5716
5756
  };
5717
5757
  const settingsParseResult = DocumentationHierarchySettings.safeParse(rawSettings);
5718
5758
  if (!settingsParseResult.success) {
5719
- return { routingVersion: "2" };
5759
+ return {
5760
+ routingVersion: "2",
5761
+ isDraftFeatureAdopted: false
5762
+ };
5720
5763
  }
5721
5764
  return settingsParseResult.data;
5722
5765
  }
@@ -5729,6 +5772,9 @@ function getGroupsYMap(doc) {
5729
5772
  function getInternalSettingsYMap(doc) {
5730
5773
  return doc.getMap("documentationInternalSettings");
5731
5774
  }
5775
+ function getPublishedSnapshotsYMap(doc) {
5776
+ return doc.getMap("documentationPagePublishedSnapshots");
5777
+ }
5732
5778
 
5733
5779
  // src/yjs/design-system-content/item-configuration.ts
5734
5780