@ominity/api-typescript 1.4.2 → 1.4.4

package/src/sdk/commerce/shipping-classes.ts

@@ -0,0 +1,8 @@
+import { shippingClassesGet, shippingClassesList } from "../../funcs/commerce/index.js";
+import { ClientSDK, RequestOptions } from "../../lib/sdks.js";
+import * as operations from "../../models/operations/index.js";
+import { unwrapAsync } from "../../types/fp.js";
+export class ShippingClasses extends ClientSDK {
+  async list(request: operations.ListShippingClassesRequest = {}, options?: RequestOptions): Promise<operations.ListShippingClassesResponse> { return unwrapAsync(shippingClassesList(this, request, options)); }
+  async get(request: operations.GetShippingClassRequest, options?: RequestOptions): Promise<operations.GetShippingClassResponse> { return unwrapAsync(shippingClassesGet(this, request, options)); }
+}

package/src/sdk/media-library.ts

@@ -0,0 +1,28 @@
+import {
+  mediaLibraryDownload,
+  mediaLibraryFoldersCreate,
+  mediaLibraryFoldersList,
+  mediaLibraryItemsDelete,
+  mediaLibraryItemsMove,
+  mediaLibraryItemsRename,
+  mediaLibraryList,
+  mediaLibrarySearch,
+  mediaLibrarySource,
+  mediaLibraryUploadsPresign,
+} from "../funcs/mediaLibrary.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class MediaLibrary extends ClientSDK {
+  async list(request: operations.ListMediaRequest = {}, options?: RequestOptions): Promise<operations.ListMediaResponse> { return unwrapAsync(mediaLibraryList(this, request, options)); }
+  async listFolders(request: operations.ListMediaFoldersRequest = {}, options?: RequestOptions): Promise<operations.ListMediaFoldersResponse> { return unwrapAsync(mediaLibraryFoldersList(this, request, options)); }
+  async createFolder(request: operations.CreateMediaFolderRequest, options?: RequestOptions): Promise<operations.CreateMediaFolderResponse> { return unwrapAsync(mediaLibraryFoldersCreate(this, request, options)); }
+  async presignUpload(request: operations.PresignMediaUploadRequest, options?: RequestOptions): Promise<operations.PresignMediaUploadResponse> { return unwrapAsync(mediaLibraryUploadsPresign(this, request, options)); }
+  async deleteItem(request: operations.DeleteMediaItemRequest, options?: RequestOptions): Promise<void> { return unwrapAsync(mediaLibraryItemsDelete(this, request, options)); }
+  async moveItem(request: operations.MoveMediaItemRequest, options?: RequestOptions): Promise<void> { return unwrapAsync(mediaLibraryItemsMove(this, request, options)); }
+  async renameItem(request: operations.RenameMediaItemRequest, options?: RequestOptions): Promise<operations.RenameMediaItemResponse> { return unwrapAsync(mediaLibraryItemsRename(this, request, options)); }
+  async search(request: operations.SearchMediaRequest, options?: RequestOptions): Promise<operations.SearchMediaResponse> { return unwrapAsync(mediaLibrarySearch(this, request, options)); }
+  async source(request: operations.GetMediaSourceRequest, options?: RequestOptions): Promise<Uint8Array> { return unwrapAsync(mediaLibrarySource(this, request, options)); }
+  async download(request: operations.DownloadMediaRequest, options?: RequestOptions): Promise<Uint8Array> { return unwrapAsync(mediaLibraryDownload(this, request, options)); }
+}

package/src/sdk/sdk.ts

@@ -11,6 +11,8 @@ import { Settings } from "./settings/index.js";
 import { Users } from "./users/index.js";
 import { Admins } from "./admins.js";
 import { Tracking } from "./tracking/index.js";
+import { MediaLibrary } from "./media-library.js";
+import { Translations } from "./translations.js";
 import type { SDKOptions } from "../lib/config.js";
 import type {
   OminityModuleInput,
@@ -97,6 +99,16 @@ export class Ominity extends ClientSDK {
     return (this._admins ??= new Admins(this._options));
   }
 
+  private _mediaLibrary?: MediaLibrary;
+  get mediaLibrary(): MediaLibrary {
+    return (this._mediaLibrary ??= new MediaLibrary(this._options));
+  }
+
+  private _translations?: Translations;
+  get translations(): Translations {
+    return (this._translations ??= new Translations(this._options));
+  }
+
   protected override _propagateLanguage(language: string | undefined): void {
     this._commerce?.setLanguage(language);
     this._cms?.setLanguage(language);
@@ -108,5 +120,7 @@ export class Ominity extends ClientSDK {
     this._me?.setLanguage(language);
     this._users?.setLanguage(language);
     this._admins?.setLanguage(language);
+    this._mediaLibrary?.setLanguage(language);
+    this._translations?.setLanguage(language);
   }
 }

package/src/sdk/settings/configured-languages.ts

@@ -0,0 +1,7 @@
+import { configuredLanguagesList } from "../../funcs/settings/configuredLanguages.js";
+import { ClientSDK, RequestOptions } from "../../lib/sdks.js";
+import * as operations from "../../models/operations/index.js";
+import { unwrapAsync } from "../../types/fp.js";
+export class ConfiguredLanguages extends ClientSDK {
+  async list(request: operations.ListConfiguredLanguagesRequest = {}, options?: RequestOptions): Promise<operations.ListConfiguredLanguagesResponse> { return unwrapAsync(configuredLanguagesList(this, request, options)); }
+}

package/src/sdk/settings/customer-groups.ts

@@ -0,0 +1,8 @@
+import { settingCustomerGroupsGet, settingCustomerGroupsList } from "../../funcs/settings/customerGroups.js";
+import { ClientSDK, RequestOptions } from "../../lib/sdks.js";
+import * as operations from "../../models/operations/index.js";
+import { unwrapAsync } from "../../types/fp.js";
+export class CustomerGroups extends ClientSDK {
+  async list(request: operations.ListSettingCustomerGroupsRequest = {}, options?: RequestOptions): Promise<operations.ListSettingCustomerGroupsResponse> { return unwrapAsync(settingCustomerGroupsList(this, request, options)); }
+  async get(request: operations.GetSettingCustomerGroupRequest, options?: RequestOptions): Promise<operations.GetSettingCustomerGroupResponse> { return unwrapAsync(settingCustomerGroupsGet(this, request, options)); }
+}

package/src/sdk/settings/index.ts

@@ -6,15 +6,24 @@ import { ClientSDK } from "../../lib/sdks.js";
 import { Countries } from "./countries.js";
 import { SocialProviders } from "./social-providers.js";
 import { PaymentMethods } from "./payment-methods.js";
+import { CustomerGroups } from "./customer-groups.js";
+import { PaymentMethodIssuers } from "./payment-method-issuers.js";
+import { ConfiguredLanguages } from "./configured-languages.js";
 
 export { Countries } from "./countries.js";
 export { SocialProviders } from "./social-providers.js";
 export { PaymentMethods } from "./payment-methods.js";
+export { CustomerGroups } from "./customer-groups.js";
+export { PaymentMethodIssuers } from "./payment-method-issuers.js";
+export { ConfiguredLanguages } from "./configured-languages.js";
 
 export class Settings extends ClientSDK {
     private _countries?: Countries;
     private _socialProviders?: SocialProviders;
     private _paymentMethods?: PaymentMethods;
+    private _customerGroups?: CustomerGroups;
+    private _paymentMethodIssuers?: PaymentMethodIssuers;
+    private _languages?: ConfiguredLanguages;
 
     get countries(): Countries {
         return (this._countries ??= new Countries(this._options));
@@ -28,9 +37,16 @@ export class Settings extends ClientSDK {
         return (this._paymentMethods ??= new PaymentMethods(this._options));
     }
 
+    get customerGroups(): CustomerGroups { return (this._customerGroups ??= new CustomerGroups(this._options)); }
+    get paymentMethodIssuers(): PaymentMethodIssuers { return (this._paymentMethodIssuers ??= new PaymentMethodIssuers(this._options)); }
+    get languages(): ConfiguredLanguages { return (this._languages ??= new ConfiguredLanguages(this._options)); }
+
     protected override _propagateLanguage(language: string | undefined): void {
         this._countries?.setLanguage(language);
         this._socialProviders?.setLanguage(language);
         this._paymentMethods?.setLanguage(language);
+        this._customerGroups?.setLanguage(language);
+        this._paymentMethodIssuers?.setLanguage(language);
+        this._languages?.setLanguage(language);
     }
 }

package/src/sdk/settings/payment-method-issuers.ts

@@ -0,0 +1,8 @@
+import { paymentMethodIssuersGet, paymentMethodIssuersList } from "../../funcs/settings/paymentMethodIssuers.js";
+import { ClientSDK, RequestOptions } from "../../lib/sdks.js";
+import * as operations from "../../models/operations/index.js";
+import { unwrapAsync } from "../../types/fp.js";
+export class PaymentMethodIssuers extends ClientSDK {
+  async list(request: operations.ListPaymentMethodIssuersRequest, options?: RequestOptions): Promise<operations.ListPaymentMethodIssuersResponse> { return unwrapAsync(paymentMethodIssuersList(this, request, options)); }
+  async get(request: operations.GetPaymentMethodIssuerRequest, options?: RequestOptions): Promise<operations.GetPaymentMethodIssuerResponse> { return unwrapAsync(paymentMethodIssuersGet(this, request, options)); }
+}

package/src/sdk/translations.ts

@@ -0,0 +1,7 @@
+import { translationsBulk } from "../funcs/translations.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export class Translations extends ClientSDK {
+  async bulk(request: operations.BulkTranslateRequest, options?: RequestOptions): Promise<operations.BulkTranslateResponse> { return unwrapAsync(translationsBulk(this, request, options)); }
+}

package/tests/core-operations.test.mjs

@@ -0,0 +1,170 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+import * as api from "../dist/esm/index.js";
+import { Subscription$inboundSchema } from "../dist/esm/models/index.js";
+
+const noRetries = { retries: { strategy: "none" } };
+
+const operationCases = [
+  ["customersList", {}, "GET", "/commerce/customers"],
+  ["customersGet", { id: 1 }, "GET", "/commerce/customers/1"],
+  ["customersCreate", { data: { type: "private" } }, "POST", "/commerce/customers"],
+  ["customersUpdate", { id: 1, data: { name: "Customer" } }, "PATCH", "/commerce/customers/1"],
+  ["customerAddressesList", { customerId: 1 }, "GET", "/commerce/customers/1/addresses"],
+  ["customerAddressesGet", { customerId: 1, id: 2 }, "GET", "/commerce/customers/1/addresses/2"],
+  ["customerAddressesCreate", { customerId: 1, data: { street: "Main", number: "1", postalCode: "1000", city: "Brussels", country: "BE" } }, "POST", "/commerce/customers/1/addresses"],
+  ["customerAddressesUpdate", { customerId: 1, id: 2, data: { city: "Ghent" } }, "PATCH", "/commerce/customers/1/addresses/2"],
+  ["customerAddressesDelete", { customerId: 1, id: 2 }, "DELETE", "/commerce/customers/1/addresses/2"],
+  ["customerGroupsList", { customerId: 1 }, "GET", "/commerce/customers/1/groups"],
+  ["customerGroupsGet", { customerId: 1, id: 2 }, "GET", "/commerce/customers/1/groups/2"],
+  ["customerMandatesList", { customerId: 1 }, "GET", "/commerce/customers/1/mandates"],
+  ["customerMandatesGet", { customerId: 1, id: 2 }, "GET", "/commerce/customers/1/mandates/2"],
+  ["customerMandatesCreate", { customerId: 1, data: {} }, "POST", "/commerce/customers/1/mandates"],
+  ["customerMandatesUpdate", { customerId: 1, id: 2, data: {} }, "PATCH", "/commerce/customers/1/mandates/2"],
+  ["customerMandatesDelete", { customerId: 1, id: 2 }, "DELETE", "/commerce/customers/1/mandates/2"],
+  ["customerPaymentsList", { customerId: 1 }, "GET", "/commerce/customers/1/payments"],
+  ["customerPaymentsGet", { customerId: 1, id: 2 }, "GET", "/commerce/customers/1/payments/2"],
+  ["customerPaymentsCreate", { customerId: 1, data: { paymentmethodId: 3, redirectUrl: "https://example.test/return" } }, "POST", "/commerce/customers/1/payments"],
+  ["customerPaymentsDelete", { customerId: 1, id: 2 }, "DELETE", "/commerce/customers/1/payments/2"],
+  ["customerOrdersList", { customerId: 1 }, "GET", "/commerce/customers/1/orders"],
+  ["customerOrdersGet", { customerId: 1, id: 2 }, "GET", "/commerce/customers/1/orders/2"],
+  ["customerOrdersCreate", { customerId: 1, data: {} }, "POST", "/commerce/customers/1/orders"],
+  ["customerOrdersUpdate", { customerId: 1, id: 2, data: {} }, "PATCH", "/commerce/customers/1/orders/2"],
+  ["customerOrdersDelete", { customerId: 1, id: 2 }, "DELETE", "/commerce/customers/1/orders/2"],
+  ["customerInvoicesList", { customerId: 1 }, "GET", "/commerce/customers/1/invoices"],
+  ["customerInvoicesGet", { customerId: 1, id: 2 }, "GET", "/commerce/customers/1/invoices/2"],
+  ["customerInvoicesDownloadPdf", { customerId: 1, id: 2 }, "GET", "/commerce/customers/1/invoices/2/pdf"],
+  ["customerSubscriptionsList", { customerId: 1 }, "GET", "/commerce/customers/1/subscriptions"],
+  ["customerSubscriptionsGet", { customerId: 1, id: 2 }, "GET", "/commerce/customers/1/subscriptions/2"],
+  ["customerSubscriptionsCreate", { customerId: 1, data: {} }, "POST", "/commerce/customers/1/subscriptions"],
+  ["customerSubscriptionsUpdate", { customerId: 1, id: 2, data: { paused: true } }, "PATCH", "/commerce/customers/1/subscriptions/2"],
+  ["customerSubscriptionsDelete", { customerId: 1, id: 2 }, "DELETE", "/commerce/customers/1/subscriptions/2"],
+  ["customerSubscriptionsRenew", { customerId: 1, id: 2 }, "POST", "/commerce/customers/1/subscriptions/2/renew"],
+  ["customerSubscriptionsListTransitionProducts", { customerId: 1, subscriptionId: 2 }, "GET", "/commerce/customers/1/subscriptions/2/transition"],
+  ["customerSubscriptionsGetTransitionProduct", { customerId: 1, subscriptionId: 2, productId: 3 }, "GET", "/commerce/customers/1/subscriptions/2/transition/3"],
+  ["shippingClassesList", {}, "GET", "/commerce/shipping-classes"],
+  ["shippingClassesGet", { id: 1 }, "GET", "/commerce/shipping-classes/1"],
+  ["invoicesCreate", { data: {} }, "POST", "/commerce/invoices"],
+  ["invoicesUpdate", { id: 1, data: {} }, "PATCH", "/commerce/invoices/1"],
+  ["invoicesDownloadPdf", { id: 1 }, "GET", "/commerce/invoices/1/pdf"],
+  ["paymentsList", {}, "GET", "/commerce/payments"],
+  ["paymentsCreate", { data: { paymentmethodId: 3, redirectUrl: "https://example.test/return" } }, "POST", "/commerce/payments"],
+  ["orderPaymentsCreate", { orderId: "1", data: { paymentmethodId: 3, redirectUrl: "https://example.test/return" } }, "POST", "/commerce/orders/1/payments"],
+  ["orderPaymentsGet", { orderId: "1", id: 2 }, "GET", "/commerce/orders/1/payments/2"],
+  ["productsOfferGet", { productId: 1, id: 2 }, "GET", "/commerce/products/1/offers/2"],
+  ["cartShippingMethodsList", { cartId: "cart-id" }, "GET", "/commerce/carts/cart-id/shipping-methods"],
+  ["componentFieldsList", { componentId: 1 }, "GET", "/cms/components/1/fields"],
+  ["componentFieldsGet", { componentId: 1, id: 2 }, "GET", "/cms/components/1/fields/2"],
+  ["pageComponentsGet", { pageId: 1, id: 2 }, "GET", "/cms/pages/1/components/2"],
+  ["pageComponentFieldsGet", { pageId: 1, pageComponentId: 2, id: 3 }, "GET", "/cms/pages/1/components/2/fields/3"],
+  ["cmsRoutesList", {}, "GET", "/cms/routes"],
+  ["cmsRoutesGet", { id: 1 }, "GET", "/cms/routes/1"],
+  ["settingCustomerGroupsList", {}, "GET", "/settings/customer-groups"],
+  ["settingCustomerGroupsGet", { id: 1 }, "GET", "/settings/customer-groups/1"],
+  ["paymentMethodIssuersList", { methodId: 1 }, "GET", "/settings/paymentmethods/1/issuers"],
+  ["paymentMethodIssuersGet", { methodId: 1, id: 2 }, "GET", "/settings/paymentmethods/1/issuers/2"],
+  ["configuredLanguagesList", {}, "GET", "/settings/languages"],
+  ["mediaLibraryList", {}, "GET", "/media-library"],
+  ["mediaLibraryFoldersList", {}, "GET", "/media-library/folders"],
+  ["mediaLibraryFoldersCreate", { data: { name: "folder" } }, "POST", "/media-library/folders"],
+  ["mediaLibraryUploadsPresign", { data: { filename: "image.jpg", mimeType: "image/jpeg", size: 100 } }, "POST", "/media-library/uploads/presign"],
+  ["mediaLibraryItemsDelete", { data: { path: "image.jpg", type: "file" } }, "DELETE", "/media-library/items"],
+  ["mediaLibraryItemsMove", { data: { path: "image.jpg", type: "file", targetPath: "archive/image.jpg" } }, "PATCH", "/media-library/items/move"],
+  ["mediaLibraryItemsRename", { data: { path: "image.jpg", type: "file", newName: "cover.jpg" } }, "PATCH", "/media-library/items/rename"],
+  ["mediaLibrarySearch", { q: "image" }, "GET", "/media-library/search"],
+  ["mediaLibrarySource", { path: "image.jpg" }, "GET", "/media-library/items/source"],
+  ["mediaLibraryDownload", { data: { items: [{ path: "image.jpg", type: "file" }] } }, "POST", "/media-library/downloads"],
+  ["translationsBulk", { data: { source_language: "en", target_languages: ["nl"], fields: [{ key: "title", source: "Hello" }] } }, "POST", "/translations/bulk"],
+];
+
+test("all added core operations construct the registered API method and path", async () => {
+  const seen = [];
+  const client = new api.OminityCore({
+    serverURL: "https://example.test/api",
+    httpClient: new api.HTTPClient({
+      fetcher: async (request) => {
+        seen.push(request);
+        return new Response("failure", { status: 500, headers: { "content-type": "text/plain" } });
+      },
+    }),
+  });
+
+  for (const [name, request, method, path] of operationCases) {
+    const operation = api[name];
+    assert.equal(typeof operation, "function", `${name} is exported`);
+    const [, call] = await operation(client, request, noRetries).$inspect();
+    assert.equal(call.status, "complete", `${name} reached the transport`);
+    assert.equal(call.request.method, method, `${name} method`);
+    assert.equal(new URL(call.request.url).pathname, `/api/v1${path}`, `${name} path`);
+  }
+
+  assert.equal(seen.length, operationCases.length);
+  assert.equal(operationCases.length, 69);
+});
+
+test("new operations encode deep filters, parse pagination, JSON bodies, and bytes", async () => {
+  const seen = [];
+  const responses = [
+    new Response(JSON.stringify({
+      _embedded: { customers: [{
+        resource: "customer", id: 7, type: "business", name: "Acme", email: "billing@acme.test", phone: null,
+        companyVat: null, billingAddress: null, shippingAddress: null, isTaxExempt: false, isGuest: false,
+        ownerId: 2, updatedAt: "2026-09-13T00:00:00Z", createdAt: "2026-09-13T00:00:00Z",
+      }] }, count: 1,
+    }), { status: 200, headers: { "content-type": "application/hal+json" } }),
+    new Response(null, { status: 204 }),
+    new Response(new Uint8Array([37, 80, 68, 70]), { status: 200, headers: { "content-type": "application/pdf" } }),
+    new Response(JSON.stringify({ translations: { nl: { title: "Hallo" } }, skipped: { nl: {} } }), { status: 200, headers: { "content-type": "application/json" } }),
+  ];
+  const sdk = new api.Ominity({
+    serverURL: "https://example.test/api",
+    httpClient: new api.HTTPClient({ fetcher: async (request) => {
+      seen.push({ url: request.url, method: request.method, body: await request.clone().text() });
+      return responses.shift();
+    } }),
+  });
+
+  const customers = await sdk.commerce.customers.list({ filter: { name: "Acme & Sons" }, page: 2, limit: 25 });
+  assert.equal(customers.items[0]?.id, 7);
+  assert.equal(customers.page, 2);
+  assert.match(seen[0].url, /filter%5Bname%5D=Acme%20%26%20Sons/);
+  await sdk.commerce.customerAddresses.delete({ customerId: 7, id: 3 });
+  assert.equal(seen[1].method, "DELETE");
+  assert.deepEqual([...await sdk.commerce.invoices.downloadPdf({ id: 12 })], [37, 80, 68, 70]);
+  const translated = await sdk.translations.bulk({ data: { source_language: "en", target_languages: ["nl"], fields: [{ key: "title", source: "Hello" }] } });
+  assert.equal(translated.translations.nl?.title, "Hallo");
+  assert.deepEqual(JSON.parse(seen[3].body), { source_language: "en", target_languages: ["nl"], fields: [{ key: "title", source: "Hello" }] });
+});
+
+test("Subscription parses the corrected productId field", () => {
+  const parsed = Subscription$inboundSchema.parse({
+    resource: "subscription", id: 1, customerId: 2, productId: 3, intervalId: 4, status: "active",
+    firstAmount: { value: "10.00", currency: "EUR" }, recurringAmount: { value: "10.00", currency: "EUR" },
+    currentPeriod: { startedAt: "", endsAt: "", daysLeft: 30 }, isPausable: true, expiresAt: null, dueAt: null,
+    updatedAt: "2026-09-13T00:00:00Z", createdAt: "2026-09-13T00:00:00Z",
+  });
+  assert.equal(parsed.productId, 3);
+});
+
+test("existing subscription interval and VAT helpers use the registered routes", async () => {
+  const seen = [];
+  const sdk = new api.Ominity({
+    serverURL: "https://example.test/api",
+    httpClient: new api.HTTPClient({
+      fetcher: async (request) => {
+        seen.push(request.url);
+        return new Response("failure", { status: 500, headers: { "content-type": "text/plain" } });
+      },
+    }),
+  });
+
+  await assert.rejects(sdk.commerce.subscriptionIntervals.list({}, noRetries));
+  await assert.rejects(sdk.commerce.subscriptionIntervals.get({ id: 4 }, noRetries));
+  await assert.rejects(sdk.commerce.vatValidations.get("BE0123456789", noRetries));
+
+  assert.deepEqual(seen.map((url) => new URL(url).pathname), [
+    "/api/v1/commerce/subscriptions/intervals",
+    "/api/v1/commerce/subscriptions/intervals/4",
+    "/api/v1/commerce/vatvalidations/BE0123456789",
+  ]);
+});