vintrace-sdk 0.1.4 → 0.2.1

package/README.md

@@ -230,7 +230,7 @@ type VintraceResult<T> =
 | Module              | Status  | Methods                                  |
 | ------------------- | ------- | ---------------------------------------- |
 | Costs               | Ready   | `businessUnitTransactions`               |
-| Blocks              | Partial | `getAll`, `get`, `post`, `patch`         |
+| Blocks              | Ready   | `getAll`, `get`, `post`, `patch`, `createAssessment` |
 | Assessments         | Ready   | `getAll`                                 |
 | Vineyards           | Ready   | `post`                                   |
 | MaturitySamples     | Ready   | `post`                                   |
@@ -245,6 +245,11 @@ type VintraceResult<T> =
 | Tirage              | Ready   | `get`, `patch`                           |
 | BarrelsMovements    | Ready   | `post`                                   |
 | VesselDetailsReport | Ready   | `get`                                    |
+| WineBatches         | Ready   | `getAll`, `post`                         |
+| Documents           | Ready   | `attach`                                 |
+| Stock               | Ready   | `receive`, `getDispatches`               |
+| Vessels             | Ready   | `getBarrel`, `getBarrelGroup`, `getTank`, `getTankGroup`, `getTanker`, `getBin`, `createTank` |
+| PurchaseOrders      | Ready   | `get`, `post`                            |
 
 ---
 

package/dist/index.cjs

@@ -359,10 +359,12 @@ async function batchFetch(ids, fetchFn) {
 }
 var ExtIdentifiableEntitySchema = zod.z.object({
   id: zod.z.number().optional(),
-  extId: zod.z.string().optional()
+  extId: zod.z.string().optional(),
+  name: zod.z.string().optional()
 });
 var IdentifiableEntitySchema = zod.z.object({
-  id: zod.z.number().optional()
+  id: zod.z.number().optional(),
+  name: zod.z.string().optional()
 });
 var CodedIdentifiableEntitySchema = zod.z.object({
   id: zod.z.number().optional(),
@@ -880,15 +882,94 @@ var PaginatedResponseSchema = (itemSchema) => zod.z.object({
   last: zod.z.string().nullable().optional(),
   results: zod.z.array(itemSchema).optional()
 });
+var VineyardIdentifiableEntitySchema = IdentifiableEntitySchema.extend({
+  name: zod.z.string(),
+  grower: ExtIdentifiableEntitySchema
+});
+var GradingSchema = zod.z.object({
+  id: zod.z.number().optional(),
+  value: zod.z.string().optional(),
+  scaleName: zod.z.string().optional(),
+  scaleId: zod.z.number().optional()
+});
+var BulkStockSchema = zod.z.object({
+  totalVolume: VolumeSchema.optional(),
+  equivalentVolume: VolumeSchema.optional(),
+  equivalentWeight: VolumeSchema.optional(),
+  compWeighting: zod.z.number().optional(),
+  percentageOfFruit: zod.z.number().optional(),
+  batchId: zod.z.number().optional(),
+  batchName: zod.z.string().optional(),
+  grading: GradingSchema.nullable().optional()
+});
+var FruitPlacementSchema = zod.z.object({
+  vintage: zod.z.string().optional(),
+  bulkStocks: zod.z.array(BulkStockSchema).optional()
+});
 var BlockDataSchema = zod.z.object({
   id: zod.z.number(),
   code: zod.z.string().optional(),
-  name: zod.z.string().optional(),
-  description: zod.z.string().optional(),
+  name: zod.z.string(),
   extId: zod.z.string().optional(),
-  inactive: zod.z.boolean().optional()
+  inactive: zod.z.boolean().optional(),
+  description: zod.z.string().optional(),
+  rowNumbers: zod.z.string().optional(),
+  estate: zod.z.boolean().optional(),
+  grower: ExtIdentifiableEntitySchema.optional(),
+  vineyard: VineyardIdentifiableEntitySchema.optional(),
+  region: IdentifiableEntitySchema.optional(),
+  subRegion: IdentifiableEntitySchema.optional(),
+  variety: IdentifiableEntitySchema.optional(),
+  intendedUse: IdentifiableEntitySchema.optional(),
+  grading: GradingSchema.nullable().optional(),
+  fruitPlacement: FruitPlacementSchema.optional()
 });
 var GetBlocksSuccessResponseSchema = PaginatedResponseSchema(BlockDataSchema);
+var BlockSchema = ExtIdentifiableEntitySchema.extend({
+  extId: zod.z.string(),
+  name: zod.z.string(),
+  estate: zod.z.boolean().optional(),
+  vineyard: VineyardIdentifiableEntitySchema,
+  variety: IdentifiableEntitySchema,
+  countyCode: zod.z.string().optional(),
+  inactive: zod.z.boolean().optional(),
+  noOfVines: zod.z.number().optional(),
+  area: zod.z.number().optional(),
+  rootStock: IdentifiableEntitySchema.optional(),
+  clone: IdentifiableEntitySchema.optional(),
+  vineSpacing: zod.z.string().optional(),
+  rowSpacing: zod.z.string().optional(),
+  soilProfile: zod.z.string().optional(),
+  trellis: IdentifiableEntitySchema.optional(),
+  aspect: zod.z.string().optional(),
+  plantedTime: zod.z.number().optional(),
+  pruningType: zod.z.string().optional(),
+  averageGradient: zod.z.number().optional(),
+  irrigationType: zod.z.string().optional(),
+  frostProtection: zod.z.string().optional(),
+  organic: zod.z.boolean().optional(),
+  organicCertifiedTime: zod.z.number().optional(),
+  township: zod.z.string().optional(),
+  range: zod.z.string().optional(),
+  section: zod.z.string().optional(),
+  emitterRate: zod.z.number().optional(),
+  emitterSize: zod.z.string().optional(),
+  siteId: zod.z.string().optional(),
+  noOfRows: zod.z.number().optional(),
+  districtCode: zod.z.string().optional(),
+  regionalAdminCode: zod.z.string().optional(),
+  comments: zod.z.string().optional(),
+  code: zod.z.string().optional(),
+  defaultHarvestMethod: zod.z.string().optional(),
+  description: zod.z.string().optional(),
+  graftedDate: zod.z.number().optional(),
+  intendedUse: IdentifiableEntitySchema.optional(),
+  rowNumbers: zod.z.string().optional(),
+  vineStructure: IdentifiableEntitySchema.optional()
+});
+var BlockResponseSchema = zod.z.object({
+  data: BlockSchema
+});
 var V6PaginatedResponseSchema = zod.z.object({
   totalResultCount: zod.z.number().optional(),
   firstResult: zod.z.number().optional(),
@@ -918,7 +999,7 @@ var WinerySchema = zod.z.object({
   name: zod.z.string().optional(),
   businessUnit: zod.z.string().optional()
 });
-var GradingSchema = zod.z.object({
+var VesselGradingSchema = zod.z.object({
   scaleId: zod.z.number().optional(),
   scaleName: zod.z.string().optional(),
   valueId: zod.z.number().optional(),
@@ -935,7 +1016,7 @@ var WineBatchDetailsSchema = zod.z.object({
   program: zod.z.string().optional(),
   productCategory: CodedIdentifiableEntitySchema.optional(),
   designatedProduct: CodedIdentifiableEntitySchema.optional(),
-  grading: GradingSchema.optional()
+  grading: VesselGradingSchema.optional()
 });
 var ProductStateSchema = zod.z.object({
   id: zod.z.number().optional(),
@@ -1337,6 +1418,99 @@ zod.z.object({
   status: zod.z.string().optional(),
   message: zod.z.string().optional()
 });
+var PurchaseOrderStateEnum = zod.z.enum(["NEW", "APPROVED"]);
+var FulfillmentEnum = zod.z.enum(["NOT_FULFILLED", "PART_FULFILLED", "FULFILLED", "OVER_FULFILLED"]);
+var TaxPolicyEnum = zod.z.enum(["TAX_INCLUSIVE", "TAX_EXCLUSIVE", "NO_TAX"]);
+var PurchaseOrderLineTypeEnum = zod.z.enum(["GENERAL", "ADHOC", "WINE_BATCH", "STOCK"]);
+var PurchaseOrderLineSchema = zod.z.object({
+  id: zod.z.number(),
+  type: PurchaseOrderLineTypeEnum,
+  lineNumber: zod.z.string().nullable().optional(),
+  itemCode: zod.z.string().nullable().optional(),
+  vendorCode: zod.z.string().nullable().optional(),
+  description: zod.z.string().nullable().optional(),
+  itemName: zod.z.string().optional(),
+  unitPrice: zod.z.number().optional(),
+  totalPrice: zod.z.number().optional(),
+  taxable: zod.z.boolean().optional(),
+  quantityOrdered: MeasurementSchema.optional(),
+  quantityFulfilled: MeasurementSchema.optional()
+});
+var PurchaseOrderSchema = zod.z.object({
+  id: zod.z.number(),
+  name: zod.z.string(),
+  state: PurchaseOrderStateEnum.optional(),
+  fulfillment: FulfillmentEnum.optional(),
+  taxPolicy: TaxPolicyEnum.optional(),
+  freightCost: zod.z.number().nullable().optional(),
+  inactive: zod.z.boolean().optional(),
+  vendor: ExtIdentifiableEntitySchema.optional(),
+  vendorReference: zod.z.string().nullable().optional(),
+  deliverBy: zod.z.number().nullable().optional(),
+  notes: zod.z.string().nullable().optional(),
+  winery: zod.z.object({
+    id: zod.z.number().optional(),
+    name: zod.z.string().optional(),
+    businessUnit: zod.z.string().nullable().optional()
+  }).optional(),
+  lines: PurchaseOrderLineSchema.array().optional()
+});
+var PurchaseOrderResponseSchema = zod.z.object({
+  data: PurchaseOrderSchema
+});
+var FractionTypeEnum = zod.z.enum([
+  "FREE_RUN",
+  "PRESSINGS",
+  "MUST",
+  "LEES",
+  "UNKNOWN",
+  "COMBINED",
+  "CONDENSATE",
+  "PRESSINGS_LIGHT",
+  "PRESSINGS_HEAVY",
+  "DRAININGS",
+  "PRESSINGS_OVERNIGHT",
+  "SAIGNEE"
+]);
+var WineBatchVesselSchema = zod.z.object({
+  id: zod.z.number().optional(),
+  name: zod.z.string().optional(),
+  type: zod.z.enum(["TANK", "BIN", "BARREL", "BARREL_GROUP", "BIN_GROUP", "PRESS", "TANKER"]).optional(),
+  amount: MeasurementSchema.optional()
+});
+var WineBatchDataSchema = zod.z.object({
+  id: zod.z.number().optional(),
+  batchCode: zod.z.string().optional(),
+  batchNumber: zod.z.string().optional(),
+  description: zod.z.string().optional(),
+  productionYear: zod.z.number().optional(),
+  owner: ExtIdentifiableEntitySchema.optional(),
+  grading: VesselGradingSchema.optional(),
+  program: IdentifiableEntitySchema.optional(),
+  designatedRegion: IdentifiableEntitySchema.optional(),
+  designatedSubRegion: IdentifiableEntitySchema.optional(),
+  designatedVariety: IdentifiableEntitySchema.optional(),
+  winery: WinerySchema.optional(),
+  category: IdentifiableEntitySchema.optional(),
+  designatedProduct: IdentifiableEntitySchema.optional(),
+  costsTrackedPercentage: zod.z.number().optional(),
+  ageOfSpirits: zod.z.string().optional(),
+  serviceOrder: IdentifiableEntitySchema.optional(),
+  fractionType: FractionTypeEnum.optional(),
+  inactive: zod.z.boolean().optional(),
+  vessels: zod.z.array(WineBatchVesselSchema).optional(),
+  allocations: zod.z.array(AllocationSliceSchema).optional()
+});
+var GetWineBatchSuccessResponseSchema = PaginatedResponseSchema(WineBatchDataSchema);
+var CreateWineBatchSuccessResponseSchema = zod.z.object({
+  data: WineBatchDataSchema.optional()
+});
+var CreateWineBatchRequestSchema = WineBatchDataSchema.extend({
+  batchCode: zod.z.string(),
+  productionYear: zod.z.number(),
+  winery: WinerySchema,
+  owner: ExtIdentifiableEntitySchema
+});
 
 // src/client/VintraceClient.ts
 var VintraceClient = class {
@@ -1373,7 +1547,9 @@ var VintraceClient = class {
         timeout: options?.timeout ?? this.options.timeout,
         maxRetries: options?.maxRetries ?? this.options.maxRetries,
         validateRequest: options?.validateRequest ?? this.options.validateRequests,
-        validateResponse: options?.validateResponse ?? this.options.validateResponses
+        validateResponse: options?.validateResponse ?? this.options.validateResponses,
+        responseSchema: options?.responseSchema,
+        requestSchema: options?.requestSchema
       },
       body
     );
@@ -1941,12 +2117,17 @@ var BlocksClient = class {
    * API consumer can use the include and vintage query params to request including more information in the response.
    */
   async getAll(params) {
-    const limit = params?.limit ? parseInt(String(params.limit), 10) : 100;
+    const limit = params?.limit ?? 100;
+    const queryParams = { limit: String(limit), offset: "0" };
+    if (params?.include) queryParams.include = params.include;
+    if (params?.vintage) queryParams.vintage = params.vintage;
+    if (params?.VintraceEntityIds) queryParams.VintraceEntityIds = params.VintraceEntityIds;
+    if (params?.offset) queryParams.offset = String(params.offset);
     const firstResponse = await this.client.request(
       "v7/harvest/blocks",
       "GET",
       { responseSchema: GetBlocksSuccessResponseSchema },
-      { ...params, limit: String(limit), offset: "0" }
+      queryParams
     );
     if (firstResponse[1]) {
       return [null, firstResponse[1]];
@@ -1966,13 +2147,14 @@ var BlocksClient = class {
       const batchSize = Math.min(parallelLimit, pagesNeeded - i);
       const batchPromises = [];
       for (let j = 0; j < batchSize; j++) {
-        const offset = (i + j) * limit;
+        const pageOffset = (i + j) * limit;
+        const pageParams = { ...queryParams, offset: String(pageOffset) };
         batchPromises.push(
           this.client.request(
             "v7/harvest/blocks",
             "GET",
             { responseSchema: GetBlocksSuccessResponseSchema },
-            { ...params, limit: String(limit), offset: String(offset) }
+            pageParams
           )
         );
       }
@@ -1988,14 +2170,22 @@ var BlocksClient = class {
     }
     return [allResults, null];
   }
-  get(id) {
-    return this.client.request(`v7/harvest/blocks/${id}`, "GET");
-  }
-  getMany(ids) {
-    return batchFetch(ids, (id) => this.get(id));
-  }
-  post(data) {
-    return this.client.request("v7/harvest/blocks", "POST", {}, data);
+  /**
+   * Upsert block data into system.
+   *
+   * Create or update block data in the system. Provide a Block object in `data`.
+   * Example fields: `extId`, `name`, `estate`, `vineyard`, `variety`, `area`.
+   */
+  async post(data) {
+    const [response, error] = await this.client.request(
+      "v7/harvest/blocks",
+      "POST",
+      { responseSchema: BlockResponseSchema },
+      data
+    );
+    if (error) return [null, error];
+    if (!response?.data) return [null, null];
+    return [response.data, null];
   }
   patch(id, data) {
     return this.client.request(`v7/harvest/blocks/${id}`, "PATCH", {}, data);
@@ -2174,11 +2364,17 @@ var WineBatchesClient = class {
    */
   async getAll(params) {
     const limit = params?.limit ?? 100;
+    const queryParams = {
+      limit: String(limit),
+      offset: String(params?.offset ?? 0)
+    };
+    if (params?.ids) queryParams.ids = params.ids;
+    if (params?.include) queryParams.include = params.include;
     const firstResponse = await this.client.request(
       "v7/operation/wine-batches",
       "GET",
-      {},
-      { ...params, limit: String(limit), offset: String(params?.offset ?? 0) }
+      { responseSchema: GetWineBatchSuccessResponseSchema },
+      queryParams
     );
     if (firstResponse[1]) {
       return [null, firstResponse[1]];
@@ -2198,13 +2394,13 @@ var WineBatchesClient = class {
       const batchSize = Math.min(parallelLimit, pagesNeeded - i);
       const batchPromises = [];
       for (let j = 0; j < batchSize; j++) {
-        const offset = (i + j) * limit;
+        const pageOffset = (i + j) * limit;
         batchPromises.push(
           this.client.request(
             "v7/operation/wine-batches",
             "GET",
-            {},
-            { ...params, limit: String(limit), offset: String(offset) }
+            { responseSchema: GetWineBatchSuccessResponseSchema },
+            { ...queryParams, offset: String(pageOffset) }
           )
         );
       }
@@ -2213,9 +2409,8 @@ var WineBatchesClient = class {
         if (pageError) {
           return [null, pageError];
         }
-        const pData = pageData;
-        if (pData?.results) {
-          allResults.push(...pData.results);
+        if (pageData?.results) {
+          allResults.push(...pageData.results);
         }
       }
     }
@@ -2225,7 +2420,15 @@ var WineBatchesClient = class {
    * Create a wine batch.
    */
   create(data) {
-    return this.client.request("v7/operation/wine-batches", "POST", {}, data);
+    return this.client.request(
+      "v7/operation/wine-batches",
+      "POST",
+      {
+        responseSchema: CreateWineBatchSuccessResponseSchema,
+        requestSchema: CreateWineBatchRequestSchema
+      },
+      data
+    );
   }
 };
 var TirageClient = class {
@@ -2440,8 +2643,15 @@ var PurchaseOrdersClient = class {
   /**
    * Get purchase order details by id.
    */
-  get(id) {
-    return this.client.request(`v7/account/purchase-orders/${id}`, "GET");
+  async get(id) {
+    const [response, error] = await this.client.request(
+      `v7/account/purchase-orders/${id}`,
+      "GET",
+      { responseSchema: PurchaseOrderResponseSchema }
+    );
+    if (error) return [null, error];
+    if (!response?.data) return [null, null];
+    return [response.data, null];
   }
 };
 var TransactionsClient = class {