@commercetools-demo/puck-types 0.5.1 → 0.6.1

package/dist/index.d.mts

@@ -113,56 +113,6 @@ interface PuckContentVersion {
     versions: PuckContentVersionEntry[];
 }
 
-interface ThemeTokens {
-    colorPrimary: string;
-    colorPrimaryHover: string;
-    colorPrimaryForeground?: string;
-    colorSecondary: string;
-    colorSecondaryForeground?: string;
-    colorBackground: string;
-    colorSurface: string;
-    colorText: string;
-    colorTextMuted: string;
-    colorForeground?: string;
-    colorMuted?: string;
-    colorMutedForeground?: string;
-    colorDestructive?: string;
-    colorDestructiveForeground?: string;
-    colorAccent?: string;
-    colorAccentForeground?: string;
-    colorBorder?: string;
-    colorInput?: string;
-    colorRing?: string;
-    colorShadowLight?: string;
-    colorShadowDark?: string;
-    colorSurfaceGlass?: string;
-    borderRadius: 'none' | 'sm' | 'md' | 'lg' | 'full';
-    borderWidth: '0' | '1' | '2';
-    borderStyle?: 'solid' | 'dashed' | 'double';
-    fontFamily: string;
-    fontHeading: string;
-    fontWeightBase?: '300' | '400' | '500';
-    fontWeightHeading?: '400' | '500' | '700' | '900';
-    letterSpacing?: 'tight' | 'normal' | 'wide' | 'wider';
-    textTransform?: 'none' | 'uppercase';
-    spacingScale: number;
-    buttonStyle: 'solid' | 'outline' | 'ghost';
-    cardShadow: 'none' | 'sm' | 'md' | 'lg';
-    headerStyle: 'transparent' | 'solid' | 'minimal';
-    shadowStyle?: 'none' | 'soft' | 'hard-offset' | 'neumorphic' | 'clay' | 'glow';
-    surfaceBlur?: 'none' | 'sm' | 'md' | 'lg';
-    surfaceOpacity?: number;
-    backgroundStyle?: 'solid' | 'gradient' | 'noise';
-    animationStyle?: string;
-}
-interface ImportResult {
-    imported: string[];
-    failed: Array<{
-        key: string;
-        error: string;
-    }>;
-}
-
 interface MediaFile {
     url: string;
     name: string;
@@ -227,4 +177,76 @@ type PuckContentWithStatesResponse = PuckContentWithStates;
 type PuckContentStateResponse = PuckContentState;
 type PuckContentVersionResponse = PuckContentVersion;
 
-export type { CreatePuckContentInput, CreatePuckPageInput, CtCustomObject, ImportResult, MediaFile, MediaLibraryPagination, MediaLibraryResult, PuckContentListItem, PuckContentListResponse, PuckContentMeta, PuckContentResponse, PuckContentState, PuckContentStateInfo, PuckContentStateResponse, PuckContentValue, PuckContentVersion, PuckContentVersionEntry, PuckContentVersionResponse, PuckContentWithStates, PuckContentWithStatesResponse, PuckPageListItem, PuckPageListResponse, PuckPageMeta, PuckPageResponse, PuckPageState, PuckPageStateResponse, PuckPageValue, PuckPageVersion, PuckPageVersionEntry, PuckPageVersionResponse, PuckPageWithStates, PuckPageWithStatesResponse, PuckStateInfo, ThemeTokens, UpdatePuckContentInput, UpdatePuckPageInput };
+/** Whether a template seeds a page or a content item. */
+type PuckTemplateKind = 'page' | 'content';
+interface PuckTemplateValue {
+    key: string;
+    businessUnitKey: string;
+    name: string;
+    kind: PuckTemplateKind;
+    /** Puck data snapshot used to seed new pages/content (stripped or full). */
+    puckData: Data;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A template as returned by the API (custom-object wrapper). */
+type PuckTemplateListItem = CtCustomObject<PuckTemplateValue>;
+interface CreatePuckTemplateInput {
+    name: string;
+    kind: PuckTemplateKind;
+    puckData: Data;
+}
+type PuckTemplateResponse = CtCustomObject<PuckTemplateValue>;
+type PuckTemplateListResponse = PuckTemplateListItem[];
+
+interface ThemeTokens {
+    colorPrimary: string;
+    colorPrimaryHover: string;
+    colorPrimaryForeground?: string;
+    colorSecondary: string;
+    colorSecondaryForeground?: string;
+    colorBackground: string;
+    colorSurface: string;
+    colorText: string;
+    colorTextMuted: string;
+    colorForeground?: string;
+    colorMuted?: string;
+    colorMutedForeground?: string;
+    colorDestructive?: string;
+    colorDestructiveForeground?: string;
+    colorAccent?: string;
+    colorAccentForeground?: string;
+    colorBorder?: string;
+    colorInput?: string;
+    colorRing?: string;
+    colorShadowLight?: string;
+    colorShadowDark?: string;
+    colorSurfaceGlass?: string;
+    borderRadius: 'none' | 'sm' | 'md' | 'lg' | 'full';
+    borderWidth: '0' | '1' | '2';
+    borderStyle?: 'solid' | 'dashed' | 'double';
+    fontFamily: string;
+    fontHeading: string;
+    fontWeightBase?: '300' | '400' | '500';
+    fontWeightHeading?: '400' | '500' | '700' | '900';
+    letterSpacing?: 'tight' | 'normal' | 'wide' | 'wider';
+    textTransform?: 'none' | 'uppercase';
+    spacingScale: number;
+    buttonStyle: 'solid' | 'outline' | 'ghost';
+    cardShadow: 'none' | 'sm' | 'md' | 'lg';
+    headerStyle: 'transparent' | 'solid' | 'minimal';
+    shadowStyle?: 'none' | 'soft' | 'hard-offset' | 'neumorphic' | 'clay' | 'glow';
+    surfaceBlur?: 'none' | 'sm' | 'md' | 'lg';
+    surfaceOpacity?: number;
+    backgroundStyle?: 'solid' | 'gradient' | 'noise';
+    animationStyle?: string;
+}
+interface ImportResult {
+    imported: string[];
+    failed: Array<{
+        key: string;
+        error: string;
+    }>;
+}
+
+export type { CreatePuckContentInput, CreatePuckPageInput, CreatePuckTemplateInput, CtCustomObject, ImportResult, MediaFile, MediaLibraryPagination, MediaLibraryResult, PuckContentListItem, PuckContentListResponse, PuckContentMeta, PuckContentResponse, PuckContentState, PuckContentStateInfo, PuckContentStateResponse, PuckContentValue, PuckContentVersion, PuckContentVersionEntry, PuckContentVersionResponse, PuckContentWithStates, PuckContentWithStatesResponse, PuckPageListItem, PuckPageListResponse, PuckPageMeta, PuckPageResponse, PuckPageState, PuckPageStateResponse, PuckPageValue, PuckPageVersion, PuckPageVersionEntry, PuckPageVersionResponse, PuckPageWithStates, PuckPageWithStatesResponse, PuckStateInfo, PuckTemplateKind, PuckTemplateListItem, PuckTemplateListResponse, PuckTemplateResponse, PuckTemplateValue, ThemeTokens, UpdatePuckContentInput, UpdatePuckPageInput };

package/dist/index.d.ts

@@ -113,56 +113,6 @@ interface PuckContentVersion {
     versions: PuckContentVersionEntry[];
 }
 
-interface ThemeTokens {
-    colorPrimary: string;
-    colorPrimaryHover: string;
-    colorPrimaryForeground?: string;
-    colorSecondary: string;
-    colorSecondaryForeground?: string;
-    colorBackground: string;
-    colorSurface: string;
-    colorText: string;
-    colorTextMuted: string;
-    colorForeground?: string;
-    colorMuted?: string;
-    colorMutedForeground?: string;
-    colorDestructive?: string;
-    colorDestructiveForeground?: string;
-    colorAccent?: string;
-    colorAccentForeground?: string;
-    colorBorder?: string;
-    colorInput?: string;
-    colorRing?: string;
-    colorShadowLight?: string;
-    colorShadowDark?: string;
-    colorSurfaceGlass?: string;
-    borderRadius: 'none' | 'sm' | 'md' | 'lg' | 'full';
-    borderWidth: '0' | '1' | '2';
-    borderStyle?: 'solid' | 'dashed' | 'double';
-    fontFamily: string;
-    fontHeading: string;
-    fontWeightBase?: '300' | '400' | '500';
-    fontWeightHeading?: '400' | '500' | '700' | '900';
-    letterSpacing?: 'tight' | 'normal' | 'wide' | 'wider';
-    textTransform?: 'none' | 'uppercase';
-    spacingScale: number;
-    buttonStyle: 'solid' | 'outline' | 'ghost';
-    cardShadow: 'none' | 'sm' | 'md' | 'lg';
-    headerStyle: 'transparent' | 'solid' | 'minimal';
-    shadowStyle?: 'none' | 'soft' | 'hard-offset' | 'neumorphic' | 'clay' | 'glow';
-    surfaceBlur?: 'none' | 'sm' | 'md' | 'lg';
-    surfaceOpacity?: number;
-    backgroundStyle?: 'solid' | 'gradient' | 'noise';
-    animationStyle?: string;
-}
-interface ImportResult {
-    imported: string[];
-    failed: Array<{
-        key: string;
-        error: string;
-    }>;
-}
-
 interface MediaFile {
     url: string;
     name: string;
@@ -227,4 +177,76 @@ type PuckContentWithStatesResponse = PuckContentWithStates;
 type PuckContentStateResponse = PuckContentState;
 type PuckContentVersionResponse = PuckContentVersion;
 
-export type { CreatePuckContentInput, CreatePuckPageInput, CtCustomObject, ImportResult, MediaFile, MediaLibraryPagination, MediaLibraryResult, PuckContentListItem, PuckContentListResponse, PuckContentMeta, PuckContentResponse, PuckContentState, PuckContentStateInfo, PuckContentStateResponse, PuckContentValue, PuckContentVersion, PuckContentVersionEntry, PuckContentVersionResponse, PuckContentWithStates, PuckContentWithStatesResponse, PuckPageListItem, PuckPageListResponse, PuckPageMeta, PuckPageResponse, PuckPageState, PuckPageStateResponse, PuckPageValue, PuckPageVersion, PuckPageVersionEntry, PuckPageVersionResponse, PuckPageWithStates, PuckPageWithStatesResponse, PuckStateInfo, ThemeTokens, UpdatePuckContentInput, UpdatePuckPageInput };
+/** Whether a template seeds a page or a content item. */
+type PuckTemplateKind = 'page' | 'content';
+interface PuckTemplateValue {
+    key: string;
+    businessUnitKey: string;
+    name: string;
+    kind: PuckTemplateKind;
+    /** Puck data snapshot used to seed new pages/content (stripped or full). */
+    puckData: Data;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A template as returned by the API (custom-object wrapper). */
+type PuckTemplateListItem = CtCustomObject<PuckTemplateValue>;
+interface CreatePuckTemplateInput {
+    name: string;
+    kind: PuckTemplateKind;
+    puckData: Data;
+}
+type PuckTemplateResponse = CtCustomObject<PuckTemplateValue>;
+type PuckTemplateListResponse = PuckTemplateListItem[];
+
+interface ThemeTokens {
+    colorPrimary: string;
+    colorPrimaryHover: string;
+    colorPrimaryForeground?: string;
+    colorSecondary: string;
+    colorSecondaryForeground?: string;
+    colorBackground: string;
+    colorSurface: string;
+    colorText: string;
+    colorTextMuted: string;
+    colorForeground?: string;
+    colorMuted?: string;
+    colorMutedForeground?: string;
+    colorDestructive?: string;
+    colorDestructiveForeground?: string;
+    colorAccent?: string;
+    colorAccentForeground?: string;
+    colorBorder?: string;
+    colorInput?: string;
+    colorRing?: string;
+    colorShadowLight?: string;
+    colorShadowDark?: string;
+    colorSurfaceGlass?: string;
+    borderRadius: 'none' | 'sm' | 'md' | 'lg' | 'full';
+    borderWidth: '0' | '1' | '2';
+    borderStyle?: 'solid' | 'dashed' | 'double';
+    fontFamily: string;
+    fontHeading: string;
+    fontWeightBase?: '300' | '400' | '500';
+    fontWeightHeading?: '400' | '500' | '700' | '900';
+    letterSpacing?: 'tight' | 'normal' | 'wide' | 'wider';
+    textTransform?: 'none' | 'uppercase';
+    spacingScale: number;
+    buttonStyle: 'solid' | 'outline' | 'ghost';
+    cardShadow: 'none' | 'sm' | 'md' | 'lg';
+    headerStyle: 'transparent' | 'solid' | 'minimal';
+    shadowStyle?: 'none' | 'soft' | 'hard-offset' | 'neumorphic' | 'clay' | 'glow';
+    surfaceBlur?: 'none' | 'sm' | 'md' | 'lg';
+    surfaceOpacity?: number;
+    backgroundStyle?: 'solid' | 'gradient' | 'noise';
+    animationStyle?: string;
+}
+interface ImportResult {
+    imported: string[];
+    failed: Array<{
+        key: string;
+        error: string;
+    }>;
+}
+
+export type { CreatePuckContentInput, CreatePuckPageInput, CreatePuckTemplateInput, CtCustomObject, ImportResult, MediaFile, MediaLibraryPagination, MediaLibraryResult, PuckContentListItem, PuckContentListResponse, PuckContentMeta, PuckContentResponse, PuckContentState, PuckContentStateInfo, PuckContentStateResponse, PuckContentValue, PuckContentVersion, PuckContentVersionEntry, PuckContentVersionResponse, PuckContentWithStates, PuckContentWithStatesResponse, PuckPageListItem, PuckPageListResponse, PuckPageMeta, PuckPageResponse, PuckPageState, PuckPageStateResponse, PuckPageValue, PuckPageVersion, PuckPageVersionEntry, PuckPageVersionResponse, PuckPageWithStates, PuckPageWithStatesResponse, PuckStateInfo, PuckTemplateKind, PuckTemplateListItem, PuckTemplateListResponse, PuckTemplateResponse, PuckTemplateValue, ThemeTokens, UpdatePuckContentInput, UpdatePuckPageInput };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type {\n  PuckConfig,\n  PuckComponentConfig,\n  PuckData,\n  PuckComponentData,\n  Fields,\n  Field,\n} from './puck-data.types';\n\nexport type {\n  PuckPageMeta,\n  PuckPageValue,\n  PuckPageListItem,\n  PuckPageWithStates,\n} from './puck-page.types';\n\nexport type {\n  PuckStateInfo,\n  PuckPageState,\n  PuckPageVersionEntry,\n  PuckPageVersion,\n} from './puck-state.types';\n\nexport type {\n  PuckContentMeta,\n  PuckContentValue,\n  PuckContentStateInfo,\n  PuckContentListItem,\n  PuckContentWithStates,\n  PuckContentState,\n  PuckContentVersionEntry,\n  PuckContentVersion,\n} from './puck-content.types';\n\nexport type { ThemeTokens, ImportResult } from './theme-types';\n\nexport type {\n  MediaFile,\n  MediaLibraryPagination,\n  MediaLibraryResult,\n  CtCustomObject,\n  CreatePuckPageInput,\n  UpdatePuckPageInput,\n  PuckPageResponse,\n  PuckPageListResponse,\n  PuckPageWithStatesResponse,\n  PuckPageStateResponse,\n  PuckPageVersionResponse,\n  CreatePuckContentInput,\n  UpdatePuckContentInput,\n  PuckContentResponse,\n  PuckContentListResponse,\n  PuckContentWithStatesResponse,\n  PuckContentStateResponse,\n  PuckContentVersionResponse,\n} from './puck-api.types';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type {\n  PuckConfig,\n  PuckComponentConfig,\n  PuckData,\n  PuckComponentData,\n  Fields,\n  Field,\n} from './puck-data.types';\n\nexport type {\n  PuckPageMeta,\n  PuckPageValue,\n  PuckPageListItem,\n  PuckPageWithStates,\n} from './puck-page.types';\n\nexport type {\n  PuckStateInfo,\n  PuckPageState,\n  PuckPageVersionEntry,\n  PuckPageVersion,\n} from './puck-state.types';\n\nexport type {\n  PuckContentMeta,\n  PuckContentValue,\n  PuckContentStateInfo,\n  PuckContentListItem,\n  PuckContentWithStates,\n  PuckContentState,\n  PuckContentVersionEntry,\n  PuckContentVersion,\n} from './puck-content.types';\n\nexport type {\n  PuckTemplateKind,\n  PuckTemplateValue,\n  PuckTemplateListItem,\n  CreatePuckTemplateInput,\n  PuckTemplateResponse,\n  PuckTemplateListResponse,\n} from './puck-template.types';\n\nexport type { ThemeTokens, ImportResult } from './theme-types';\n\nexport type {\n  MediaFile,\n  MediaLibraryPagination,\n  MediaLibraryResult,\n  CtCustomObject,\n  CreatePuckPageInput,\n  UpdatePuckPageInput,\n  PuckPageResponse,\n  PuckPageListResponse,\n  PuckPageWithStatesResponse,\n  PuckPageStateResponse,\n  PuckPageVersionResponse,\n  CreatePuckContentInput,\n  UpdatePuckContentInput,\n  PuckContentResponse,\n  PuckContentListResponse,\n  PuckContentWithStatesResponse,\n  PuckContentStateResponse,\n  PuckContentVersionResponse,\n} from './puck-api.types';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools-demo/puck-types",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "description": "TypeScript types for the Puck CMS integration",
   "main": "dist/index.js",
   "module": "dist/index.mjs",