collection/schemas

Variables

CollectionDefinitionSchema

const CollectionDefinitionSchema: ZodObject<{
  fields: ZodArray<ZodObject<{
     array: ZodOptional<ZodBoolean>;
     currencies: ZodOptional<ZodArray<ZodString>>;
     kind: ZodString;
     label: ZodOptional<ZodString>;
     mimeTypes: ZodOptional<ZodArray<ZodString>>;
     name: ZodString;
     nullable: ZodBoolean;
     readOnly: ZodOptional<ZodBoolean>;
     relation: ZodOptional<ZodObject<{
        name: ZodString;
        recordLabel: ZodNullable<ZodString>;
        target: ZodString;
     }, $strip>>;
     values: ZodOptional<ZodArray<ZodString>>;
     variant: ZodOptional<ZodDiscriminatedUnion<[ZodObject<{
        type: ZodLiteral<...>;
      }, $strip>, ZodObject<{
        max: ZodNumber;
        type: ZodLiteral<...>;
      }, $strip>, ZodObject<{
        denominator: ZodNumber;
        type: ZodLiteral<...>;
     }, $strip>], "type">>;
  }, $strip>>;
  name: ZodString;
  recordLabel: ZodOptional<ZodNullable<ZodString>>;
  relationships: ZodOptional<ZodArray<ZodObject<{
     cardinality: ZodUnion<readonly [ZodLiteral<"one">, ZodLiteral<"many">]>;
     name: ZodString;
     target: ZodString;
  }, $strip>>>;
  system: ZodOptional<ZodBoolean>;
}, $strip>;

Defined in: platform-utils/src/collection/schemas.ts:36

---

CollectionDefinitionsSchema

const CollectionDefinitionsSchema: ZodRecord<ZodString, ZodObject<{
  fields: ZodArray<ZodObject<{
     array: ZodOptional<ZodBoolean>;
     currencies: ZodOptional<ZodArray<ZodString>>;
     kind: ZodString;
     label: ZodOptional<ZodString>;
     mimeTypes: ZodOptional<ZodArray<ZodString>>;
     name: ZodString;
     nullable: ZodBoolean;
     readOnly: ZodOptional<ZodBoolean>;
     relation: ZodOptional<ZodObject<{
        name: ZodString;
        recordLabel: ZodNullable<ZodString>;
        target: ZodString;
     }, $strip>>;
     values: ZodOptional<ZodArray<ZodString>>;
     variant: ZodOptional<ZodDiscriminatedUnion<[ZodObject<{
        type: ...;
      }, $strip>, ZodObject<{
        max: ...;
        type: ...;
      }, $strip>, ZodObject<{
        denominator: ...;
        type: ...;
     }, $strip>], "type">>;
  }, $strip>>;
  name: ZodString;
  recordLabel: ZodOptional<ZodNullable<ZodString>>;
  relationships: ZodOptional<ZodArray<ZodObject<{
     cardinality: ZodUnion<readonly [ZodLiteral<"one">, ZodLiteral<"many">]>;
     name: ZodString;
     target: ZodString;
  }, $strip>>>;
  system: ZodOptional<ZodBoolean>;
}, $strip>>;

Defined in: platform-utils/src/collection/schemas.ts:44

---

CollectionFieldSchema

const CollectionFieldSchema: ZodObject<{
  array: ZodOptional<ZodBoolean>;
  currencies: ZodOptional<ZodArray<ZodString>>;
  kind: ZodString;
  label: ZodOptional<ZodString>;
  mimeTypes: ZodOptional<ZodArray<ZodString>>;
  name: ZodString;
  nullable: ZodBoolean;
  readOnly: ZodOptional<ZodBoolean>;
  relation: ZodOptional<ZodObject<{
     name: ZodString;
     recordLabel: ZodNullable<ZodString>;
     target: ZodString;
  }, $strip>>;
  values: ZodOptional<ZodArray<ZodString>>;
  variant: ZodOptional<ZodDiscriminatedUnion<[ZodObject<{
     type: ZodLiteral<"number">;
   }, $strip>, ZodObject<{
     max: ZodNumber;
     type: ZodLiteral<"star-rating">;
   }, $strip>, ZodObject<{
     denominator: ZodNumber;
     type: ZodLiteral<"progress">;
  }, $strip>], "type">>;
}, $strip>;

Defined in: platform-utils/src/collection/schemas.ts:10

---

CollectionRelationshipSchema

const CollectionRelationshipSchema: ZodObject<{
  cardinality: ZodUnion<readonly [ZodLiteral<"one">, ZodLiteral<"many">]>;
  name: ZodString;
  target: ZodString;
}, $strip>;

Defined in: platform-utils/src/collection/schemas.ts:30

---

NumericRendererVariantSchema

const NumericRendererVariantSchema: ZodDiscriminatedUnion<[ZodObject<{
  type: ZodLiteral<"number">;
}, $strip>, ZodObject<{
  max: ZodNumber;
  type: ZodLiteral<"star-rating">;
}, $strip>, ZodObject<{
  denominator: ZodNumber;
  type: ZodLiteral<"progress">;
}, $strip>], "type">;

Defined in: platform-utils/src/collection/schemas.ts:4