@deliverart/sdk-js-image 0.0.0-dev-20260721002647

package/README.md

@@ -0,0 +1,141 @@
+# @deliverart/sdk-js-image
+
+Image management package for the DeliverArt JavaScript SDK.
+
+## Installation
+
+```bash
+npm install @deliverart/sdk-js-image @deliverart/sdk-js-core
+```
+
+## Exported Types
+
+### Core Types
+- `Image` - Image metadata
+- `ImageDetails` - Extended image with URLs
+
+### IRI Types
+- `ImageIri` - Image IRI (`/images/:id`)
+
+## Available Requests
+
+### GetImages
+Get list of images with filters.
+
+```typescript
+import { GetImages } from '@deliverart/sdk-js-image';
+
+const images = await sdk.call(new GetImages({
+  query: {
+    company: '/companies/123',
+    page: 1
+  }
+}));
+```
+
+**Query Parameters:**
+- `company?: string` - Filter by company
+- `page?: number` - Page number
+
+**Response:** `Paginated<Image>`
+
+---
+
+### GetImageDetails
+Get detailed information about a specific image.
+
+```typescript
+import { GetImageDetails } from '@deliverart/sdk-js-image';
+
+const image = await sdk.call(new GetImageDetails('image-123'));
+```
+
+**Parameters:**
+- `imageId: string` (required)
+
+**Response:** `ImageDetails`
+
+---
+
+### DeleteImage
+Delete an image.
+
+```typescript
+import { DeleteImage } from '@deliverart/sdk-js-image';
+
+await sdk.call(new DeleteImage('image-123'));
+```
+
+**Parameters:**
+- `imageId: string` (required)
+
+**Response:** `void`
+
+---
+
+## Upload Images
+
+Image uploads typically use multipart/form-data. Example:
+
+```typescript
+import { AbstractApiRequest } from '@deliverart/sdk-js-core';
+import { z } from 'zod';
+
+// Custom upload request (if not provided by the package)
+class UploadImage extends AbstractApiRequest<
+  typeof z.instanceof(FormData),
+  typeof imageResponseSchema
+> {
+  readonly method = 'POST';
+  readonly contentType = 'multipart/form-data';
+  readonly accept = 'application/json';
+  
+  readonly inputSchema = z.instanceof(FormData);
+  readonly outputSchema = imageResponseSchema;
+
+  constructor(formData: FormData) {
+    super(formData);
+  }
+
+  getPath(): string {
+    return '/images';
+  }
+}
+
+// Usage
+const formData = new FormData();
+formData.append('file', fileBlob, 'image.jpg');
+formData.append('company', '/companies/123');
+
+const image = await sdk.call(new UploadImage(formData));
+```
+
+## Complete Usage Example
+
+```typescript
+import { sdk } from './lib/sdk';
+import { GetImages, DeleteImage } from '@deliverart/sdk-js-image';
+
+async function imageManagement() {
+  // Get all company images
+  const images = await sdk.call(new GetImages({
+    query: {
+      company: '/companies/123'
+    }
+  }));
+
+  console.log(`Found ${images.pagination.totalItems} images`);
+
+  // Delete old images
+  for (const image of images.data) {
+    if (shouldDelete(image)) {
+      await sdk.call(new DeleteImage(image.id));
+    }
+  }
+}
+```
+
+## License
+
+MIT
+

package/dist/index.cjs

@@ -0,0 +1,281 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  DeleteImage: () => DeleteImage,
+  GetImageDetails: () => GetImageDetails,
+  GetImageTagsFromPointOfSale: () => GetImageTagsFromPointOfSale,
+  GetImages: () => GetImages,
+  GetImagesFromPointOfSale: () => GetImagesFromPointOfSale,
+  UpdateImage: () => UpdateImage,
+  UploadImage: () => UploadImage,
+  createImageUploadFormData: () => createImageUploadFormData,
+  deleteImageInputSchema: () => deleteImageInputSchema,
+  deleteImageResponseSchema: () => deleteImageResponseSchema,
+  getImageDetailsInputSchema: () => getImageDetailsInputSchema,
+  getImageDetailsResponseSchema: () => getImageDetailsResponseSchema,
+  getImageTagsFromPointOfSaleInputSchema: () => getImageTagsFromPointOfSaleInputSchema,
+  getImageTagsFromPointOfSaleResponseSchema: () => getImageTagsFromPointOfSaleResponseSchema,
+  getImagesFromPointOfSaleInputSchema: () => getImagesFromPointOfSaleInputSchema,
+  getImagesFromPointOfSaleQuerySchema: () => getImagesFromPointOfSaleQuerySchema,
+  getImagesFromPointOfSaleResponseSchema: () => getImagesFromPointOfSaleResponseSchema,
+  getImagesInputSchema: () => getImagesInputSchema,
+  getImagesQuerySchema: () => getImagesQuerySchema,
+  getImagesResponseSchema: () => getImagesResponseSchema,
+  imageIriSchema: () => imageIriSchema,
+  imageNullableIriSchema: () => imageNullableIriSchema,
+  imageSchema: () => imageSchema,
+  imagesQuerySchema: () => imagesQuerySchema,
+  updateImageInputSchema: () => updateImageInputSchema,
+  updateImageResponseSchema: () => updateImageResponseSchema,
+  uploadImageInputSchema: () => uploadImageInputSchema,
+  uploadImageResponseSchema: () => uploadImageResponseSchema
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/models.ts
+var import_sdk_js_global_types = require("@deliverart/sdk-js-global-types");
+var import_zod = require("zod");
+var baseImageSchema = import_zod.z.object({
+  id: import_zod.z.string(),
+  variant: import_zod.z.string().nullable(),
+  contentUrl: import_zod.z.url(),
+  filePath: import_zod.z.string(),
+  tags: import_zod.z.array(import_zod.z.string()).default([]),
+  createdAt: import_sdk_js_global_types.datetimeSchema,
+  updatedAt: import_sdk_js_global_types.datetimeSchema
+});
+var imageSchema = baseImageSchema.extend({
+  variants: import_zod.z.array(baseImageSchema).default([])
+});
+var imagesQuerySchema = import_zod.z.object({
+  page: import_zod.z.coerce.number().optional(),
+  tags: import_zod.z.array(import_zod.z.string()).optional(),
+  "tags.match": import_sdk_js_global_types.arrayContainsMatchSchema.optional(),
+  "exists[original]": import_sdk_js_global_types.booleanSchema.optional()
+});
+
+// src/requests/DeleteImage.ts
+var import_sdk_js_core = require("@deliverart/sdk-js-core");
+var import_sdk_js_global_types2 = require("@deliverart/sdk-js-global-types");
+var import_zod2 = require("zod");
+var deleteImageInputSchema = import_zod2.z.undefined();
+var deleteImageResponseSchema = import_sdk_js_global_types2.emptyResponseSchema;
+var DeleteImage = class extends import_sdk_js_core.AbstractApiRequest {
+  constructor(imageId) {
+    super(void 0);
+    this.method = "DELETE";
+    this.contentType = "application/json";
+    this.accept = "application/json";
+    this.inputSchema = deleteImageInputSchema;
+    this.outputSchema = deleteImageResponseSchema;
+    this.querySchema = void 0;
+    this.headersSchema = void 0;
+    this.imageId = imageId;
+  }
+  getPath() {
+    return `/images/${this.imageId}`;
+  }
+};
+
+// src/requests/GetImageDetails.ts
+var import_sdk_js_core2 = require("@deliverart/sdk-js-core");
+var import_zod3 = require("zod");
+var getImageDetailsInputSchema = import_zod3.z.undefined();
+var getImageDetailsResponseSchema = imageSchema;
+var GetImageDetails = class extends import_sdk_js_core2.AbstractApiRequest {
+  constructor(imageId) {
+    super(void 0);
+    this.method = "GET";
+    this.contentType = "application/json";
+    this.accept = "application/json";
+    this.inputSchema = getImageDetailsInputSchema;
+    this.outputSchema = getImageDetailsResponseSchema;
+    this.querySchema = void 0;
+    this.headersSchema = void 0;
+    this.imageId = imageId;
+  }
+  getPath() {
+    return `/images/${this.imageId}`;
+  }
+};
+
+// src/requests/GetImages.ts
+var import_sdk_js_core3 = require("@deliverart/sdk-js-core");
+var import_sdk_js_global_types3 = require("@deliverart/sdk-js-global-types");
+var import_zod4 = require("zod");
+var getImagesQuerySchema = imagesQuerySchema;
+var getImagesInputSchema = import_zod4.z.undefined();
+var getImagesResponseSchema = (0, import_sdk_js_global_types3.createPaginatedSchema)(imageSchema);
+var GetImages = class extends import_sdk_js_core3.AbstractApiRequest {
+  constructor(options) {
+    super(void 0, options);
+    this.method = "GET";
+    this.contentType = "application/json";
+    this.accept = "application/json";
+    this.inputSchema = getImagesInputSchema;
+    this.outputSchema = getImagesResponseSchema;
+    this.querySchema = getImagesQuerySchema;
+    this.headersSchema = void 0;
+    this.listItemSchema = imageSchema;
+    this.paginationDefaultEnabled = true;
+  }
+  getPath() {
+    return "/images";
+  }
+};
+
+// src/requests/GetImagesFromPointOfSale.ts
+var import_sdk_js_core4 = require("@deliverart/sdk-js-core");
+var import_sdk_js_global_types4 = require("@deliverart/sdk-js-global-types");
+var import_zod5 = require("zod");
+var getImagesFromPointOfSaleQuerySchema = imagesQuerySchema;
+var getImagesFromPointOfSaleInputSchema = import_zod5.z.undefined();
+var getImagesFromPointOfSaleResponseSchema = (0, import_sdk_js_global_types4.createPaginatedSchema)(imageSchema);
+var GetImagesFromPointOfSale = class extends import_sdk_js_core4.AbstractApiRequest {
+  constructor(pointOfSaleId, options) {
+    super(void 0, options);
+    this.method = "GET";
+    this.contentType = "application/json";
+    this.accept = "application/json";
+    this.inputSchema = getImagesFromPointOfSaleInputSchema;
+    this.outputSchema = getImagesFromPointOfSaleResponseSchema;
+    this.querySchema = getImagesFromPointOfSaleQuerySchema;
+    this.headersSchema = void 0;
+    this.listItemSchema = imageSchema;
+    this.paginationDefaultEnabled = true;
+    this.pointOfSaleId = pointOfSaleId;
+  }
+  getPath() {
+    return `/point_of_sales/${this.pointOfSaleId}/images`;
+  }
+};
+
+// src/requests/GetImageTagsFromPointOfSale.ts
+var import_sdk_js_core5 = require("@deliverart/sdk-js-core");
+var import_zod6 = require("zod");
+var getImageTagsFromPointOfSaleInputSchema = import_zod6.z.undefined();
+var getImageTagsFromPointOfSaleResponseSchema = import_zod6.z.array(import_zod6.z.string());
+var GetImageTagsFromPointOfSale = class extends import_sdk_js_core5.AbstractApiRequest {
+  constructor(pointOfSaleId) {
+    super(void 0);
+    this.method = "GET";
+    this.contentType = "application/json";
+    this.accept = "application/json";
+    this.inputSchema = getImageTagsFromPointOfSaleInputSchema;
+    this.outputSchema = getImageTagsFromPointOfSaleResponseSchema;
+    this.querySchema = void 0;
+    this.headersSchema = void 0;
+    this.pointOfSaleId = pointOfSaleId;
+  }
+  getPath() {
+    return `/point_of_sales/${this.pointOfSaleId}/images/tags`;
+  }
+};
+
+// src/requests/UpdateImage.ts
+var import_sdk_js_core6 = require("@deliverart/sdk-js-core");
+var updateImageInputSchema = imageSchema.pick({
+  tags: true
+}).partial();
+var updateImageResponseSchema = imageSchema;
+var UpdateImage = class extends import_sdk_js_core6.AbstractApiRequest {
+  constructor(imageId, input) {
+    super(input);
+    this.method = "PATCH";
+    this.contentType = "application/merge-patch+json";
+    this.accept = "application/json";
+    this.inputSchema = updateImageInputSchema;
+    this.outputSchema = updateImageResponseSchema;
+    this.querySchema = void 0;
+    this.headersSchema = void 0;
+    this.imageId = imageId;
+  }
+  getPath() {
+    return `/images/${this.imageId}`;
+  }
+};
+
+// src/requests/UploadImage.ts
+var import_sdk_js_core7 = require("@deliverart/sdk-js-core");
+var import_zod7 = require("zod");
+var uploadImageInputSchema = import_zod7.z.instanceof(FormData);
+var uploadImageResponseSchema = imageSchema;
+var UploadImage = class extends import_sdk_js_core7.AbstractApiRequest {
+  constructor(input) {
+    super(input);
+    this.method = "POST";
+    this.contentType = "multipart/form-data";
+    this.accept = "application/json";
+    this.inputSchema = uploadImageInputSchema;
+    this.outputSchema = uploadImageResponseSchema;
+    this.querySchema = void 0;
+    this.headersSchema = void 0;
+  }
+  getPath() {
+    return `/images`;
+  }
+};
+function createImageUploadFormData(pointOfSaleId, file, tags) {
+  const formData = new FormData();
+  formData.append("file", file);
+  formData.append("pointOfSale", `/point_of_sales/${pointOfSaleId}`);
+  if (tags && tags.length > 0) {
+    formData.append("tags", tags.join(","));
+  }
+  return formData;
+}
+
+// src/types.ts
+var import_sdk_js_global_types5 = require("@deliverart/sdk-js-global-types");
+var imageIriSchema = (0, import_sdk_js_global_types5.iriSchema)("/images/:id");
+var imageNullableIriSchema = (0, import_sdk_js_global_types5.iriNullableSchema)("/images/:id");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DeleteImage,
+  GetImageDetails,
+  GetImageTagsFromPointOfSale,
+  GetImages,
+  GetImagesFromPointOfSale,
+  UpdateImage,
+  UploadImage,
+  createImageUploadFormData,
+  deleteImageInputSchema,
+  deleteImageResponseSchema,
+  getImageDetailsInputSchema,
+  getImageDetailsResponseSchema,
+  getImageTagsFromPointOfSaleInputSchema,
+  getImageTagsFromPointOfSaleResponseSchema,
+  getImagesFromPointOfSaleInputSchema,
+  getImagesFromPointOfSaleQuerySchema,
+  getImagesFromPointOfSaleResponseSchema,
+  getImagesInputSchema,
+  getImagesQuerySchema,
+  getImagesResponseSchema,
+  imageIriSchema,
+  imageNullableIriSchema,
+  imageSchema,
+  imagesQuerySchema,
+  updateImageInputSchema,
+  updateImageResponseSchema,
+  uploadImageInputSchema,
+  uploadImageResponseSchema
+});