npm - @forumone/throughline-design-contract - Versions diffs - 0.0.1 → 0.3.0 - Mend

@forumone/throughline-design-contract 0.0.1 → 0.3.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.

Files changed (24) hide show

package/dist/manifest.d.ts ADDED Viewed

@@ -0,0 +1,454 @@
+import { z } from 'zod';
+declare const TokenDefinitionSchema: z.ZodObject<{
+    name: z.ZodString;
+    value: z.ZodString;
+    category: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    name: string;
+    category: string;
+}, {
+    value: string;
+    name: string;
+    category: string;
+}>;
+export type TokenDefinition = z.infer<typeof TokenDefinitionSchema>;
+export declare const ManifestSchema: z.ZodObject<{
+    /** The contract schema version this manifest satisfies. */
+    contractVersion: z.ZodLiteral<"1.0.0">;
+    /** Metadata about the design system. */
+    designSystem: z.ZodObject<{
+        name: z.ZodString;
+        version: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        homepage: z.ZodOptional<z.ZodString>;
+        storybookUrl: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        version: string;
+        description?: string | undefined;
+        homepage?: string | undefined;
+        storybookUrl?: string | undefined;
+    }, {
+        name: string;
+        version: string;
+        description?: string | undefined;
+        homepage?: string | undefined;
+        storybookUrl?: string | undefined;
+    }>;
+    /** All tokens the design system exposes. Components reference them by name. */
+    tokens: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        value: z.ZodString;
+        category: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        name: string;
+        category: string;
+    }, {
+        value: string;
+        name: string;
+        category: string;
+    }>, "many">;
+    /** Components keyed by name. */
+    components: z.ZodRecord<z.ZodString, z.ZodObject<{
+        name: z.ZodString;
+        category: z.ZodEnum<["hero", "section", "card", "media", "cta", "navigation", "data", "form", "utility"]>;
+        group: z.ZodOptional<z.ZodEnum<["hero", "narrative", "proof", "listing", "media", "form", "cta", "navigation", "utility"]>>;
+        description: z.ZodString;
+        intent: z.ZodString;
+        composition: z.ZodObject<{
+            placement: z.ZodArray<z.ZodEnum<["page", "section", "inline"]>, "atleastone">;
+            maxPerPage: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+            requiredSiblings: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            forbiddenAdjacent: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            allowedSlots: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>>;
+        }, "strip", z.ZodTypeAny, {
+            placement: ["page" | "section" | "inline", ...("page" | "section" | "inline")[]];
+            maxPerPage: number | null;
+            requiredSiblings: string[];
+            forbiddenAdjacent: string[];
+            allowedSlots?: Record<string, string[]> | undefined;
+        }, {
+            placement: ["page" | "section" | "inline", ...("page" | "section" | "inline")[]];
+            maxPerPage?: number | null | undefined;
+            requiredSiblings?: string[] | undefined;
+            forbiddenAdjacent?: string[] | undefined;
+            allowedSlots?: Record<string, string[]> | undefined;
+        }>;
+        content: z.ZodObject<{
+            fields: z.ZodArray<z.ZodType<import("./schema.js").ContentField, z.ZodTypeDef, import("./schema.js").ContentFieldInput>, "many">;
+            variants: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                description: z.ZodString;
+                whenToUse: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                description: string;
+                whenToUse: string;
+            }, {
+                name: string;
+                description: string;
+                whenToUse: string;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            fields: import("./schema.js").ContentField[];
+            variants?: {
+                name: string;
+                description: string;
+                whenToUse: string;
+            }[] | undefined;
+        }, {
+            fields: import("./schema.js").ContentFieldInput[];
+            variants?: {
+                name: string;
+                description: string;
+                whenToUse: string;
+            }[] | undefined;
+        }>;
+        tokens: z.ZodObject<{
+            consumes: z.ZodArray<z.ZodString, "many">;
+            configurable: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                prop: z.ZodString;
+                tokenGroup: z.ZodString;
+                allowedValues: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                prop: string;
+                tokenGroup: string;
+                allowedValues: string[];
+            }, {
+                prop: string;
+                tokenGroup: string;
+                allowedValues: string[];
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            consumes: string[];
+            configurable?: {
+                prop: string;
+                tokenGroup: string;
+                allowedValues: string[];
+            }[] | undefined;
+        }, {
+            consumes: string[];
+            configurable?: {
+                prop: string;
+                tokenGroup: string;
+                allowedValues: string[];
+            }[] | undefined;
+        }>;
+        accessibility: z.ZodObject<{
+            role: z.ZodOptional<z.ZodString>;
+            keyboardSupport: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            screenReaderBehavior: z.ZodString;
+            contentWarnings: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            keyboardSupport: string[];
+            screenReaderBehavior: string;
+            contentWarnings: string[];
+            role?: string | undefined;
+        }, {
+            screenReaderBehavior: string;
+            role?: string | undefined;
+            keyboardSupport?: string[] | undefined;
+            contentWarnings?: string[] | undefined;
+        }>;
+        examples: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            intent: z.ZodString;
+            storyId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            intent: string;
+            label: string;
+            storyId: string;
+        }, {
+            intent: string;
+            label: string;
+            storyId: string;
+        }>, "many">;
+        antiExamples: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            why: z.ZodString;
+            useInstead: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            label: string;
+            why: string;
+            useInstead?: string | undefined;
+        }, {
+            label: string;
+            why: string;
+            useInstead?: string | undefined;
+        }>, "many">>;
+        behavior: z.ZodDefault<z.ZodObject<{
+            fetchesData: z.ZodDefault<z.ZodBoolean>;
+            hasClientState: z.ZodDefault<z.ZodBoolean>;
+            animates: z.ZodDefault<z.ZodBoolean>;
+            requiresAnalytics: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            fetchesData: boolean;
+            hasClientState: boolean;
+            animates: boolean;
+            requiresAnalytics: boolean;
+        }, {
+            fetchesData?: boolean | undefined;
+            hasClientState?: boolean | undefined;
+            animates?: boolean | undefined;
+            requiresAnalytics?: boolean | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        category: "section" | "hero" | "card" | "media" | "cta" | "navigation" | "data" | "form" | "utility";
+        description: string;
+        intent: string;
+        composition: {
+            placement: ["page" | "section" | "inline", ...("page" | "section" | "inline")[]];
+            maxPerPage: number | null;
+            requiredSiblings: string[];
+            forbiddenAdjacent: string[];
+            allowedSlots?: Record<string, string[]> | undefined;
+        };
+        content: {
+            fields: import("./schema.js").ContentField[];
+            variants?: {
+                name: string;
+                description: string;
+                whenToUse: string;
+            }[] | undefined;
+        };
+        tokens: {
+            consumes: string[];
+            configurable?: {
+                prop: string;
+                tokenGroup: string;
+                allowedValues: string[];
+            }[] | undefined;
+        };
+        accessibility: {
+            keyboardSupport: string[];
+            screenReaderBehavior: string;
+            contentWarnings: string[];
+            role?: string | undefined;
+        };
+        examples: {
+            intent: string;
+            label: string;
+            storyId: string;
+        }[];
+        antiExamples: {
+            label: string;
+            why: string;
+            useInstead?: string | undefined;
+        }[];
+        behavior: {
+            fetchesData: boolean;
+            hasClientState: boolean;
+            animates: boolean;
+            requiresAnalytics: boolean;
+        };
+        group?: "hero" | "media" | "cta" | "navigation" | "form" | "utility" | "narrative" | "proof" | "listing" | undefined;
+    }, {
+        name: string;
+        category: "section" | "hero" | "card" | "media" | "cta" | "navigation" | "data" | "form" | "utility";
+        description: string;
+        intent: string;
+        composition: {
+            placement: ["page" | "section" | "inline", ...("page" | "section" | "inline")[]];
+            maxPerPage?: number | null | undefined;
+            requiredSiblings?: string[] | undefined;
+            forbiddenAdjacent?: string[] | undefined;
+            allowedSlots?: Record<string, string[]> | undefined;
+        };
+        content: {
+            fields: import("./schema.js").ContentFieldInput[];
+            variants?: {
+                name: string;
+                description: string;
+                whenToUse: string;
+            }[] | undefined;
+        };
+        tokens: {
+            consumes: string[];
+            configurable?: {
+                prop: string;
+                tokenGroup: string;
+                allowedValues: string[];
+            }[] | undefined;
+        };
+        accessibility: {
+            screenReaderBehavior: string;
+            role?: string | undefined;
+            keyboardSupport?: string[] | undefined;
+            contentWarnings?: string[] | undefined;
+        };
+        examples: {
+            intent: string;
+            label: string;
+            storyId: string;
+        }[];
+        group?: "hero" | "media" | "cta" | "navigation" | "form" | "utility" | "narrative" | "proof" | "listing" | undefined;
+        antiExamples?: {
+            label: string;
+            why: string;
+            useInstead?: string | undefined;
+        }[] | undefined;
+        behavior?: {
+            fetchesData?: boolean | undefined;
+            hasClientState?: boolean | undefined;
+            animates?: boolean | undefined;
+            requiresAnalytics?: boolean | undefined;
+        } | undefined;
+    }>>;
+    /** Build metadata. */
+    build: z.ZodObject<{
+        timestamp: z.ZodString;
+        source: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        timestamp: string;
+        source?: string | undefined;
+    }, {
+        timestamp: string;
+        source?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    tokens: {
+        value: string;
+        name: string;
+        category: string;
+    }[];
+    contractVersion: "1.0.0";
+    designSystem: {
+        name: string;
+        version: string;
+        description?: string | undefined;
+        homepage?: string | undefined;
+        storybookUrl?: string | undefined;
+    };
+    components: Record<string, {
+        name: string;
+        category: "section" | "hero" | "card" | "media" | "cta" | "navigation" | "data" | "form" | "utility";
+        description: string;
+        intent: string;
+        composition: {
+            placement: ["page" | "section" | "inline", ...("page" | "section" | "inline")[]];
+            maxPerPage: number | null;
+            requiredSiblings: string[];
+            forbiddenAdjacent: string[];
+            allowedSlots?: Record<string, string[]> | undefined;
+        };
+        content: {
+            fields: import("./schema.js").ContentField[];
+            variants?: {
+                name: string;
+                description: string;
+                whenToUse: string;
+            }[] | undefined;
+        };
+        tokens: {
+            consumes: string[];
+            configurable?: {
+                prop: string;
+                tokenGroup: string;
+                allowedValues: string[];
+            }[] | undefined;
+        };
+        accessibility: {
+            keyboardSupport: string[];
+            screenReaderBehavior: string;
+            contentWarnings: string[];
+            role?: string | undefined;
+        };
+        examples: {
+            intent: string;
+            label: string;
+            storyId: string;
+        }[];
+        antiExamples: {
+            label: string;
+            why: string;
+            useInstead?: string | undefined;
+        }[];
+        behavior: {
+            fetchesData: boolean;
+            hasClientState: boolean;
+            animates: boolean;
+            requiresAnalytics: boolean;
+        };
+        group?: "hero" | "media" | "cta" | "navigation" | "form" | "utility" | "narrative" | "proof" | "listing" | undefined;
+    }>;
+    build: {
+        timestamp: string;
+        source?: string | undefined;
+    };
+}, {
+    tokens: {
+        value: string;
+        name: string;
+        category: string;
+    }[];
+    contractVersion: "1.0.0";
+    designSystem: {
+        name: string;
+        version: string;
+        description?: string | undefined;
+        homepage?: string | undefined;
+        storybookUrl?: string | undefined;
+    };
+    components: Record<string, {
+        name: string;
+        category: "section" | "hero" | "card" | "media" | "cta" | "navigation" | "data" | "form" | "utility";
+        description: string;
+        intent: string;
+        composition: {
+            placement: ["page" | "section" | "inline", ...("page" | "section" | "inline")[]];
+            maxPerPage?: number | null | undefined;
+            requiredSiblings?: string[] | undefined;
+            forbiddenAdjacent?: string[] | undefined;
+            allowedSlots?: Record<string, string[]> | undefined;
+        };
+        content: {
+            fields: import("./schema.js").ContentFieldInput[];
+            variants?: {
+                name: string;
+                description: string;
+                whenToUse: string;
+            }[] | undefined;
+        };
+        tokens: {
+            consumes: string[];
+            configurable?: {
+                prop: string;
+                tokenGroup: string;
+                allowedValues: string[];
+            }[] | undefined;
+        };
+        accessibility: {
+            screenReaderBehavior: string;
+            role?: string | undefined;
+            keyboardSupport?: string[] | undefined;
+            contentWarnings?: string[] | undefined;
+        };
+        examples: {
+            intent: string;
+            label: string;
+            storyId: string;
+        }[];
+        group?: "hero" | "media" | "cta" | "navigation" | "form" | "utility" | "narrative" | "proof" | "listing" | undefined;
+        antiExamples?: {
+            label: string;
+            why: string;
+            useInstead?: string | undefined;
+        }[] | undefined;
+        behavior?: {
+            fetchesData?: boolean | undefined;
+            hasClientState?: boolean | undefined;
+            animates?: boolean | undefined;
+            requiresAnalytics?: boolean | undefined;
+        } | undefined;
+    }>;
+    build: {
+        timestamp: string;
+        source?: string | undefined;
+    };
+}>;
+export type Manifest = z.infer<typeof ManifestSchema>;
+export {};
+//# sourceMappingURL=manifest.d.ts.map

package/dist/manifest.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,QAAA,MAAM,qBAAqB;;;;;;;;;;;;EAIzB,CAAA;AAEF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEnE,eAAO,MAAM,cAAc;IACzB,2DAA2D;;IAG3D,wCAAwC;;;;;;;;;;;;;;;;;;;;IASxC,+EAA+E;;;;;;;;;;;;;;IAG/E,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGhC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKtB,CAAA;AAEF,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA"}

package/dist/manifest.js ADDED Viewed

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+import { CONTRACT_VERSION, ComponentContractSchema } from './schema.js';
+const TokenDefinitionSchema = z.object({
+    name: z.string(),
+    value: z.string(),
+    category: z.string(),
+});
+export const ManifestSchema = z.object({
+    /** The contract schema version this manifest satisfies. */
+    contractVersion: z.literal(CONTRACT_VERSION),
+    /** Metadata about the design system. */
+    designSystem: z.object({
+        name: z.string(),
+        version: z.string(),
+        description: z.string().optional(),
+        homepage: z.string().url().optional(),
+        storybookUrl: z.string().url().optional(),
+    }),
+    /** All tokens the design system exposes. Components reference them by name. */
+    tokens: z.array(TokenDefinitionSchema),
+    /** Components keyed by name. */
+    components: z.record(z.string(), ComponentContractSchema),
+    /** Build metadata. */
+    build: z.object({
+        timestamp: z.string().datetime(),
+        source: z.string().optional(),
+    }),
+});
+//# sourceMappingURL=manifest.js.map

package/dist/manifest.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAEvE,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;CACrB,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,2DAA2D;IAC3D,eAAe,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAE5C,wCAAwC;IACxC,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC;QACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACrC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;KAC1C,CAAC;IAEF,+EAA+E;IAC/E,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;IAEtC,gCAAgC;IAChC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,uBAAuB,CAAC;IAEzD,sBAAsB;IACtB,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;QACd,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;CACH,CAAC,CAAA"}