@forumone/throughline-design-contract 0.0.1 → 0.3.0

package/dist/schema.d.ts

@@ -0,0 +1,330 @@
+import { z } from 'zod';
+/**
+ * The current version of the contract schema. Bump this when making a
+ * backwards-incompatible change to the shape. Manifests declare the
+ * version they satisfy so the loader can reject mismatches loudly.
+ */
+export declare const CONTRACT_VERSION = "1.0.0";
+declare const FieldTypeSchema: z.ZodEnum<["text", "richtext", "link", "image", "video", "select", "group", "array", "boolean", "number"]>;
+declare const PlacementSchema: z.ZodEnum<["page", "section", "inline"]>;
+declare const CategorySchema: z.ZodEnum<["hero", "section", "card", "media", "cta", "navigation", "data", "form", "utility"]>;
+/**
+ * Where an editor looks for a component, as distinct from what the component
+ * *is*.
+ *
+ * `category` answers the second question and several consumers reason about it
+ * as a kind. It is a poor answer to the first: a real design system files
+ * roughly half its library under `section`, so a picker grouped on `category`
+ * hands back the flat list the grouping was meant to avoid, while `card` and
+ * `navigation` hold one entry each. Redistributing within `category` to even
+ * the shelves out would file components under the wrong kind for every other
+ * consumer.
+ *
+ * So this is a second, optional field. The values are shelf labels, chosen to
+ * split the sections a `category` cannot:
+ *
+ * - `hero`       — page openers
+ * - `narrative`  — sections that explain, walk through, or tell
+ * - `proof`      — sections that evidence a claim: testimony, clients, results
+ * - `listing`    — collections of records, usually repeating
+ * - `media`      — image, video, audio, and their captions
+ * - `form`       — anything an editor thinks of as a form
+ * - `cta`        — asks
+ * - `navigation` — wayfinding within or across pages
+ * - `utility`    — structural or incidental
+ *
+ * There is deliberately no `section`: a shelf that holds half the library is
+ * the problem this field exists to solve. There is no `card` or `data` either
+ * — both name a kind rather than a place to look, and their contents belong on
+ * `listing` and `proof` respectively.
+ */
+declare const GroupSchema: z.ZodEnum<["hero", "narrative", "proof", "listing", "media", "form", "cta", "navigation", "utility"]>;
+export type ContentField = {
+    name: string;
+    type: z.infer<typeof FieldTypeSchema>;
+    required: boolean;
+    maxLength?: number | undefined;
+    constraints?: string | undefined;
+    of?: ContentField[] | undefined;
+};
+/** Input shape for {@link ContentFieldSchema}: defaulted fields are optional. */
+export type ContentFieldInput = {
+    name: string;
+    type: z.infer<typeof FieldTypeSchema>;
+    required?: boolean | undefined;
+    maxLength?: number | undefined;
+    constraints?: string | undefined;
+    of?: ContentFieldInput[] | undefined;
+};
+export declare const ComponentContractSchema: z.ZodObject<{
+    name: z.ZodString;
+    category: z.ZodEnum<["hero", "section", "card", "media", "cta", "navigation", "data", "form", "utility"]>;
+    /**
+     * The shelf an authoring UI files this component under. Optional: when it is
+     * absent, {@link groupOf} falls back to {@link category}, so a design system
+     * that sets none groups exactly as it did before this field existed.
+     */
+    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<ContentField, z.ZodTypeDef, 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: ContentField[];
+        variants?: {
+            name: string;
+            description: string;
+            whenToUse: string;
+        }[] | undefined;
+    }, {
+        fields: 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: 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: 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;
+}>;
+export type ComponentContract = z.infer<typeof ComponentContractSchema>;
+export type ComponentCategory = z.infer<typeof CategorySchema>;
+export type ComponentGroup = z.infer<typeof GroupSchema>;
+/**
+ * The shelf a component is filed under: its `group` when set, otherwise its
+ * `category`.
+ *
+ * Anything that groups components should call this rather than reading either
+ * field directly, so a design system part-way through adopting `group` groups
+ * consistently instead of half one way and half the other. It takes a
+ * structural type so it also accepts the looser component shapes consumers
+ * carry around, not only a fully parsed {@link ComponentContract}.
+ */
+export declare function groupOf(component: {
+    category: string;
+    group?: string | undefined;
+}): string;
+export type ComponentPlacement = z.infer<typeof PlacementSchema>;
+export type ContentFieldType = z.infer<typeof FieldTypeSchema>;
+export {};
+//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,UAAU,CAAA;AAEvC,QAAA,MAAM,eAAe,4GAWnB,CAAA;AAEF,QAAA,MAAM,eAAe,0CAAwC,CAAA;AAE7D,QAAA,MAAM,cAAc,iGAUlB,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,QAAA,MAAM,WAAW,uGAUf,CAAA;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;IACrC,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,EAAE,CAAC,EAAE,YAAY,EAAE,GAAG,SAAS,CAAA;CAChC,CAAA;AAED,iFAAiF;AACjF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;IACrC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,EAAE,CAAC,EAAE,iBAAiB,EAAE,GAAG,SAAS,CAAA;CACrC,CAAA;AAeD,eAAO,MAAM,uBAAuB;;;IAIlC;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgFH,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AACvE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAC9D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAA;AAExD;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,SAAS,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,MAAM,CAE3F;AACD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAChE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA"}

package/dist/schema.js

@@ -0,0 +1,170 @@
+import { z } from 'zod';
+/**
+ * The current version of the contract schema. Bump this when making a
+ * backwards-incompatible change to the shape. Manifests declare the
+ * version they satisfy so the loader can reject mismatches loudly.
+ */
+export const CONTRACT_VERSION = '1.0.0';
+const FieldTypeSchema = z.enum([
+    'text',
+    'richtext',
+    'link',
+    'image',
+    'video',
+    'select',
+    'group',
+    'array',
+    'boolean',
+    'number',
+]);
+const PlacementSchema = z.enum(['page', 'section', 'inline']);
+const CategorySchema = z.enum([
+    'hero',
+    'section',
+    'card',
+    'media',
+    'cta',
+    'navigation',
+    'data',
+    'form',
+    'utility',
+]);
+/**
+ * Where an editor looks for a component, as distinct from what the component
+ * *is*.
+ *
+ * `category` answers the second question and several consumers reason about it
+ * as a kind. It is a poor answer to the first: a real design system files
+ * roughly half its library under `section`, so a picker grouped on `category`
+ * hands back the flat list the grouping was meant to avoid, while `card` and
+ * `navigation` hold one entry each. Redistributing within `category` to even
+ * the shelves out would file components under the wrong kind for every other
+ * consumer.
+ *
+ * So this is a second, optional field. The values are shelf labels, chosen to
+ * split the sections a `category` cannot:
+ *
+ * - `hero`       — page openers
+ * - `narrative`  — sections that explain, walk through, or tell
+ * - `proof`      — sections that evidence a claim: testimony, clients, results
+ * - `listing`    — collections of records, usually repeating
+ * - `media`      — image, video, audio, and their captions
+ * - `form`       — anything an editor thinks of as a form
+ * - `cta`        — asks
+ * - `navigation` — wayfinding within or across pages
+ * - `utility`    — structural or incidental
+ *
+ * There is deliberately no `section`: a shelf that holds half the library is
+ * the problem this field exists to solve. There is no `card` or `data` either
+ * — both name a kind rather than a place to look, and their contents belong on
+ * `listing` and `proof` respectively.
+ */
+const GroupSchema = z.enum([
+    'hero',
+    'narrative',
+    'proof',
+    'listing',
+    'media',
+    'form',
+    'cta',
+    'navigation',
+    'utility',
+]);
+const ContentFieldSchema = z.lazy(() => z.object({
+    name: z.string().min(1),
+    type: FieldTypeSchema,
+    required: z.boolean().default(false),
+    maxLength: z.number().int().positive().optional(),
+    /** Human-readable constraint description the AI reasons about. */
+    constraints: z.string().optional(),
+    /** For array or group fields, the nested field shape. */
+    of: z.array(ContentFieldSchema).optional(),
+}));
+export const ComponentContractSchema = z.object({
+    // Identity
+    name: z.string().min(1).regex(/^[A-Z][A-Za-z0-9]+$/, 'Component names must be PascalCase'),
+    category: CategorySchema,
+    /**
+     * The shelf an authoring UI files this component under. Optional: when it is
+     * absent, {@link groupOf} falls back to {@link category}, so a design system
+     * that sets none groups exactly as it did before this field existed.
+     */
+    group: GroupSchema.optional(),
+    description: z.string().min(20).max(280),
+    intent: z.string().min(20).max(500),
+    // Composition
+    composition: z.object({
+        placement: z.array(PlacementSchema).nonempty(),
+        maxPerPage: z.number().int().positive().nullable().default(null),
+        requiredSiblings: z.array(z.string()).default([]),
+        forbiddenAdjacent: z.array(z.string()).default([]),
+        allowedSlots: z.record(z.string(), z.array(z.string())).optional(),
+    }),
+    // Content
+    content: z.object({
+        fields: z.array(ContentFieldSchema),
+        variants: z
+            .array(z.object({
+            name: z.string(),
+            description: z.string(),
+            whenToUse: z.string(),
+        }))
+            .optional(),
+    }),
+    // Tokens
+    tokens: z.object({
+        consumes: z.array(z.string()),
+        configurable: z
+            .array(z.object({
+            prop: z.string(),
+            tokenGroup: z.string(),
+            allowedValues: z.array(z.string()),
+        }))
+            .optional(),
+    }),
+    // Accessibility
+    accessibility: z.object({
+        role: z.string().optional(),
+        keyboardSupport: z.array(z.string()).default([]),
+        screenReaderBehavior: z.string().min(10),
+        contentWarnings: z.array(z.string()).default([]),
+    }),
+    // Examples
+    examples: z
+        .array(z.object({
+        label: z.string(),
+        intent: z.string(),
+        storyId: z.string(),
+    }))
+        .min(1, 'Each component must have at least one example'),
+    antiExamples: z
+        .array(z.object({
+        label: z.string(),
+        why: z.string(),
+        useInstead: z.string().optional(),
+    }))
+        .default([]),
+    // Behavioral
+    behavior: z
+        .object({
+        fetchesData: z.boolean().default(false),
+        hasClientState: z.boolean().default(false),
+        animates: z.boolean().default(false),
+        requiresAnalytics: z.boolean().default(false),
+    })
+        .default({}),
+});
+/**
+ * The shelf a component is filed under: its `group` when set, otherwise its
+ * `category`.
+ *
+ * Anything that groups components should call this rather than reading either
+ * field directly, so a design system part-way through adopting `group` groups
+ * consistently instead of half one way and half the other. It takes a
+ * structural type so it also accepts the looser component shapes consumers
+ * carry around, not only a fully parsed {@link ComponentContract}.
+ */
+export function groupOf(component) {
+    return component.group ?? component.category;
+}
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAA;AAEvC,MAAM,eAAe,GAAG,CAAC,CAAC,IAAI,CAAC;IAC7B,MAAM;IACN,UAAU;IACV,MAAM;IACN,OAAO;IACP,OAAO;IACP,QAAQ;IACR,OAAO;IACP,OAAO;IACP,SAAS;IACT,QAAQ;CACT,CAAC,CAAA;AAEF,MAAM,eAAe,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAA;AAE7D,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC;IAC5B,MAAM;IACN,SAAS;IACT,MAAM;IACN,OAAO;IACP,KAAK;IACL,YAAY;IACZ,MAAM;IACN,MAAM;IACN,SAAS;CACV,CAAC,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC;IACzB,MAAM;IACN,WAAW;IACX,OAAO;IACP,SAAS;IACT,OAAO;IACP,MAAM;IACN,KAAK;IACL,YAAY;IACZ,SAAS;CACV,CAAC,CAAA;AAqBF,MAAM,kBAAkB,GAA6D,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAC/F,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,IAAI,EAAE,eAAe;IACrB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACjD,kEAAkE;IAClE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,yDAAyD;IACzD,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;CAC3C,CAAC,CACH,CAAA;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,WAAW;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,EAAE,oCAAoC,CAAC;IAC1F,QAAQ,EAAE,cAAc;IACxB;;;;OAIG;IACH,KAAK,EAAE,WAAW,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACxC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAEnC,cAAc;IACd,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;QAC9C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;QAChE,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QACjD,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QAClD,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;KACnE,CAAC;IAEF,UAAU;IACV,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;QACnC,QAAQ,EAAE,CAAC;aACR,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;YACvB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;SACtB,CAAC,CACH;aACA,QAAQ,EAAE;KACd,CAAC;IAEF,SAAS;IACT,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC7B,YAAY,EAAE,CAAC;aACZ,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;YACtB,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACnC,CAAC,CACH;aACA,QAAQ,EAAE;KACd,CAAC;IAEF,gBAAgB;IAChB,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QAChD,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;KACjD,CAAC;IAEF,WAAW;IACX,QAAQ,EAAE,CAAC;SACR,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,GAAG,CAAC,CAAC,EAAE,+CAA+C,CAAC;IAE1D,YAAY,EAAE,CAAC;SACZ,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAClC,CAAC,CACH;SACA,OAAO,CAAC,EAAE,CAAC;IAEd,aAAa;IACb,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC;QACN,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;QACvC,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;QAC1C,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;QACpC,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;KAC9C,CAAC;SACD,OAAO,CAAC,EAAE,CAAC;CACf,CAAC,CAAA;AAMF;;;;;;;;;GASG;AACH,MAAM,UAAU,OAAO,CAAC,SAA2D;IACjF,OAAO,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,QAAQ,CAAA;AAC9C,CAAC"}

package/package.json

@@ -1,10 +1,61 @@
 {
   "name": "@forumone/throughline-design-contract",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @forumone/throughline-design-contract",
+  "version": "0.3.0",
+  "description": "The contract every AI-ready design system satisfies to be consumable by Throughline.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./lint": {
+      "types": "./dist/lint.d.ts",
+      "default": "./dist/lint.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "throughline",
+    "design-system",
+    "ai-ready",
+    "payload"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/forumone/throughline.git",
+    "directory": "packages/design-contract"
+  },
+  "homepage": "https://github.com/forumone/throughline/tree/main/packages/design-contract#readme",
+  "bugs": {
+    "url": "https://github.com/forumone/throughline/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "zod": "^3.23.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.0",
+    "eslint": "^9.15.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0",
+    "@forumone/throughline-eslint-config": "0.0.0",
+    "@forumone/throughline-tsconfig": "0.0.0"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "tsc -b -w",
+    "clean": "rm -rf dist .turbo *.tsbuildinfo",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src",
+    "test": "vitest run"
+  }
+}