@kohost/api-client 7.25.0 → 7.25.1

package/dist/lib/vendorDocuments.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The four items a Vendor profile's Documents card asks for. Fixed, in this
+ * order, and not a taxonomy anyone edits: the card's job is to make what is
+ * missing legible at a glance, which a growing list would defeat. A document's
+ * stored `label` is free-form, so a checklist row is the item whose label
+ * matches its name.
+ */
+export declare const VENDOR_DOCUMENT_CHECKLIST: readonly ["W-9", "Certificate of Insurance", "Signed Agreement", "Trade License"];
+export type VendorDocumentChecklistItem = (typeof VENDOR_DOCUMENT_CHECKLIST)[number];
+/** How far ahead of an expiry date a document reads as expiring. */
+export declare const VENDOR_DOCUMENT_EXPIRING_SOON_DAYS = 30;
+export type VendorDocumentExpiry = "expired" | "expiringSoon" | "current";
+/**
+ * Where a document sits against its own expiry date, computed from
+ * `expiresAt` every time it is read and never stored. A stored flag would be
+ * wrong the day after it was written and would need a job to keep true; a date
+ * and a clock are enough.
+ *
+ * A document with no expiry has no status — a W-9 does not expire, and
+ * inventing "current" for it would put a reassuring badge on a document nobody
+ * checked.
+ */
+export declare function vendorDocumentExpiry(expiresAt: string | Date | null | undefined, now?: Date): VendorDocumentExpiry | null;

package/dist/lib/vendorPrivateDetails.d.ts

@@ -0,0 +1,35 @@
+/**
+ * The coverages Kohost records against a catalog Vendor. An enum rather than
+ * free text because the whole point of the record is answering "is this vendor
+ * covered for X" across the catalog, which two spellings of "general liability"
+ * would defeat. `other` is the escape hatch, and the carrier/limit fields say
+ * what it is.
+ */
+export declare const VENDOR_INSURANCE_TYPES: readonly ["general-liability", "workers-comp", "auto", "umbrella", "professional", "other"];
+export type VendorInsuranceType = (typeof VENDOR_INSURANCE_TYPES)[number];
+export declare const VENDOR_INSURANCE_TYPE_LABELS: Record<VendorInsuranceType, string>;
+export declare function isVendorInsuranceType(value: unknown): value is VendorInsuranceType;
+/**
+ * What a complete Private Details record carries, in the order the catalog
+ * list reports it missing. Deliberately short: these are the facts Kohost
+ * needs before it can put a vendor in front of a campus, not everything the
+ * editor can hold.
+ */
+export declare const VENDOR_REQUIRED_DETAILS: readonly ["Legal name", "EIN", "W-9", "Insurance", "License"];
+export type VendorRequiredDetail = (typeof VENDOR_REQUIRED_DETAILS)[number];
+interface VendorPrivateLike {
+    legalName?: string | null;
+    ein?: string | null;
+    w9OnFile?: boolean | null;
+    insurance?: readonly unknown[] | null;
+    licenses?: readonly unknown[] | null;
+}
+/**
+ * Which of {@link VENDOR_REQUIRED_DETAILS} a Vendor has nothing on file for,
+ * derived every time it is read. Emptiness is the only test — a record's
+ * contents, and whether it has expired, are the editor's business, so a vendor
+ * with a lapsed policy reads as having insurance details and an expiry
+ * warning rather than as missing them.
+ */
+export declare function missingVendorDetails(privateDetails: VendorPrivateLike | null | undefined): VendorRequiredDetail[];
+export {};

package/dist/models/vendorProfile.d.ts

@@ -0,0 +1,17 @@
+import { Entity } from "./entity.js";
+import { validateVendorProfile as validate } from "../validate.js";
+import { vendorProfileSchema, type VendorProfileSchema } from "../schemas/vendorProfile.js";
+/**
+ * Data type for VendorProfile constructor - exported for backwards compatibility
+ */
+export type VendorProfileData = VendorProfileSchema;
+/**
+ * VendorProfile
+ */
+export interface VendorProfile extends VendorProfileSchema {
+}
+export declare class VendorProfile extends Entity {
+    schema: typeof vendorProfileSchema;
+    validator: typeof validate;
+    constructor(data: VendorProfileSchema);
+}

package/dist/schemas/system.d.ts

@@ -117,7 +117,6 @@ export declare const systemSchema: {
         readonly emergency: {
             readonly type: readonly ["string", "null"];
             readonly enum: readonly ["lockdown", "evacuate", null];
-            readonly default: null;
             readonly description: "Active system wide emergency state";
         };
         readonly supportedEmergencies: {
@@ -132,7 +131,6 @@ export declare const systemSchema: {
         readonly trippedSensors: {
             readonly type: "array";
             readonly uniqueItems: true;
-            readonly default: readonly [];
             readonly items: {
                 readonly type: "string";
                 readonly enum: readonly ["rain"];

package/dist/schemas/system.js

@@ -122,7 +122,6 @@ const systemSchema = {
 				"evacuate",
 				null
 			],
-			default: null,
 			description: "Active system wide emergency state"
 		},
 		supportedEmergencies: {
@@ -137,7 +136,6 @@ const systemSchema = {
 		trippedSensors: {
 			type: "array",
 			uniqueItems: true,
-			default: [],
 			items: {
 				type: "string",
 				enum: ["rain"]

package/dist/schemas/system.js.map

@@ -1 +1 @@
-{"version":3,"file":"system.js","names":[],"sources":["../../.generated/schemas/system.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\nimport type { mediaFileSchema } from \"./mediaFile\";\n\nexport const systemSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"system.json\",\n  title: \"System\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"driver\", \"entities\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      type: \"string\",\n    },\n    type: {\n      type: \"string\",\n      default: \"system\",\n      enum: [\"system\"],\n    },\n    categories: {\n      type: \"array\",\n      uniqueItems: true,\n      default: [],\n      items: { \n        enum: [\"access\", \"climate\", \"irrigation\", \"lighting\", \"media\", \"security\", \"sis\"] \n      },\n      description: \"The categories of functionality this system provides.\",\n    },\n    name: {\n      type: \"string\",\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n      example: \"salto\",\n      description: \"The driver value that implements the system\",\n    },\n    organizationId: {\n      type: \"string\",\n      description: \"The id of the organization that uses the system\",\n    },\n    propertyId: {\n      type: \"string\",\n      description: \"The id of the property that uses the system\",\n    },\n    entities: {\n      type: \"array\",\n      description: \"The entities produced by the system\",\n      default: [],\n      items: {\n        type: \"object\",\n        required: [\"systemId\"],\n        properties: {\n          id: {\n            type: \"string\",\n            description: \"The id of the entity\",\n          },\n          systemId: {\n            type: \"string\",\n            description: \"The id of the entity as known by the system\",\n          },\n          type: {\n            type: \"string\",\n            description: \"The type of the entity\",\n          },\n          discriminator: {\n            type: \"string\",\n            description: \"The discriminator of the entity\",\n          },\n          propertyIds: {\n            type: \"array\",\n            description:\n              \"The ids of the properties where the entity is located\",\n            items: {\n              type: \"string\",\n            },\n          },\n        },\n      },\n    },\n    driverApiVersion: {\n      type: \"string\",\n      description: \"The version of the driver API used by the system\",\n    },\n    logo: {\n      $ref: \"mediaFile.json#\",\n    },\n    config: {\n      type: \"object\",\n      additionalProperties: true,\n      description: \"The runtime configuration of the system\",\n    },\n    contactInfo: {\n      type: \"object\",\n      additionalProperties: false,\n      properties: {\n        websiteUrl: {\n          type: \"string\",\n          description: \"The website URL of the system\",\n        },\n        email: {\n          type: \"string\",\n          description: \"The email address of the system\",\n        },\n        phone: {\n          type: \"string\",\n          description: \"The phone number of the system\",\n        },\n        itunesAppId: {\n          type: \"string\",\n          example: \"807316865\",\n        },\n        googleAppId: {\n          type: \"string\",\n          example: \"tw.com.geovision.gvaccesscontrol\",\n        },\n      },\n    },\n    emergency: {\n      type: [\"string\", \"null\"],\n      enum: [\"lockdown\", \"evacuate\", null],\n      default: null,\n      description: \"Active system wide emergency state\",\n    },\n    supportedEmergencies: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        type: \"string\",\n        enum: [ \"lockdown\", \"evacuate\" ],\n      },\n      description: \"System wide emergencies the system can enter. Omitted means unknown (legacy); an empty array means none are supported.\",\n    },\n    trippedSensors: {\n      type: \"array\",\n      uniqueItems: true,\n      default: [],\n      items: {\n        type: \"string\",\n        enum: [\"rain\"],\n      },\n      description: \"Active sensors\",\n    },\n    supportedSensors: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        type: \"string\",\n        enum: [ \"rain\" ],\n      },\n      description: \"System wide supported sensors.\",\n    },\n    health: {\n      type: \"object\",\n      properties: {\n        offline: {\n          type: \"boolean\",\n          description: \"Whether the system is offline\",\n        },\n        lastHeartbeatAt: {\n          type: \"string\",\n          description:\n            \"The date and time of the last communication with the system\",\n          format: \"date-time\",\n        },\n      },\n    },\n    syncedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description:\n        \"When the system's roster (people and households) was last synced into the platform.\",\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    deletedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n  },\n  allOf: [\n    {\n      if: {\n        properties: { categories: { contains: { const: \"access\" } } },\n        required: [\"categories\"],\n      },\n      then: { required: [\"emergency\", \"supportedEmergencies\"] },\n    },\n    {\n      if: {\n        properties: { categories: { contains: { const: \"irrigation\" } } },\n        required: [\"categories\"],\n      },\n      then: { required: [\"trippedSensors\", \"supportedSensors\"] },\n    }\n  ]\n} as const;\n\nexport type SystemSchema = FromSchema<\n  typeof systemSchema,\n  {\n    references: [typeof defs, typeof mediaFileSchema];\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n"],"mappings":";AAIA,MAAa,eAAe;CAC1B,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;EAAU;CAAU;CAC7C,sBAAsB;CACtB,YAAY;EACV,IAAI,EACF,MAAM,SACR;EACA,MAAM;GACJ,MAAM;GACN,SAAS;GACT,MAAM,CAAC,QAAQ;EACjB;EACA,YAAY;GACV,MAAM;GACN,aAAa;GACb,SAAS,CAAC;GACV,OAAO,EACL,MAAM;IAAC;IAAU;IAAW;IAAc;IAAY;IAAS;IAAY;GAAK,EAClF;GACA,aAAa;EACf;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,SAAS;GACT,aAAa;EACf;EACA,gBAAgB;GACd,MAAM;GACN,aAAa;EACf;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aAAa;GACb,SAAS,CAAC;GACV,OAAO;IACL,MAAM;IACN,UAAU,CAAC,UAAU;IACrB,YAAY;KACV,IAAI;MACF,MAAM;MACN,aAAa;KACf;KACA,UAAU;MACR,MAAM;MACN,aAAa;KACf;KACA,MAAM;MACJ,MAAM;MACN,aAAa;KACf;KACA,eAAe;MACb,MAAM;MACN,aAAa;KACf;KACA,aAAa;MACX,MAAM;MACN,aACE;MACF,OAAO,EACL,MAAM,SACR;KACF;IACF;GACF;EACF;EACA,kBAAkB;GAChB,MAAM;GACN,aAAa;EACf;EACA,MAAM,EACJ,MAAM,kBACR;EACA,QAAQ;GACN,MAAM;GACN,sBAAsB;GACtB,aAAa;EACf;EACA,aAAa;GACX,MAAM;GACN,sBAAsB;GACtB,YAAY;IACV,YAAY;KACV,MAAM;KACN,aAAa;IACf;IACA,OAAO;KACL,MAAM;KACN,aAAa;IACf;IACA,OAAO;KACL,MAAM;KACN,aAAa;IACf;IACA,aAAa;KACX,MAAM;KACN,SAAS;IACX;IACA,aAAa;KACX,MAAM;KACN,SAAS;IACX;GACF;EACF;EACA,WAAW;GACT,MAAM,CAAC,UAAU,MAAM;GACvB,MAAM;IAAC;IAAY;IAAY;GAAI;GACnC,SAAS;GACT,aAAa;EACf;EACA,sBAAsB;GACpB,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,MAAM,CAAE,YAAY,UAAW;GACjC;GACA,aAAa;EACf;EACA,gBAAgB;GACd,MAAM;GACN,aAAa;GACb,SAAS,CAAC;GACV,OAAO;IACL,MAAM;IACN,MAAM,CAAC,MAAM;GACf;GACA,aAAa;EACf;EACA,kBAAkB;GAChB,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,MAAM,CAAE,MAAO;GACjB;GACA,aAAa;EACf;EACA,QAAQ;GACN,MAAM;GACN,YAAY;IACV,SAAS;KACP,MAAM;KACN,aAAa;IACf;IACA,iBAAiB;KACf,MAAM;KACN,aACE;KACF,QAAQ;IACV;GACF;EACF;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,OAAO,CACL;EACE,IAAI;GACF,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,SAAS,EAAE,EAAE;GAC5D,UAAU,CAAC,YAAY;EACzB;EACA,MAAM,EAAE,UAAU,CAAC,aAAa,sBAAsB,EAAE;CAC1D,GACA;EACE,IAAI;GACF,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,aAAa,EAAE,EAAE;GAChE,UAAU,CAAC,YAAY;EACzB;EACA,MAAM,EAAE,UAAU,CAAC,kBAAkB,kBAAkB,EAAE;CAC3D,CACF;AACF"}
+{"version":3,"file":"system.js","names":[],"sources":["../../.generated/schemas/system.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\nimport type { mediaFileSchema } from \"./mediaFile\";\n\nexport const systemSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"system.json\",\n  title: \"System\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"driver\", \"entities\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      type: \"string\",\n    },\n    type: {\n      type: \"string\",\n      default: \"system\",\n      enum: [\"system\"],\n    },\n    categories: {\n      type: \"array\",\n      uniqueItems: true,\n      default: [],\n      items: { \n        enum: [\"access\", \"climate\", \"irrigation\", \"lighting\", \"media\", \"security\", \"sis\"] \n      },\n      description: \"The categories of functionality this system provides.\",\n    },\n    name: {\n      type: \"string\",\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n      example: \"salto\",\n      description: \"The driver value that implements the system\",\n    },\n    organizationId: {\n      type: \"string\",\n      description: \"The id of the organization that uses the system\",\n    },\n    propertyId: {\n      type: \"string\",\n      description: \"The id of the property that uses the system\",\n    },\n    entities: {\n      type: \"array\",\n      description: \"The entities produced by the system\",\n      default: [],\n      items: {\n        type: \"object\",\n        required: [\"systemId\"],\n        properties: {\n          id: {\n            type: \"string\",\n            description: \"The id of the entity\",\n          },\n          systemId: {\n            type: \"string\",\n            description: \"The id of the entity as known by the system\",\n          },\n          type: {\n            type: \"string\",\n            description: \"The type of the entity\",\n          },\n          discriminator: {\n            type: \"string\",\n            description: \"The discriminator of the entity\",\n          },\n          propertyIds: {\n            type: \"array\",\n            description:\n              \"The ids of the properties where the entity is located\",\n            items: {\n              type: \"string\",\n            },\n          },\n        },\n      },\n    },\n    driverApiVersion: {\n      type: \"string\",\n      description: \"The version of the driver API used by the system\",\n    },\n    logo: {\n      $ref: \"mediaFile.json#\",\n    },\n    config: {\n      type: \"object\",\n      additionalProperties: true,\n      description: \"The runtime configuration of the system\",\n    },\n    contactInfo: {\n      type: \"object\",\n      additionalProperties: false,\n      properties: {\n        websiteUrl: {\n          type: \"string\",\n          description: \"The website URL of the system\",\n        },\n        email: {\n          type: \"string\",\n          description: \"The email address of the system\",\n        },\n        phone: {\n          type: \"string\",\n          description: \"The phone number of the system\",\n        },\n        itunesAppId: {\n          type: \"string\",\n          example: \"807316865\",\n        },\n        googleAppId: {\n          type: \"string\",\n          example: \"tw.com.geovision.gvaccesscontrol\",\n        },\n      },\n    },\n    emergency: {\n      type: [\"string\", \"null\"],\n      enum: [\"lockdown\", \"evacuate\", null],\n      description: \"Active system wide emergency state\",\n    },\n    supportedEmergencies: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        type: \"string\",\n        enum: [ \"lockdown\", \"evacuate\" ],\n      },\n      description: \"System wide emergencies the system can enter. Omitted means unknown (legacy); an empty array means none are supported.\",\n    },\n    trippedSensors: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        type: \"string\",\n        enum: [\"rain\"],\n      },\n      description: \"Active sensors\",\n    },\n    supportedSensors: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        type: \"string\",\n        enum: [ \"rain\" ],\n      },\n      description: \"System wide supported sensors.\",\n    },\n    health: {\n      type: \"object\",\n      properties: {\n        offline: {\n          type: \"boolean\",\n          description: \"Whether the system is offline\",\n        },\n        lastHeartbeatAt: {\n          type: \"string\",\n          description:\n            \"The date and time of the last communication with the system\",\n          format: \"date-time\",\n        },\n      },\n    },\n    syncedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description:\n        \"When the system's roster (people and households) was last synced into the platform.\",\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    deletedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n  },\n  allOf: [\n    {\n      if: {\n        properties: { categories: { contains: { const: \"access\" } } },\n        required: [\"categories\"],\n      },\n      then: { required: [\"emergency\", \"supportedEmergencies\"] },\n    },\n    {\n      if: {\n        properties: { categories: { contains: { const: \"irrigation\" } } },\n        required: [\"categories\"],\n      },\n      then: { required: [\"trippedSensors\", \"supportedSensors\"] },\n    }\n  ]\n} as const;\n\nexport type SystemSchema = FromSchema<\n  typeof systemSchema,\n  {\n    references: [typeof defs, typeof mediaFileSchema];\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n"],"mappings":";AAIA,MAAa,eAAe;CAC1B,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;EAAU;CAAU;CAC7C,sBAAsB;CACtB,YAAY;EACV,IAAI,EACF,MAAM,SACR;EACA,MAAM;GACJ,MAAM;GACN,SAAS;GACT,MAAM,CAAC,QAAQ;EACjB;EACA,YAAY;GACV,MAAM;GACN,aAAa;GACb,SAAS,CAAC;GACV,OAAO,EACL,MAAM;IAAC;IAAU;IAAW;IAAc;IAAY;IAAS;IAAY;GAAK,EAClF;GACA,aAAa;EACf;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,SAAS;GACT,aAAa;EACf;EACA,gBAAgB;GACd,MAAM;GACN,aAAa;EACf;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aAAa;GACb,SAAS,CAAC;GACV,OAAO;IACL,MAAM;IACN,UAAU,CAAC,UAAU;IACrB,YAAY;KACV,IAAI;MACF,MAAM;MACN,aAAa;KACf;KACA,UAAU;MACR,MAAM;MACN,aAAa;KACf;KACA,MAAM;MACJ,MAAM;MACN,aAAa;KACf;KACA,eAAe;MACb,MAAM;MACN,aAAa;KACf;KACA,aAAa;MACX,MAAM;MACN,aACE;MACF,OAAO,EACL,MAAM,SACR;KACF;IACF;GACF;EACF;EACA,kBAAkB;GAChB,MAAM;GACN,aAAa;EACf;EACA,MAAM,EACJ,MAAM,kBACR;EACA,QAAQ;GACN,MAAM;GACN,sBAAsB;GACtB,aAAa;EACf;EACA,aAAa;GACX,MAAM;GACN,sBAAsB;GACtB,YAAY;IACV,YAAY;KACV,MAAM;KACN,aAAa;IACf;IACA,OAAO;KACL,MAAM;KACN,aAAa;IACf;IACA,OAAO;KACL,MAAM;KACN,aAAa;IACf;IACA,aAAa;KACX,MAAM;KACN,SAAS;IACX;IACA,aAAa;KACX,MAAM;KACN,SAAS;IACX;GACF;EACF;EACA,WAAW;GACT,MAAM,CAAC,UAAU,MAAM;GACvB,MAAM;IAAC;IAAY;IAAY;GAAI;GACnC,aAAa;EACf;EACA,sBAAsB;GACpB,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,MAAM,CAAE,YAAY,UAAW;GACjC;GACA,aAAa;EACf;EACA,gBAAgB;GACd,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,MAAM,CAAC,MAAM;GACf;GACA,aAAa;EACf;EACA,kBAAkB;GAChB,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,MAAM,CAAE,MAAO;GACjB;GACA,aAAa;EACf;EACA,QAAQ;GACN,MAAM;GACN,YAAY;IACV,SAAS;KACP,MAAM;KACN,aAAa;IACf;IACA,iBAAiB;KACf,MAAM;KACN,aACE;KACF,QAAQ;IACV;GACF;EACF;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,OAAO,CACL;EACE,IAAI;GACF,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,SAAS,EAAE,EAAE;GAC5D,UAAU,CAAC,YAAY;EACzB;EACA,MAAM,EAAE,UAAU,CAAC,aAAa,sBAAsB,EAAE;CAC1D,GACA;EACE,IAAI;GACF,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,aAAa,EAAE,EAAE;GAChE,UAAU,CAAC,YAAY;EACzB;EACA,MAAM,EAAE,UAAU,CAAC,kBAAkB,kBAAkB,EAAE;CAC3D,CACF;AACF"}

package/dist/schemas/vendorProfile.d.ts

@@ -0,0 +1,188 @@
+import defs, { ISODateString } from "./definitions.js";
+import type { FromSchema } from "json-schema-to-ts";
+import { mediaFileSchema } from "./mediaFile.js";
+/**
+ * One Organization's relationship with a contractor. Either linked to a
+ * catalog Vendor (`vendorId` set — the business's identity is read from the
+ * catalog and never stored here) or custom (`vendorId` null — the Organization
+ * typed the contractor in and holds the identity itself). Which fields are
+ * required on which path is the use case's rule, not the schema's: the schema
+ * requires only `id`.
+ */
+export declare const vendorProfileSchema: {
+    readonly $schema: "http://json-schema.org/draft-07/schema";
+    readonly $id: "vendorProfile.json";
+    readonly title: "VendorProfile";
+    readonly type: "object";
+    readonly required: readonly ["id"];
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly id: {
+            readonly $ref: "definitions.json#/definitions/id";
+        };
+        readonly type: {
+            readonly type: "string";
+            readonly default: "vendorProfile";
+            readonly enum: readonly ["vendorProfile"];
+        };
+        readonly vendorId: {
+            readonly type: readonly ["string", "null"];
+            readonly description: "The catalog Vendor this profile is linked to. Null means custom: the Organization holds the identity fields itself.";
+        };
+        readonly name: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly address: {
+            readonly anyOf: readonly [{
+                readonly $ref: "definitions.json#/definitions/address";
+            }, {
+                readonly type: "null";
+            }];
+        };
+        readonly latitude: {
+            readonly type: readonly ["number", "null"];
+        };
+        readonly longitude: {
+            readonly type: readonly ["number", "null"];
+        };
+        readonly placeId: {
+            readonly type: readonly ["string", "null"];
+            readonly description: "Google Places id the address was prefilled from.";
+        };
+        readonly photo: {
+            readonly anyOf: readonly [{
+                readonly $ref: "mediaFile.json#";
+            }, {
+                readonly type: "null";
+            }];
+        };
+        readonly email: {
+            readonly type: readonly ["string", "null"];
+            readonly format: "email";
+        };
+        readonly phone: {
+            readonly type: readonly ["string", "null"];
+            readonly pattern: "^\\+[0-9]{1,14}$";
+        };
+        readonly notes: {
+            readonly type: readonly ["string", "null"];
+            readonly maxLength: 1000;
+        };
+        readonly properties: {
+            readonly type: "array";
+            readonly description: "List of propertyIds where this vendor is enabled. Profiles are org-scoped; an empty list means every property.";
+            readonly default: readonly [];
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+        readonly vendor: {
+            readonly type: readonly ["object", "null"];
+            readonly readOnly: true;
+            readonly description: "The linked catalog Vendor's listing state, filled in on every read and never stored. Null on a custom profile.";
+            readonly additionalProperties: false;
+            readonly required: readonly ["id", "kohostVerified", "status"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly kohostVerified: {
+                    readonly type: "boolean";
+                };
+                readonly status: {
+                    readonly type: "string";
+                    readonly enum: readonly ["unlisted", "listed"];
+                };
+            };
+        };
+        readonly private: {
+            readonly type: "object";
+            readonly description: "Private Details: the Organization's own account and compliance record for this contractor. Visible only to that Organization.";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly accountNumber: {
+                    readonly type: readonly ["string", "null"];
+                    readonly maxLength: 100;
+                };
+                readonly paymentTerms: {
+                    readonly type: readonly ["string", "null"];
+                    readonly maxLength: 200;
+                };
+                readonly insuranceCarrier: {
+                    readonly type: readonly ["string", "null"];
+                    readonly maxLength: 200;
+                };
+                readonly policyNumber: {
+                    readonly type: readonly ["string", "null"];
+                    readonly maxLength: 100;
+                };
+                readonly coverageExpiresOn: {
+                    readonly anyOf: readonly [{
+                        readonly $ref: "definitions.json#/definitions/date";
+                    }, {
+                        readonly type: "null";
+                    }];
+                    readonly description: "When this campus's coverage for the vendor lapses. Null once an operator clears it.";
+                };
+                readonly documents: {
+                    readonly type: "array";
+                    readonly default: readonly [];
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["id", "url", "label", "mimeType", "size", "uploadedAt"];
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                            };
+                            readonly url: {
+                                readonly type: "string";
+                                readonly format: "uri";
+                            };
+                            readonly label: {
+                                readonly type: "string";
+                                readonly maxLength: 200;
+                            };
+                            readonly expiresAt: {
+                                readonly $ref: "definitions.json#/definitions/date";
+                            };
+                            readonly mimeType: {
+                                readonly type: "string";
+                            };
+                            readonly size: {
+                                readonly type: "integer";
+                                readonly minimum: 0;
+                            };
+                            readonly uploadedAt: {
+                                readonly $ref: "definitions.json#/definitions/date";
+                            };
+                            readonly uploadedBy: {
+                                readonly type: readonly ["string", "null"];
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly createdAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+        };
+        readonly updatedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+        };
+        readonly deletedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+        };
+    };
+};
+export type VendorProfileSchema = FromSchema<typeof vendorProfileSchema, {
+    references: [typeof defs, typeof mediaFileSchema];
+    deserialize: [
+        {
+            pattern: {
+                format: "date-time";
+            };
+            output: Date | ISODateString;
+        }
+    ];
+}>;

package/dist/useCases/addVendorDocument.d.ts

@@ -0,0 +1,36 @@
+export interface AddVendorDocumentCommandConfig {
+    data?: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    headers?: Record<string, string> | null;
+    query?: Record<string, unknown> | null;
+}
+export interface AddVendorDocumentCommandRequestConfig {
+    method: "post";
+    url: string;
+    data: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    params: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    [key: string]: unknown;
+}
+/**
+ *
+ */
+export declare class AddVendorDocumentCommand {
+    url: string;
+    data: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    query: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    config: AddVendorDocumentCommandRequestConfig;
+    static params: readonly ["id"];
+    static url: string;
+    static method: "post";
+    constructor(commandConfig: AddVendorDocumentCommandConfig, options?: Record<string, unknown>);
+}

package/dist/useCases/addVendorProfileDocument.d.ts

@@ -0,0 +1,36 @@
+export interface AddVendorProfileDocumentCommandConfig {
+    data?: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    headers?: Record<string, string> | null;
+    query?: Record<string, unknown> | null;
+}
+export interface AddVendorProfileDocumentCommandRequestConfig {
+    method: "post";
+    url: string;
+    data: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    params: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    [key: string]: unknown;
+}
+/**
+ *
+ */
+export declare class AddVendorProfileDocumentCommand {
+    url: string;
+    data: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    query: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    config: AddVendorProfileDocumentCommandRequestConfig;
+    static params: readonly ["id"];
+    static url: string;
+    static method: "post";
+    constructor(commandConfig: AddVendorProfileDocumentCommandConfig, options?: Record<string, unknown>);
+}

package/dist/useCases/createImageUploadEndpoint.d.ts

@@ -0,0 +1,27 @@
+export interface CreateImageUploadEndpointCommandConfig {
+    data?: Record<string, unknown> | null;
+    headers?: Record<string, string> | null;
+    query?: Record<string, unknown> | null;
+}
+export interface CreateImageUploadEndpointCommandRequestConfig {
+    method: "post";
+    url: string;
+    data: Record<string, unknown> | null;
+    params: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    [key: string]: unknown;
+}
+/**
+ *
+ */
+export declare class CreateImageUploadEndpointCommand {
+    url: string;
+    data: Record<string, unknown> | null;
+    query: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    config: CreateImageUploadEndpointCommandRequestConfig;
+    static params: readonly [];
+    static url: string;
+    static method: "post";
+    constructor(commandConfig: CreateImageUploadEndpointCommandConfig, options?: Record<string, unknown>);
+}

package/dist/useCases/createVendorProfile.d.ts

@@ -0,0 +1,27 @@
+export interface CreateVendorProfileCommandConfig {
+    data?: Record<string, unknown> | unknown[] | null;
+    headers?: Record<string, string> | null;
+    query?: Record<string, unknown> | null;
+}
+export interface CreateVendorProfileCommandRequestConfig {
+    method: "post";
+    url: string;
+    data: Record<string, unknown> | unknown[] | null;
+    params: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    [key: string]: unknown;
+}
+/**
+ *
+ */
+export declare class CreateVendorProfileCommand {
+    url: string;
+    data: Record<string, unknown> | unknown[] | null;
+    query: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    config: CreateVendorProfileCommandRequestConfig;
+    static params: readonly [];
+    static url: string;
+    static method: "post";
+    constructor(commandConfig: CreateVendorProfileCommandConfig, options?: Record<string, unknown>);
+}

package/dist/useCases/deleteVendorProfile.d.ts

@@ -0,0 +1,36 @@
+export interface DeleteVendorProfileCommandConfig {
+    data?: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    headers?: Record<string, string> | null;
+    query?: Record<string, unknown> | null;
+}
+export interface DeleteVendorProfileCommandRequestConfig {
+    method: "delete";
+    url: string;
+    data: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    params: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    [key: string]: unknown;
+}
+/**
+ *
+ */
+export declare class DeleteVendorProfileCommand {
+    url: string;
+    data: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    query: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    config: DeleteVendorProfileCommandRequestConfig;
+    static params: readonly ["id"];
+    static url: string;
+    static method: "delete";
+    constructor(commandConfig: DeleteVendorProfileCommandConfig, options?: Record<string, unknown>);
+}

package/dist/useCases/describeVendorProfile.d.ts

@@ -0,0 +1,36 @@
+export interface DescribeVendorProfileCommandConfig {
+    data?: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    headers?: Record<string, string> | null;
+    query?: Record<string, unknown> | null;
+}
+export interface DescribeVendorProfileCommandRequestConfig {
+    method: "get";
+    url: string;
+    data: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    params: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    [key: string]: unknown;
+}
+/**
+ *
+ */
+export declare class DescribeVendorProfileCommand {
+    url: string;
+    data: {
+        id: string;
+        [key: string]: unknown;
+    } | null;
+    query: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    config: DescribeVendorProfileCommandRequestConfig;
+    static params: readonly ["id"];
+    static url: string;
+    static method: "get";
+    constructor(commandConfig: DescribeVendorProfileCommandConfig, options?: Record<string, unknown>);
+}

package/dist/useCases/listVendorDirectory.d.ts

@@ -0,0 +1,27 @@
+export interface ListVendorDirectoryCommandConfig {
+    data?: Record<string, unknown> | unknown[] | null;
+    headers?: Record<string, string> | null;
+    query?: Record<string, unknown> | null;
+}
+export interface ListVendorDirectoryCommandRequestConfig {
+    method: "get";
+    url: string;
+    data: Record<string, unknown> | unknown[] | null;
+    params: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    [key: string]: unknown;
+}
+/**
+ * The org-facing Vendor directory: listed catalog Vendors with Private Details stripped, filtered by name.
+ */
+export declare class ListVendorDirectoryCommand {
+    url: string;
+    data: Record<string, unknown> | unknown[] | null;
+    query: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    config: ListVendorDirectoryCommandRequestConfig;
+    static params: readonly [];
+    static url: string;
+    static method: "get";
+    constructor(commandConfig: ListVendorDirectoryCommandConfig, options?: Record<string, unknown>);
+}

package/dist/useCases/listVendorProfiles.d.ts

@@ -0,0 +1,27 @@
+export interface ListVendorProfilesCommandConfig {
+    data?: Record<string, unknown> | unknown[] | null;
+    headers?: Record<string, string> | null;
+    query?: Record<string, unknown> | null;
+}
+export interface ListVendorProfilesCommandRequestConfig {
+    method: "get";
+    url: string;
+    data: Record<string, unknown> | unknown[] | null;
+    params: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    [key: string]: unknown;
+}
+/**
+ *
+ */
+export declare class ListVendorProfilesCommand {
+    url: string;
+    data: Record<string, unknown> | unknown[] | null;
+    query: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    config: ListVendorProfilesCommandRequestConfig;
+    static params: readonly [];
+    static url: string;
+    static method: "get";
+    constructor(commandConfig: ListVendorProfilesCommandConfig, options?: Record<string, unknown>);
+}

package/dist/useCases/openUnsubscribePage.d.ts

@@ -0,0 +1,36 @@
+export interface OpenUnsubscribePageCommandConfig {
+    data?: {
+        token: string;
+        [key: string]: unknown;
+    } | null;
+    headers?: Record<string, string> | null;
+    query?: Record<string, unknown> | null;
+}
+export interface OpenUnsubscribePageCommandRequestConfig {
+    method: "get";
+    url: string;
+    data: {
+        token: string;
+        [key: string]: unknown;
+    } | null;
+    params: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    [key: string]: unknown;
+}
+/**
+ *
+ */
+export declare class OpenUnsubscribePageCommand {
+    url: string;
+    data: {
+        token: string;
+        [key: string]: unknown;
+    } | null;
+    query: Record<string, unknown> | null;
+    headers: Record<string, string> | null;
+    config: OpenUnsubscribePageCommandRequestConfig;
+    static params: readonly ["token"];
+    static url: string;
+    static method: "get";
+    constructor(commandConfig: OpenUnsubscribePageCommandConfig, options?: Record<string, unknown>);
+}