@swishapp/api-client 0.1.0

package/README.md

@@ -0,0 +1,27 @@
+# Swish API Client
+
+A JavaScript client for the Swish API with TypeScript support.
+
+## Installation
+
+```bash
+npm install @swish/api-client
+```
+
+## Usage
+
+```ts
+import { SwishClient } from "@swish/api-client";
+
+const client = new SwishClient({
+  apiKey: "your-api-key",
+  shop: "your-shopify-shop-name.myshopify.com",
+  key: "gid://shopify/Customer/123456789",
+});
+
+const { data } = await client.items.list();
+```
+
+## Documentation
+
+For more information on the Swish API, see the [Swish API documentation](https://docs.swish.app).

package/dist/client/client.gen.d.ts

@@ -0,0 +1,12 @@
+import type { ClientOptions } from './types.gen';
+import { type Config, type ClientOptions as DefaultClientOptions } from '@hey-api/client-fetch';
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
+export declare const client: import("@hey-api/client-fetch").Client;

package/dist/client/client.gen.js

@@ -0,0 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { createClient, createConfig } from '@hey-api/client-fetch';
+export const client = createClient(createConfig({
+    baseUrl: 'https://swish.app/api/unstable'
+}));

package/dist/client/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.gen';
+export * from './sdk.gen';

package/dist/client/index.js

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
+export * from './sdk.gen';

package/dist/client/sdk.gen.d.ts

@@ -0,0 +1,39 @@
+import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
+import type { ListControllerFindAllData, ListControllerCreateOneData, ListControllerDeleteOneData, ListControllerFindOneData, ListControllerUpdateOneData, ItemControllerDeleteManyData, ItemControllerFindAllData, ItemControllerCreateManyData, ItemControllerDeleteOneData, ItemControllerUpdateOneData } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+export declare const listControllerFindAll: <ThrowOnError extends boolean = false>(options: Options<ListControllerFindAllData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PaginatedResponseDto & {
+    data?: Array<import("./types.gen").List>;
+}, unknown, ThrowOnError>;
+export declare const listControllerCreateOne: <ThrowOnError extends boolean = false>(options: Options<ListControllerCreateOneData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ResponseDto & {
+    data?: import("./types.gen").List;
+}, unknown, ThrowOnError>;
+export declare const listControllerDeleteOne: <ThrowOnError extends boolean = false>(options: Options<ListControllerDeleteOneData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, unknown, ThrowOnError>;
+export declare const listControllerFindOne: <ThrowOnError extends boolean = false>(options: Options<ListControllerFindOneData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ResponseDto & {
+    data?: import("./types.gen").List;
+}, unknown, ThrowOnError>;
+export declare const listControllerUpdateOne: <ThrowOnError extends boolean = false>(options: Options<ListControllerUpdateOneData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ResponseDto & {
+    data?: import("./types.gen").List;
+}, unknown, ThrowOnError>;
+export declare const itemControllerDeleteMany: <ThrowOnError extends boolean = false>(options: Options<ItemControllerDeleteManyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, unknown, ThrowOnError>;
+export declare const itemControllerFindAll: <ThrowOnError extends boolean = false>(options: Options<ItemControllerFindAllData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PaginatedResponseDto & {
+    data?: Array<import("./types.gen").Item>;
+}, unknown, ThrowOnError>;
+export declare const itemControllerCreateMany: <ThrowOnError extends boolean = false>(options: Options<ItemControllerCreateManyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ResponseDto & {
+    data?: Array<import("./types.gen").Item>;
+}, unknown, ThrowOnError>;
+export declare const itemControllerDeleteOne: <ThrowOnError extends boolean = false>(options: Options<ItemControllerDeleteOneData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, unknown, ThrowOnError>;
+export declare const itemControllerUpdateOne: <ThrowOnError extends boolean = false>(options: Options<ItemControllerUpdateOneData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ResponseDto & {
+    data?: import("./types.gen").Item;
+}, unknown, ThrowOnError>;

package/dist/client/sdk.gen.js

@@ -0,0 +1,82 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { client as _heyApiClient } from './client.gen';
+export const listControllerFindAll = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/lists',
+        ...options
+    });
+};
+export const listControllerCreateOne = (options) => {
+    return (options.client ?? _heyApiClient).post({
+        url: '/lists',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+export const listControllerDeleteOne = (options) => {
+    return (options.client ?? _heyApiClient).delete({
+        url: '/lists/{listId}',
+        ...options
+    });
+};
+export const listControllerFindOne = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/lists/{listId}',
+        ...options
+    });
+};
+export const listControllerUpdateOne = (options) => {
+    return (options.client ?? _heyApiClient).patch({
+        url: '/lists/{listId}',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+export const itemControllerDeleteMany = (options) => {
+    return (options.client ?? _heyApiClient).delete({
+        url: '/items',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+export const itemControllerFindAll = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/items',
+        ...options
+    });
+};
+export const itemControllerCreateMany = (options) => {
+    return (options.client ?? _heyApiClient).post({
+        url: '/items',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+export const itemControllerDeleteOne = (options) => {
+    return (options.client ?? _heyApiClient).delete({
+        url: '/items/{itemId}',
+        ...options
+    });
+};
+export const itemControllerUpdateOne = (options) => {
+    return (options.client ?? _heyApiClient).patch({
+        url: '/items/{itemId}',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};

package/dist/client/types.gen.d.ts

@@ -0,0 +1,440 @@
+export type List = {
+    /**
+     * The ID of the list
+     */
+    id: string;
+    /**
+     * The name of the list
+     */
+    name: string;
+    /**
+     * Whether the list is readonly
+     */
+    readonly: boolean;
+    /**
+     * The date and time the list was created
+     */
+    createdAt: string;
+    /**
+     * The date and time the list was updated
+     */
+    updatedAt: string;
+};
+export type PageInfoDto = {
+    /**
+     * The cursor for the next page
+     */
+    next: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The cursor for the previous page
+     */
+    previous: {
+        [key: string]: unknown;
+    } | null;
+};
+export type PaginatedResponseDto = {
+    pageInfo: PageInfoDto;
+};
+export type ResponseDto = {
+    [key: string]: unknown;
+};
+export type CreateListDto = {
+    /**
+     * The name of the list
+     */
+    name: string;
+};
+export type UpdateListDto = {
+    /**
+     * The name of the list
+     */
+    name: string;
+};
+export type Item = {
+    /**
+     * The ID of the item
+     */
+    id: string;
+    /**
+     * The Shopify ID of the product
+     */
+    productId: number;
+    /**
+     * The Shopify ID of the variant
+     */
+    variantId: {
+        [key: string]: unknown;
+    };
+    /**
+     * The quantity of the item in the list
+     */
+    quantity: number;
+    /**
+     * The date and time the item was created
+     */
+    createdAt: string;
+    /**
+     * The date and time the item was updated
+     */
+    updatedAt: string;
+};
+export type NewItemDto = {
+    /**
+     * The Shopify ID of the product
+     */
+    productId: number;
+    /**
+     * The Shopify ID of the variant
+     */
+    variantId: number;
+    /**
+     * The quantity of the item
+     */
+    quantity: number;
+};
+export type CreateItemsDto = {
+    items: Array<NewItemDto>;
+};
+export type ItemDto = {
+    /**
+     * The ID of the item
+     */
+    id: string;
+};
+export type DeleteItemsDto = {
+    items: Array<ItemDto>;
+};
+export type UpdateItemDto = {
+    /**
+     * The Shopify ID of the product
+     */
+    productId: number;
+    /**
+     * The Shopify ID of the variant
+     */
+    variantId: number;
+};
+export type ListControllerFindAllData = {
+    body?: never;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path?: never;
+    query?: {
+        /**
+         * The pagination cursor
+         */
+        cursor?: string;
+    };
+    url: '/lists';
+};
+export type ListControllerFindAllResponses = {
+    /**
+     * Returns all lists as paginated response
+     */
+    200: PaginatedResponseDto & {
+        data?: Array<List>;
+    };
+};
+export type ListControllerFindAllResponse = ListControllerFindAllResponses[keyof ListControllerFindAllResponses];
+export type ListControllerCreateOneData = {
+    body: CreateListDto;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/lists';
+};
+export type ListControllerCreateOneResponses = {
+    /**
+     * The list has been successfully created.
+     */
+    201: ResponseDto & {
+        data?: List;
+    };
+};
+export type ListControllerCreateOneResponse = ListControllerCreateOneResponses[keyof ListControllerCreateOneResponses];
+export type ListControllerDeleteOneData = {
+    body?: never;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path: {
+        /**
+         * The ID of the list
+         */
+        listId: string;
+    };
+    query?: never;
+    url: '/lists/{listId}';
+};
+export type ListControllerDeleteOneResponses = {
+    /**
+     * The list has been successfully deleted.
+     */
+    204: void;
+};
+export type ListControllerDeleteOneResponse = ListControllerDeleteOneResponses[keyof ListControllerDeleteOneResponses];
+export type ListControllerFindOneData = {
+    body?: never;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path: {
+        /**
+         * The ID of the list
+         */
+        listId: string;
+    };
+    query?: never;
+    url: '/lists/{listId}';
+};
+export type ListControllerFindOneResponses = {
+    /**
+     * The list has been successfully retrieved.
+     */
+    200: ResponseDto & {
+        data?: List;
+    };
+};
+export type ListControllerFindOneResponse = ListControllerFindOneResponses[keyof ListControllerFindOneResponses];
+export type ListControllerUpdateOneData = {
+    body: UpdateListDto;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path: {
+        /**
+         * The ID of the list
+         */
+        listId: string;
+    };
+    query?: never;
+    url: '/lists/{listId}';
+};
+export type ListControllerUpdateOneResponses = {
+    /**
+     * The list has been successfully updated.
+     */
+    200: ResponseDto & {
+        data?: List;
+    };
+};
+export type ListControllerUpdateOneResponse = ListControllerUpdateOneResponses[keyof ListControllerUpdateOneResponses];
+export type ItemControllerDeleteManyData = {
+    body: DeleteItemsDto;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/items';
+};
+export type ItemControllerDeleteManyResponses = {
+    /**
+     * The items have been successfully deleted.
+     */
+    204: void;
+};
+export type ItemControllerDeleteManyResponse = ItemControllerDeleteManyResponses[keyof ItemControllerDeleteManyResponses];
+export type ItemControllerFindAllData = {
+    body?: never;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path?: never;
+    query?: {
+        /**
+         * The pagination cursor
+         */
+        cursor?: string;
+    };
+    url: '/items';
+};
+export type ItemControllerFindAllResponses = {
+    /**
+     * Returns all items as paginated response
+     */
+    200: PaginatedResponseDto & {
+        data?: Array<Item>;
+    };
+};
+export type ItemControllerFindAllResponse = ItemControllerFindAllResponses[keyof ItemControllerFindAllResponses];
+export type ItemControllerCreateManyData = {
+    body: CreateItemsDto;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/items';
+};
+export type ItemControllerCreateManyResponses = {
+    /**
+     * The items have been successfully created.
+     */
+    201: ResponseDto & {
+        data?: Array<Item>;
+    };
+};
+export type ItemControllerCreateManyResponse = ItemControllerCreateManyResponses[keyof ItemControllerCreateManyResponses];
+export type ItemControllerDeleteOneData = {
+    body?: never;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path: {
+        /**
+         * The ID of the item
+         */
+        itemId: string;
+    };
+    query?: never;
+    url: '/items/{itemId}';
+};
+export type ItemControllerDeleteOneResponses = {
+    /**
+     * The item has been successfully deleted.
+     */
+    204: void;
+};
+export type ItemControllerDeleteOneResponse = ItemControllerDeleteOneResponses[keyof ItemControllerDeleteOneResponses];
+export type ItemControllerUpdateOneData = {
+    body: UpdateItemDto;
+    headers: {
+        /**
+         * Your Swish API key
+         */
+        Authorization: string;
+        /**
+         * The shop domain
+         */
+        Shop: string;
+        /**
+         * The profile key
+         */
+        Key: string;
+    };
+    path: {
+        /**
+         * The ID of the item
+         */
+        itemId: string;
+    };
+    query?: never;
+    url: '/items/{itemId}';
+};
+export type ItemControllerUpdateOneResponses = {
+    /**
+     * The item has been successfully updated.
+     */
+    200: ResponseDto & {
+        data?: Item;
+    };
+};
+export type ItemControllerUpdateOneResponse = ItemControllerUpdateOneResponses[keyof ItemControllerUpdateOneResponses];
+export type ClientOptions = {
+    baseUrl: 'https://swish.app/api/unstable' | (string & {});
+};

package/dist/client/types.gen.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export {};

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { CreateItemsDto, CreateListDto, DeleteItemsDto, UpdateItemDto, UpdateListDto } from "./client/types.gen";
+export interface SwishClientOptions {
+    authToken: string;
+    shop: string;
+    key: string;
+}
+type CursorQuery = {
+    cursor?: string;
+};
+export declare class SwishClient {
+    private readonly authToken;
+    private readonly shop;
+    private readonly key;
+    constructor(options: SwishClientOptions);
+    readonly items: {
+        list: (query?: CursorQuery) => Promise<(import("./client").PaginatedResponseDto & {
+            data?: Array<import("./client").Item>;
+        }) | undefined>;
+        create: (items: CreateItemsDto["items"]) => Promise<(import("./client").ResponseDto & {
+            data?: Array<import("./client").Item>;
+        }) | undefined>;
+        delete: (items: DeleteItemsDto["items"]) => Promise<void | undefined>;
+        deleteById: (itemId: string) => Promise<void | undefined>;
+        updateById: (itemId: string, body: UpdateItemDto) => Promise<(import("./client").ResponseDto & {
+            data?: import("./client").Item;
+        }) | undefined>;
+    };
+    readonly lists: {
+        list: (query?: CursorQuery) => Promise<(import("./client").PaginatedResponseDto & {
+            data?: Array<import("./client").List>;
+        }) | undefined>;
+        getById: (listId: string) => Promise<(import("./client").ResponseDto & {
+            data?: import("./client").List;
+        }) | undefined>;
+        create: (list: CreateListDto) => Promise<(import("./client").ResponseDto & {
+            data?: import("./client").List;
+        }) | undefined>;
+        deleteById: (listId: string) => Promise<void | undefined>;
+        updateById: (listId: string, body: UpdateListDto) => Promise<(import("./client").ResponseDto & {
+            data?: import("./client").List;
+        }) | undefined>;
+    };
+    private readonly addHeaders;
+    private readonly handleRequest;
+}
+export {};

package/dist/index.js

@@ -0,0 +1,42 @@
+import { itemControllerFindAll, itemControllerCreateMany, itemControllerDeleteMany, itemControllerDeleteOne, itemControllerUpdateOne, listControllerFindAll, listControllerCreateOne, listControllerDeleteOne, listControllerFindOne, listControllerUpdateOne, } from "./client/sdk.gen";
+export class SwishClient {
+    constructor(options) {
+        this.items = {
+            list: (query) => this.handleRequest(itemControllerFindAll(this.addHeaders({ query }))),
+            create: (items) => this.handleRequest(itemControllerCreateMany(this.addHeaders({ body: { items } }))),
+            delete: (items) => this.handleRequest(itemControllerDeleteMany(this.addHeaders({ body: { items } }))),
+            deleteById: (itemId) => this.handleRequest(itemControllerDeleteOne(this.addHeaders({ path: { itemId } }))),
+            updateById: (itemId, body) => this.handleRequest(itemControllerUpdateOne(this.addHeaders({
+                body,
+                path: { itemId },
+            }))),
+        };
+        this.lists = {
+            list: (query) => this.handleRequest(listControllerFindAll(this.addHeaders({ query }))),
+            getById: (listId) => this.handleRequest(listControllerFindOne(this.addHeaders({ path: { listId } }))),
+            create: (list) => this.handleRequest(listControllerCreateOne(this.addHeaders({ body: list }))),
+            deleteById: (listId) => this.handleRequest(listControllerDeleteOne(this.addHeaders({ path: { listId } }))),
+            updateById: (listId, body) => this.handleRequest(listControllerUpdateOne(this.addHeaders({ body, path: { listId } }))),
+        };
+        this.addHeaders = (options) => ({
+            headers: {
+                Authorization: this.authToken,
+                Shop: this.shop,
+                Key: this.key,
+            },
+            ...options,
+        });
+        this.handleRequest = async (request) => {
+            const { data, error } = await request;
+            if (error) {
+                // TODO: Add unified error responses
+                // TODO: Add { cause: error }
+                throw new Error("Failed to execute API request");
+            }
+            return data;
+        };
+        this.authToken = options.authToken;
+        this.shop = options.shop;
+        this.key = options.key;
+    }
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@swishapp/api-client",
+  "version": "0.1.0",
+  "description": "API client for the Swish API",
+  "website": "https://swish.app",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "generate": "openapi-ts",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "build": "rimraf dist && tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint src --ext .ts",
+    "clean": "rimraf dist"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@hey-api/client-fetch": "0.8.3",
+    "@hey-api/openapi-ts": "0.64.10",
+    "@types/jest": "29.5.14",
+    "jest": "29.7.0",
+    "ts-jest": "29.1.1",
+    "rimraf": "5.0.1"
+  }
+}