colacloud 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +123 -37
- package/dist/index.d.ts +123 -37
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -78,14 +78,30 @@ interface ColaSummary {
|
|
|
78
78
|
class_name: string | null;
|
|
79
79
|
/** Origin/country of the product */
|
|
80
80
|
origin_name: string | null;
|
|
81
|
+
/** "Domestic" or "Imported" */
|
|
82
|
+
domestic_or_imported: string | null;
|
|
81
83
|
/** Permit number of the applicant */
|
|
82
84
|
permit_number: string | null;
|
|
83
|
-
/**
|
|
85
|
+
/** Type of application (e.g., "CERTIFICATE OF LABEL APPROVAL") */
|
|
86
|
+
application_type: string | null;
|
|
87
|
+
/** Status of the application (e.g., "APPROVED") */
|
|
88
|
+
application_status: string | null;
|
|
89
|
+
/** Date the application was submitted (ISO date string) */
|
|
90
|
+
application_date: string | null;
|
|
91
|
+
/** Date the COLA was approved (ISO date string) */
|
|
84
92
|
approval_date: string | null;
|
|
93
|
+
/** Date the COLA expires (ISO date string) */
|
|
94
|
+
expiration_date: string | null;
|
|
85
95
|
/** Alcohol by volume percentage */
|
|
86
96
|
abv: number | null;
|
|
87
97
|
/** Container volume */
|
|
88
98
|
volume: string | null;
|
|
99
|
+
/** Volume unit (e.g., "ml", "L") */
|
|
100
|
+
volume_unit: string | null;
|
|
101
|
+
/** LLM-assigned category (e.g., "Bourbon") */
|
|
102
|
+
llm_category: string | null;
|
|
103
|
+
/** LLM-assigned category path (e.g., "Spirits > Whiskey > Bourbon") */
|
|
104
|
+
llm_category_path: string | null;
|
|
89
105
|
/** Number of images associated with this COLA */
|
|
90
106
|
image_count: number;
|
|
91
107
|
/** URL to the main/primary image */
|
|
@@ -95,58 +111,122 @@ interface ColaSummary {
|
|
|
95
111
|
* Image associated with a COLA
|
|
96
112
|
*/
|
|
97
113
|
interface ColaImage {
|
|
98
|
-
/** Unique
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
|
|
102
|
-
/**
|
|
103
|
-
|
|
114
|
+
/** Unique TTB image identifier */
|
|
115
|
+
ttb_image_id: string;
|
|
116
|
+
/** Position of image within the COLA's image set (0-indexed) */
|
|
117
|
+
image_index: number;
|
|
118
|
+
/** Position on the container (e.g., "FRONT", "BACK", "NECK", "STRIP") */
|
|
119
|
+
container_position: string | null;
|
|
120
|
+
/** File extension (e.g., "jpg", "png") */
|
|
121
|
+
extension_type: string | null;
|
|
104
122
|
/** Image width in pixels */
|
|
105
|
-
|
|
123
|
+
width_pixels: number | null;
|
|
106
124
|
/** Image height in pixels */
|
|
107
|
-
|
|
125
|
+
height_pixels: number | null;
|
|
126
|
+
/** Physical label width in inches */
|
|
127
|
+
width_inches: number | null;
|
|
128
|
+
/** Physical label height in inches */
|
|
129
|
+
height_inches: number | null;
|
|
130
|
+
/** File size in megabytes */
|
|
131
|
+
file_size_mb: number | null;
|
|
132
|
+
/** Number of barcodes detected in this image */
|
|
133
|
+
barcode_count: number;
|
|
134
|
+
/** Number of QR codes detected in this image */
|
|
135
|
+
qrcode_count: number;
|
|
136
|
+
/** Signed URL to the image (when available) */
|
|
137
|
+
image_url?: string;
|
|
108
138
|
}
|
|
109
139
|
/**
|
|
110
140
|
* Barcode found on a COLA label
|
|
111
141
|
*/
|
|
112
142
|
interface ColaBarcode {
|
|
113
|
-
/** The barcode value/number */
|
|
114
|
-
barcode_value: string;
|
|
115
143
|
/** Type of barcode (e.g., "UPC-A", "EAN-13") */
|
|
116
144
|
barcode_type: string | null;
|
|
145
|
+
/** The barcode value/number */
|
|
146
|
+
barcode_value: string;
|
|
147
|
+
/** TTB image ID where this barcode was found */
|
|
148
|
+
ttb_image_id: string;
|
|
149
|
+
/** Barcode width in pixels */
|
|
150
|
+
width_pixels: number | null;
|
|
151
|
+
/** Barcode height in pixels */
|
|
152
|
+
height_pixels: number | null;
|
|
153
|
+
/** Barcode orientation (e.g., "horizontal", "vertical") */
|
|
154
|
+
orientation: string | null;
|
|
155
|
+
/** Position of the barcode relative to the image */
|
|
156
|
+
relative_image_position: string | null;
|
|
117
157
|
}
|
|
118
158
|
/**
|
|
119
159
|
* Full details for a COLA including images and barcodes
|
|
120
160
|
*/
|
|
121
161
|
interface ColaDetail extends ColaSummary {
|
|
122
|
-
/**
|
|
162
|
+
/** Product class ID */
|
|
163
|
+
class_id: string | null;
|
|
164
|
+
/** Origin ID */
|
|
165
|
+
origin_id: string | null;
|
|
166
|
+
/** Date of the most recent update (ISO date string) */
|
|
167
|
+
latest_update_date: string | null;
|
|
168
|
+
/** Whether the container has a distinctive shape */
|
|
169
|
+
is_distinctive_container: boolean | null;
|
|
170
|
+
/** Distinctive container capacity */
|
|
171
|
+
for_distinctive_capacity: string | null;
|
|
172
|
+
/** Whether this is a resubmission */
|
|
173
|
+
is_resubmission: boolean | null;
|
|
174
|
+
/** TTB ID of the original submission if this is a resubmission */
|
|
175
|
+
for_resubmission_ttb_id: string | null;
|
|
176
|
+
/** State exemption, if applicable */
|
|
177
|
+
for_exemption_state: string | null;
|
|
178
|
+
/** Applicant address recipient */
|
|
179
|
+
address_recipient: string | null;
|
|
180
|
+
/** Applicant ZIP code */
|
|
181
|
+
address_zip_code: string | null;
|
|
182
|
+
/** Applicant state */
|
|
183
|
+
address_state: string | null;
|
|
184
|
+
/** Grape varietals (wine) */
|
|
185
|
+
grape_varietals: string | null;
|
|
186
|
+
/** Vintage year (wine) */
|
|
187
|
+
wine_vintage_year: number | null;
|
|
188
|
+
/** Appellation (wine) */
|
|
189
|
+
wine_appellation: string | null;
|
|
190
|
+
/** LLM-extracted container type */
|
|
191
|
+
llm_container_type: string | null;
|
|
192
|
+
/** LLM-extracted product description */
|
|
193
|
+
llm_product_description: string | null;
|
|
194
|
+
/** LLM-extracted brand established year */
|
|
195
|
+
llm_brand_established_year: number | null;
|
|
196
|
+
/** LLM-extracted tasting note flavors */
|
|
197
|
+
llm_tasting_note_flavors: string | null;
|
|
198
|
+
/** LLM-extracted artwork credit */
|
|
199
|
+
llm_artwork_credit: string | null;
|
|
200
|
+
/** LLM-extracted wine designation */
|
|
201
|
+
llm_wine_designation: string | null;
|
|
202
|
+
/** LLM-extracted International Bitterness Units (beer) */
|
|
203
|
+
llm_beer_ibu: number | null;
|
|
204
|
+
/** LLM-extracted hop varieties (beer) */
|
|
205
|
+
llm_beer_hops_varieties: string | null;
|
|
206
|
+
/** LLM-extracted aged years (liquor) */
|
|
207
|
+
llm_liquor_aged_years: number | null;
|
|
208
|
+
/** LLM-extracted finishing process (liquor) */
|
|
209
|
+
llm_liquor_finishing_process: string | null;
|
|
210
|
+
/** LLM-extracted grains used (liquor) */
|
|
211
|
+
llm_liquor_grains: string | null;
|
|
212
|
+
/** Primary barcode type on this COLA */
|
|
213
|
+
barcode_type: string | null;
|
|
214
|
+
/** Primary barcode value on this COLA */
|
|
215
|
+
barcode_value: string | null;
|
|
216
|
+
/** QR code URL if present */
|
|
217
|
+
qrcode_url: string | null;
|
|
218
|
+
/** Whether a front label image exists */
|
|
219
|
+
has_front_image: boolean;
|
|
220
|
+
/** Whether a back label image exists */
|
|
221
|
+
has_back_image: boolean;
|
|
222
|
+
/** Whether a neck label image exists */
|
|
223
|
+
has_neck_image: boolean;
|
|
224
|
+
/** Whether a strip label image exists */
|
|
225
|
+
has_strip_image: boolean;
|
|
226
|
+
/** All images associated with this COLA */
|
|
123
227
|
images: ColaImage[];
|
|
124
|
-
/**
|
|
228
|
+
/** All barcodes found on this COLA's images */
|
|
125
229
|
barcodes: ColaBarcode[];
|
|
126
|
-
/** LLM-extracted description */
|
|
127
|
-
llm_description: string | null;
|
|
128
|
-
/** LLM-extracted ingredients */
|
|
129
|
-
llm_ingredients: string | null;
|
|
130
|
-
/** LLM-extracted tasting notes */
|
|
131
|
-
llm_tasting_notes: string | null;
|
|
132
|
-
/** LLM-extracted producer/brand information */
|
|
133
|
-
llm_producer: string | null;
|
|
134
|
-
/** Vintage year for wines */
|
|
135
|
-
vintage: number | null;
|
|
136
|
-
/** Grape varietal(s) */
|
|
137
|
-
varietal: string | null;
|
|
138
|
-
/** Wine appellation */
|
|
139
|
-
appellation: string | null;
|
|
140
|
-
/** Beer style */
|
|
141
|
-
beer_style: string | null;
|
|
142
|
-
/** International Bitterness Units */
|
|
143
|
-
ibu: number | null;
|
|
144
|
-
/** Status of the COLA */
|
|
145
|
-
status: string | null;
|
|
146
|
-
/** Date the COLA was submitted */
|
|
147
|
-
submitted_date: string | null;
|
|
148
|
-
/** Serial number */
|
|
149
|
-
serial_number: string | null;
|
|
150
230
|
}
|
|
151
231
|
/**
|
|
152
232
|
* Query parameters for searching/listing COLAs
|
|
@@ -183,14 +263,20 @@ interface PermitteeSummary {
|
|
|
183
263
|
company_name: string | null;
|
|
184
264
|
/** State where the company is located */
|
|
185
265
|
company_state: string | null;
|
|
266
|
+
/** Company ZIP code */
|
|
267
|
+
company_zip_code: string | null;
|
|
186
268
|
/** Type of permit */
|
|
187
269
|
permittee_type: string | null;
|
|
188
270
|
/** Whether the permit is currently active */
|
|
189
271
|
is_active: boolean;
|
|
272
|
+
/** Reason for active/inactive status */
|
|
273
|
+
active_reason: string | null;
|
|
190
274
|
/** Total number of COLAs */
|
|
191
275
|
colas: number;
|
|
192
276
|
/** Number of approved COLAs */
|
|
193
277
|
colas_approved: number;
|
|
278
|
+
/** Date of most recent COLA application (ISO date string) */
|
|
279
|
+
last_cola_application_date: string | null;
|
|
194
280
|
}
|
|
195
281
|
/**
|
|
196
282
|
* Full details for a permittee including recent COLAs
|
package/dist/index.d.ts
CHANGED
|
@@ -78,14 +78,30 @@ interface ColaSummary {
|
|
|
78
78
|
class_name: string | null;
|
|
79
79
|
/** Origin/country of the product */
|
|
80
80
|
origin_name: string | null;
|
|
81
|
+
/** "Domestic" or "Imported" */
|
|
82
|
+
domestic_or_imported: string | null;
|
|
81
83
|
/** Permit number of the applicant */
|
|
82
84
|
permit_number: string | null;
|
|
83
|
-
/**
|
|
85
|
+
/** Type of application (e.g., "CERTIFICATE OF LABEL APPROVAL") */
|
|
86
|
+
application_type: string | null;
|
|
87
|
+
/** Status of the application (e.g., "APPROVED") */
|
|
88
|
+
application_status: string | null;
|
|
89
|
+
/** Date the application was submitted (ISO date string) */
|
|
90
|
+
application_date: string | null;
|
|
91
|
+
/** Date the COLA was approved (ISO date string) */
|
|
84
92
|
approval_date: string | null;
|
|
93
|
+
/** Date the COLA expires (ISO date string) */
|
|
94
|
+
expiration_date: string | null;
|
|
85
95
|
/** Alcohol by volume percentage */
|
|
86
96
|
abv: number | null;
|
|
87
97
|
/** Container volume */
|
|
88
98
|
volume: string | null;
|
|
99
|
+
/** Volume unit (e.g., "ml", "L") */
|
|
100
|
+
volume_unit: string | null;
|
|
101
|
+
/** LLM-assigned category (e.g., "Bourbon") */
|
|
102
|
+
llm_category: string | null;
|
|
103
|
+
/** LLM-assigned category path (e.g., "Spirits > Whiskey > Bourbon") */
|
|
104
|
+
llm_category_path: string | null;
|
|
89
105
|
/** Number of images associated with this COLA */
|
|
90
106
|
image_count: number;
|
|
91
107
|
/** URL to the main/primary image */
|
|
@@ -95,58 +111,122 @@ interface ColaSummary {
|
|
|
95
111
|
* Image associated with a COLA
|
|
96
112
|
*/
|
|
97
113
|
interface ColaImage {
|
|
98
|
-
/** Unique
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
|
|
102
|
-
/**
|
|
103
|
-
|
|
114
|
+
/** Unique TTB image identifier */
|
|
115
|
+
ttb_image_id: string;
|
|
116
|
+
/** Position of image within the COLA's image set (0-indexed) */
|
|
117
|
+
image_index: number;
|
|
118
|
+
/** Position on the container (e.g., "FRONT", "BACK", "NECK", "STRIP") */
|
|
119
|
+
container_position: string | null;
|
|
120
|
+
/** File extension (e.g., "jpg", "png") */
|
|
121
|
+
extension_type: string | null;
|
|
104
122
|
/** Image width in pixels */
|
|
105
|
-
|
|
123
|
+
width_pixels: number | null;
|
|
106
124
|
/** Image height in pixels */
|
|
107
|
-
|
|
125
|
+
height_pixels: number | null;
|
|
126
|
+
/** Physical label width in inches */
|
|
127
|
+
width_inches: number | null;
|
|
128
|
+
/** Physical label height in inches */
|
|
129
|
+
height_inches: number | null;
|
|
130
|
+
/** File size in megabytes */
|
|
131
|
+
file_size_mb: number | null;
|
|
132
|
+
/** Number of barcodes detected in this image */
|
|
133
|
+
barcode_count: number;
|
|
134
|
+
/** Number of QR codes detected in this image */
|
|
135
|
+
qrcode_count: number;
|
|
136
|
+
/** Signed URL to the image (when available) */
|
|
137
|
+
image_url?: string;
|
|
108
138
|
}
|
|
109
139
|
/**
|
|
110
140
|
* Barcode found on a COLA label
|
|
111
141
|
*/
|
|
112
142
|
interface ColaBarcode {
|
|
113
|
-
/** The barcode value/number */
|
|
114
|
-
barcode_value: string;
|
|
115
143
|
/** Type of barcode (e.g., "UPC-A", "EAN-13") */
|
|
116
144
|
barcode_type: string | null;
|
|
145
|
+
/** The barcode value/number */
|
|
146
|
+
barcode_value: string;
|
|
147
|
+
/** TTB image ID where this barcode was found */
|
|
148
|
+
ttb_image_id: string;
|
|
149
|
+
/** Barcode width in pixels */
|
|
150
|
+
width_pixels: number | null;
|
|
151
|
+
/** Barcode height in pixels */
|
|
152
|
+
height_pixels: number | null;
|
|
153
|
+
/** Barcode orientation (e.g., "horizontal", "vertical") */
|
|
154
|
+
orientation: string | null;
|
|
155
|
+
/** Position of the barcode relative to the image */
|
|
156
|
+
relative_image_position: string | null;
|
|
117
157
|
}
|
|
118
158
|
/**
|
|
119
159
|
* Full details for a COLA including images and barcodes
|
|
120
160
|
*/
|
|
121
161
|
interface ColaDetail extends ColaSummary {
|
|
122
|
-
/**
|
|
162
|
+
/** Product class ID */
|
|
163
|
+
class_id: string | null;
|
|
164
|
+
/** Origin ID */
|
|
165
|
+
origin_id: string | null;
|
|
166
|
+
/** Date of the most recent update (ISO date string) */
|
|
167
|
+
latest_update_date: string | null;
|
|
168
|
+
/** Whether the container has a distinctive shape */
|
|
169
|
+
is_distinctive_container: boolean | null;
|
|
170
|
+
/** Distinctive container capacity */
|
|
171
|
+
for_distinctive_capacity: string | null;
|
|
172
|
+
/** Whether this is a resubmission */
|
|
173
|
+
is_resubmission: boolean | null;
|
|
174
|
+
/** TTB ID of the original submission if this is a resubmission */
|
|
175
|
+
for_resubmission_ttb_id: string | null;
|
|
176
|
+
/** State exemption, if applicable */
|
|
177
|
+
for_exemption_state: string | null;
|
|
178
|
+
/** Applicant address recipient */
|
|
179
|
+
address_recipient: string | null;
|
|
180
|
+
/** Applicant ZIP code */
|
|
181
|
+
address_zip_code: string | null;
|
|
182
|
+
/** Applicant state */
|
|
183
|
+
address_state: string | null;
|
|
184
|
+
/** Grape varietals (wine) */
|
|
185
|
+
grape_varietals: string | null;
|
|
186
|
+
/** Vintage year (wine) */
|
|
187
|
+
wine_vintage_year: number | null;
|
|
188
|
+
/** Appellation (wine) */
|
|
189
|
+
wine_appellation: string | null;
|
|
190
|
+
/** LLM-extracted container type */
|
|
191
|
+
llm_container_type: string | null;
|
|
192
|
+
/** LLM-extracted product description */
|
|
193
|
+
llm_product_description: string | null;
|
|
194
|
+
/** LLM-extracted brand established year */
|
|
195
|
+
llm_brand_established_year: number | null;
|
|
196
|
+
/** LLM-extracted tasting note flavors */
|
|
197
|
+
llm_tasting_note_flavors: string | null;
|
|
198
|
+
/** LLM-extracted artwork credit */
|
|
199
|
+
llm_artwork_credit: string | null;
|
|
200
|
+
/** LLM-extracted wine designation */
|
|
201
|
+
llm_wine_designation: string | null;
|
|
202
|
+
/** LLM-extracted International Bitterness Units (beer) */
|
|
203
|
+
llm_beer_ibu: number | null;
|
|
204
|
+
/** LLM-extracted hop varieties (beer) */
|
|
205
|
+
llm_beer_hops_varieties: string | null;
|
|
206
|
+
/** LLM-extracted aged years (liquor) */
|
|
207
|
+
llm_liquor_aged_years: number | null;
|
|
208
|
+
/** LLM-extracted finishing process (liquor) */
|
|
209
|
+
llm_liquor_finishing_process: string | null;
|
|
210
|
+
/** LLM-extracted grains used (liquor) */
|
|
211
|
+
llm_liquor_grains: string | null;
|
|
212
|
+
/** Primary barcode type on this COLA */
|
|
213
|
+
barcode_type: string | null;
|
|
214
|
+
/** Primary barcode value on this COLA */
|
|
215
|
+
barcode_value: string | null;
|
|
216
|
+
/** QR code URL if present */
|
|
217
|
+
qrcode_url: string | null;
|
|
218
|
+
/** Whether a front label image exists */
|
|
219
|
+
has_front_image: boolean;
|
|
220
|
+
/** Whether a back label image exists */
|
|
221
|
+
has_back_image: boolean;
|
|
222
|
+
/** Whether a neck label image exists */
|
|
223
|
+
has_neck_image: boolean;
|
|
224
|
+
/** Whether a strip label image exists */
|
|
225
|
+
has_strip_image: boolean;
|
|
226
|
+
/** All images associated with this COLA */
|
|
123
227
|
images: ColaImage[];
|
|
124
|
-
/**
|
|
228
|
+
/** All barcodes found on this COLA's images */
|
|
125
229
|
barcodes: ColaBarcode[];
|
|
126
|
-
/** LLM-extracted description */
|
|
127
|
-
llm_description: string | null;
|
|
128
|
-
/** LLM-extracted ingredients */
|
|
129
|
-
llm_ingredients: string | null;
|
|
130
|
-
/** LLM-extracted tasting notes */
|
|
131
|
-
llm_tasting_notes: string | null;
|
|
132
|
-
/** LLM-extracted producer/brand information */
|
|
133
|
-
llm_producer: string | null;
|
|
134
|
-
/** Vintage year for wines */
|
|
135
|
-
vintage: number | null;
|
|
136
|
-
/** Grape varietal(s) */
|
|
137
|
-
varietal: string | null;
|
|
138
|
-
/** Wine appellation */
|
|
139
|
-
appellation: string | null;
|
|
140
|
-
/** Beer style */
|
|
141
|
-
beer_style: string | null;
|
|
142
|
-
/** International Bitterness Units */
|
|
143
|
-
ibu: number | null;
|
|
144
|
-
/** Status of the COLA */
|
|
145
|
-
status: string | null;
|
|
146
|
-
/** Date the COLA was submitted */
|
|
147
|
-
submitted_date: string | null;
|
|
148
|
-
/** Serial number */
|
|
149
|
-
serial_number: string | null;
|
|
150
230
|
}
|
|
151
231
|
/**
|
|
152
232
|
* Query parameters for searching/listing COLAs
|
|
@@ -183,14 +263,20 @@ interface PermitteeSummary {
|
|
|
183
263
|
company_name: string | null;
|
|
184
264
|
/** State where the company is located */
|
|
185
265
|
company_state: string | null;
|
|
266
|
+
/** Company ZIP code */
|
|
267
|
+
company_zip_code: string | null;
|
|
186
268
|
/** Type of permit */
|
|
187
269
|
permittee_type: string | null;
|
|
188
270
|
/** Whether the permit is currently active */
|
|
189
271
|
is_active: boolean;
|
|
272
|
+
/** Reason for active/inactive status */
|
|
273
|
+
active_reason: string | null;
|
|
190
274
|
/** Total number of COLAs */
|
|
191
275
|
colas: number;
|
|
192
276
|
/** Number of approved COLAs */
|
|
193
277
|
colas_approved: number;
|
|
278
|
+
/** Date of most recent COLA application (ISO date string) */
|
|
279
|
+
last_cola_application_date: string | null;
|
|
194
280
|
}
|
|
195
281
|
/**
|
|
196
282
|
* Full details for a permittee including recent COLAs
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "colacloud",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "Official JavaScript/TypeScript SDK for the COLA Cloud API - access the TTB COLA Registry of alcohol product label approvals",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|