@oprt/manifest 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -1222,11 +1222,216 @@ declare const ComponentGuidanceSchema: z.ZodObject<{
         use: string;
     }[] | undefined;
 }>;
+/**
+ * What a project needs besides the source it copies or the package it imports: the packages, the
+ * stylesheet lines and the root import. One source for `oprt add`'s output, the READMEs, the docs
+ * and both agent guides. A package's `range` is added when the CLI is built.
+ */
+declare const SetupSchema: z.ZodObject<{
+    tailwind: z.ZodString;
+    packages: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        dev: z.ZodBoolean;
+        why: z.ZodString;
+        range: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        dev: boolean;
+        why: string;
+        range?: string | undefined;
+    }, {
+        name: string;
+        dev: boolean;
+        why: string;
+        range?: string | undefined;
+    }>, "many">;
+    stylesheet: z.ZodArray<z.ZodObject<{
+        line: z.ZodString;
+        why: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        why: string;
+        line: string;
+    }, {
+        why: string;
+        line: string;
+    }>, "many">;
+    package_source: z.ZodObject<{
+        when: z.ZodString;
+        line: z.ZodString;
+        why: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        why: string;
+        line: string;
+        when: string;
+    }, {
+        why: string;
+        line: string;
+        when: string;
+    }>;
+    root_import: z.ZodString;
+    root_import_note: z.ZodString;
+    not_needed: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        why: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        why: string;
+    }, {
+        name: string;
+        why: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    tailwind: string;
+    packages: {
+        name: string;
+        dev: boolean;
+        why: string;
+        range?: string | undefined;
+    }[];
+    stylesheet: {
+        why: string;
+        line: string;
+    }[];
+    package_source: {
+        why: string;
+        line: string;
+        when: string;
+    };
+    root_import: string;
+    root_import_note: string;
+    not_needed: {
+        name: string;
+        why: string;
+    }[];
+}, {
+    tailwind: string;
+    packages: {
+        name: string;
+        dev: boolean;
+        why: string;
+        range?: string | undefined;
+    }[];
+    stylesheet: {
+        why: string;
+        line: string;
+    }[];
+    package_source: {
+        why: string;
+        line: string;
+        when: string;
+    };
+    root_import: string;
+    root_import_note: string;
+    not_needed: {
+        name: string;
+        why: string;
+    }[];
+}>;
 /**
  * `guidance.json`: the companion to the contract. The contract says what each component accepts;
  * the guidance says which component, and which option, to choose.
  */
 declare const GuidanceSchema: z.ZodObject<{
+    setup: z.ZodObject<{
+        tailwind: z.ZodString;
+        packages: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            dev: z.ZodBoolean;
+            why: z.ZodString;
+            range: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            dev: boolean;
+            why: string;
+            range?: string | undefined;
+        }, {
+            name: string;
+            dev: boolean;
+            why: string;
+            range?: string | undefined;
+        }>, "many">;
+        stylesheet: z.ZodArray<z.ZodObject<{
+            line: z.ZodString;
+            why: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            why: string;
+            line: string;
+        }, {
+            why: string;
+            line: string;
+        }>, "many">;
+        package_source: z.ZodObject<{
+            when: z.ZodString;
+            line: z.ZodString;
+            why: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            why: string;
+            line: string;
+            when: string;
+        }, {
+            why: string;
+            line: string;
+            when: string;
+        }>;
+        root_import: z.ZodString;
+        root_import_note: z.ZodString;
+        not_needed: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            why: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            why: string;
+        }, {
+            name: string;
+            why: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        tailwind: string;
+        packages: {
+            name: string;
+            dev: boolean;
+            why: string;
+            range?: string | undefined;
+        }[];
+        stylesheet: {
+            why: string;
+            line: string;
+        }[];
+        package_source: {
+            why: string;
+            line: string;
+            when: string;
+        };
+        root_import: string;
+        root_import_note: string;
+        not_needed: {
+            name: string;
+            why: string;
+        }[];
+    }, {
+        tailwind: string;
+        packages: {
+            name: string;
+            dev: boolean;
+            why: string;
+            range?: string | undefined;
+        }[];
+        stylesheet: {
+            why: string;
+            line: string;
+        }[];
+        package_source: {
+            why: string;
+            line: string;
+            when: string;
+        };
+        root_import: string;
+        root_import_note: string;
+        not_needed: {
+            name: string;
+            why: string;
+        }[];
+    }>;
     rules: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         rule: z.ZodString;
@@ -1288,6 +1493,30 @@ declare const GuidanceSchema: z.ZodObject<{
             use: string;
         }[] | undefined;
     }>;
+    setup: {
+        tailwind: string;
+        packages: {
+            name: string;
+            dev: boolean;
+            why: string;
+            range?: string | undefined;
+        }[];
+        stylesheet: {
+            why: string;
+            line: string;
+        }[];
+        package_source: {
+            why: string;
+            line: string;
+            when: string;
+        };
+        root_import: string;
+        root_import_note: string;
+        not_needed: {
+            name: string;
+            why: string;
+        }[];
+    };
     rules: {
         id: string;
         rule: string;
@@ -1304,6 +1533,30 @@ declare const GuidanceSchema: z.ZodObject<{
             use: string;
         }[] | undefined;
     }>;
+    setup: {
+        tailwind: string;
+        packages: {
+            name: string;
+            dev: boolean;
+            why: string;
+            range?: string | undefined;
+        }[];
+        stylesheet: {
+            why: string;
+            line: string;
+        }[];
+        package_source: {
+            why: string;
+            line: string;
+            when: string;
+        };
+        root_import: string;
+        root_import_note: string;
+        not_needed: {
+            name: string;
+            why: string;
+        }[];
+    };
     rules: {
         id: string;
         rule: string;
@@ -1313,6 +1566,7 @@ declare const GuidanceSchema: z.ZodObject<{
 }>;
 type Component = z.infer<typeof ComponentSchema>;
 type Guidance = z.infer<typeof GuidanceSchema>;
+type Setup = z.infer<typeof SetupSchema>;
 type GuidanceRule = z.infer<typeof GuidanceRuleSchema>;
 type ComponentGuidance = z.infer<typeof ComponentGuidanceSchema>;
 type Manifest = z.infer<typeof ManifestSchema>;
@@ -1323,4 +1577,4 @@ type Prop = z.infer<typeof PropSchema>;
 type Slot = z.infer<typeof SlotSchema>;
 type CompositionRule = CompositionRuleNode;
 
-export { type Component, type ComponentGuidance, ComponentGuidanceSchema, ComponentSchema, type ComponentsManifest, ComponentsManifestSchema, type CompositionRule, type CompositionRuleNode, CompositionRuleSchema, type Guidance, type GuidanceRule, GuidanceRuleSchema, GuidanceSchema, type Manifest, ManifestSchema, type Pattern, PatternSchema, type PatternSummary, PatternSummarySchema, type Prop, PropSchema, type Slot, SlotSchema };
+export { type Component, type ComponentGuidance, ComponentGuidanceSchema, ComponentSchema, type ComponentsManifest, ComponentsManifestSchema, type CompositionRule, type CompositionRuleNode, CompositionRuleSchema, type Guidance, type GuidanceRule, GuidanceRuleSchema, GuidanceSchema, type Manifest, ManifestSchema, type Pattern, PatternSchema, type PatternSummary, PatternSummarySchema, type Prop, PropSchema, type Setup, SetupSchema, type Slot, SlotSchema };

package/dist/index.js

@@ -116,7 +116,28 @@ var ComponentGuidanceSchema = z.object({
   /** Per option prop: a note for each of its values. */
   values: z.record(z.record(z.string().min(1))).optional()
 });
+var SetupSchema = z.object({
+  tailwind: z.string().min(1),
+  packages: z.array(
+    z.object({
+      name: z.string().min(1),
+      dev: z.boolean(),
+      why: z.string().min(1),
+      range: z.string().min(1).optional()
+    })
+  ).min(1),
+  stylesheet: z.array(z.object({ line: z.string().min(1), why: z.string().min(1) })),
+  package_source: z.object({
+    when: z.string().min(1),
+    line: z.string().min(1),
+    why: z.string().min(1)
+  }),
+  root_import: z.string().min(1),
+  root_import_note: z.string().min(1),
+  not_needed: z.array(z.object({ name: z.string().min(1), why: z.string().min(1) }))
+});
 var GuidanceSchema = z.object({
+  setup: SetupSchema,
   rules: z.array(GuidanceRuleSchema),
   components: z.record(ComponentGuidanceSchema)
 });
@@ -131,5 +152,6 @@ export {
   PatternSchema,
   PatternSummarySchema,
   PropSchema,
+  SetupSchema,
   SlotSchema
 };